Personal loans are an accessible and flexible financial solution designed to meet various needs of individuals without requiring justification for the use of credit. To minimize the risk of default, different types of guarantees can be offered, providing security for both the borrower and the financial institution. Among the available options are guarantees such as investments, card receivables, service contracts, company shares/stocks, vehicles, and real estate. This case study explores the various forms of personal loans, illustrating how each type can be used to meet different financial profiles and needs. Below is the step-by-step guide to using this case:
Before using this service, authentication setup is required. Refer to the authentication instructions for detailed guidance.

​
1 - Simulations

Learn about our types of simulations below:

​
2 - Onboarding

1

Customer Registration

At this stage, it will be necessary to register the customer through integration with our API for Customer Registration
curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/Salvar' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dto": {
        "Codigo": "1", // Code to identify the customer in your system | OPTIONAL
        "Nome": "CLIENTE TESTE", // Your customer's name | REQUIRED
        "DocumentoFederal": "75000000000", // Federal document (CPF: 11 digits | CNPJ: 14 digits | we have a validator, so it needs to be a valid document) | REQUIRED
        "PF": { // If your customer is an individual, fill out this object; if not, delete this object
            "rg": "string", // Your customer's RG | REQUIRED
            "rgOrgao": "string", // RG issuing authority of your customer | OPTIONAL
            "rguf": "string", // RG state of your customer | OPTIONAL
            "rgData": "2023-07-10T20:01:07.689Z", // RG issuance date | OPTIONAL
            "dtNasc": "2023-07-10T20:01:07.689Z", // Your customer's date of birth | REQUIRED
            "sexo": "string", // Your customer's gender | OPTIONAL
            "nacionalidade": "string", // Your customer's nationality | OPTIONAL
            "naturalDeCidade": "string", // Your customer's birthplace city | OPTIONAL
            "naturalDeUF": "string", // Your customer's birthplace state | OPTIONAL
            "estadoCivil": 0, // Enum type, consult the document sent via email | OPTIONAL
            "escolaridade": 0 // Enum type, consult the document sent via email | OPTIONAL
        },
        "PJ": { // If your customer is a legal entity, fill out this object; if not, delete this object
            "nomeFantasia": "string", // Company's trade name | REQUIRED
            "documentoEstadual": "string", // Provide the company's state document || OPTIONAL
            "documentoMunicipal": "string", // Provide the company's municipal document || OPTIONAL
            "dtAberturaEmpresa": "2024-06-06T19:49:59.553Z", // Provide the opening date of the CNPJ in timestamp || OPTIONAL
            "nomeResponsavelEmpresa": "string", // Provide the name of the company's responsible person || OPTIONAL
            "cpfResponsavelEmpresa": "string", // Provide the CPF of the company's responsible person || OPTIONAL
            "rgResponsavelEmpresa": "string" // Provide the RG of the company's responsible person || OPTIONAL
        },
        "PessoaDadosContato": {
            "Email": "teste@email.com.br", // Your customer's email | REQUIRED
            "TelefoneCelular1": "11923456781" // Your customer's mobile number | REQUIRED
        }
    }
}'
2

Address Registration

At this stage, it will be necessary to register or update the address through integration with our API for Address Registration
curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEndereco' \
--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--header 'Content-Type: application/json' \
--data '{
  "dto": {
    "codigo": "string", // Code to identify the address in your system | OPTIONAL
    "cep": "string", // Address ZIP code | REQUIRED
    "logradouro": "string", // Address street | OPTIONAL
    "nroLogradouro": "string", // Address number | OPTIONAL
    "bairro": "string", // Address neighborhood | OPTIONAL
    "complemento": "string", // Address complement | OPTIONAL
    "cidade": "string", // Address city | OPTIONAL
    "uf": "string", // Address state | OPTIONAL
    "tipoEndereco": 0, // Address type | OPTIONAL
    "tipoResidencia": 0, // Address type of residence | OPTIONAL
    "enderecoDesde": "2024-04-04T12:19:46.116Z", // Date since the address belongs to the client | OPTIONAL
    "enderecoPrincipal": true, // Is it the client's primary address? | OPTIONAL
    "enderecoCorrespondencia": true // Is it the correspondence address? | OPTIONAL
  },
  "param": {
    "documentoCliente": "string" // Federal document (CPF: 11 digits | CNPJ: 14 digits | we have a validator, so it needs to be a valid document) | REQUIRED
  }
}
'

​
3 - Hiring

1

Proposal Submission

At this stage, it will be necessary to submit the proposal through integration with our API for Submit Proposal
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirManualSimplificado' \
--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--header 'Content-Type: application/json' \
--data '{
    "dto": {
        "documentoCliente": "string", // Customer's document
        "documentoParceiroCorrespondente": "string",  // Corresponding Partner's document
        "codigoOperacao": "string", // Required - Used by the integrator. It is the operation code in the partner's system. This information is unique and can be used to update the proposal without needing to store the proposal code in BMP. However, storing the BMP proposal code is important for printing bills/CCB/promissory notes or protocol.
        "codigoVersaoCCB": 0, // Credit Note version code (CCB)
        "vlrSolicitado": 0, // Required - Amount requested in the proposal
        "prazo": 0, // Required - Term requested. It will be validated as per the integration parameters.
        "percJurosNegociado": 0, // Required - Proposal's negotiated interest rate
        "vlrIOF": 0, // Required - Total amount of the Financial Transactions Tax (IOF)
        "percIOF": 0, // Required - Percentage of the Financial Transactions Tax (IOF)
        "vlrParcela": 0, // Required - Installment value
        "vlrTAC": 0, // Required - Registration Fee Value. It can be R$ 0.00 when not applicable.
        "dtPrimeiroVencto": "2024-02-21T17:48:40.110Z", // Required - Estimated first due date
        "tipoContrato": "string", // string(5) - Acronym indicating the type of proposal contract. Example: CSG -> Working Capital; CCG -> Working Capital with Guarantee
        "propostaContaPagamentoDTO": { 
            "tipoConta": 0, // Required - Account type
            "agencia": "string", // string(10) Required - Bank branch
            "agenciaDig": "string", // string(1) Required - Branch digit
            "conta": "string", // string(20) Required - Bank account
            "contaDig": "string", // string(1) Required - Account digit
            "numeroBanco": "string" // string(5) Required - Bank number
        },
    },
}'
To use a contract with TED split, add the following object to the previous request inside the dto array:To use a contract with BOLETO split, add the following object to the previous request inside the dto array:

​
4 - Signature Collection

To learn more about our signatures, their specifics, and which one to use in your project, please refer to our explanatory material on signatures.
With the signature type defined during the project scope planning with the commercial executive, select the option below that you will use to proceed with the use case:

​
5 - Proposal Release

1

Proposal Release

At this stage, it will be necessary to release the proposal through integration with our URL for Proposal Release for Payment to validate the model after signing.
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/Liberar' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--header 'Content-Type: application/json' \
--data '{
    "dto": { // Only one of the fields below should be provided
        "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Sequential number of the proposal 
        "codigoOperacao": "string" // string(50) Partner's Operation Code
    },
    "parametros": [
        {}
    ]
}'

​
6 - Auxiliary APIs

Bank Account Update will be used in this journey to update the payment account. Technical Callback Procedure will be used in this journey for signature confirmation and payment confirmation. Contract Inquiry will be used in this journey to query the proposal data. Payment Receipt Inquiry will be used in this journey to query the payment receipt of the proposal. Contract Cancellation will be used in this journey for contract cancellation.