This use case is exclusive for the use of partners with [Partner Name].

Direct Consumer Credit (CDC) is a type of personal loan aimed at end consumers who wish to take out credit. Through this use case, [Partner Name] offers its customers the possibility of contracting a CDC directly on its platform, using BMP’s APIs for credit simulation, proposal, and formalization in a fast and secure manner.

Below, is the step by step for using the use case:

Before using this service, you need to configure authentication. Please refer to the authentication instructions for detailed guidance.

​
0 - Pre approved credit - BMP Credit Desision Engine (Optional)

In our process refers to the optional use of the BMP Credit Desision Engine to perform a preliminary credit analysis of your customer. This step is designed to provide an automated pre-assessment based on predefined criteria, helping support decision-making before moving forward with the full process.

You can choose to use our Credit Desision Engine for a fast and efficient evaluation, or, if you prefer, integrate your own Credit Desision Engine into the workflow. The choice depends on your business needs and strategy.

Important: Even if you choose not to use the BMP Credit Desision Engine, you can still contract and integrate BMP’s bureau services for data consultation and customer profiling.

​
1 - KYC - Know Your Customer (Optional)

In this step, you can use BMP’s facial biometrics to capture information from the customer who is applying for credit, through the following endpoint:

/Bureau/GeraLinkCAFOnboarding

curl --location 'https://api.bmpdigital.moneyp.dev.br/Bureau/GeraLinkCAFOnboarding' \
--header 'IdempotencyKey: Unique-GUID-per-call' \
--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \
--header 'Content-Type: application/json' \
--data-raw '{
  "dto": {
    "WebhookId": "<string>",
    "IdLayout": "<string>",
    "NaoExpira": "<boolean>",
    "Atributos": {
      "Cpf": "<string>",
      "Cnpj": "<string>"
    },
    "Tipo": "<string>"
  }
}'

The response from this endpoint will be a link containing our capture experience, which includes both the customer’s facial biometrics and document collection, in a simple and secure way.

​
2 - Onboarding

Customer and address registration flows:

In this step it will be necessary to choose a single registration flow

​
3 - Consult balance

To check the customer’s available balance, you must call the following endpoint:

curl --location 'https://api.bmpdigital.moneyp.dev.br/SolicitacaoAnalise/ConsultarSaldo' \
--header 'accept: text/plain' \
--header 'IdempotencyKey: db9291d5-fc5e-49bc-98f0-fc395de5a162' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer oChaB2F1txsGyp5XGLQfU6epSExihFhUm44Qq9VYGRo' \
--data '{
    "dto": {
        "documentoCliente": "02350374432"
    }
}'

​
4 - Simulations

Learn about our types of simulations below:

​
5 - 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/IncluirManualSimplificadoPrice' \
--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.
        "nroDiasAcrescimo": 0, // Required - Number of days of interest
        "percJurosNegociado": 0, // Required - Proposal's negotiated interest rate
        "fluxoIrregular": true, // Required - Indicates if the proposal is irregular
        "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.
        "vlrOutrasDespesas": 10000000000000000, //Optional - Other expenses value
        "vlrOutrosServicos": 10000000000000000, //Optional
        "vlrSeguro": 10000000000000000, // Optional
        "vlrEntrada": 10000000000000000, //Optional
        "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
        },
    },
}'

​
6 - Signature Collection

​
7 - Disbursement of the operation

1

Disbursement of the operation

At this stage, it is necessary to release the proposal through the integration with our Proposal Release for Payment API to validate the contract model after signing.

curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/Liberar' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH REQUEST' \
--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": [
        {}
    ]
}'

​
8 - Auxiliary APIs

Callback Technical Procedure will be used in this journey for signature confirmation and payment confirmation.

Consult Contract will be used in this journey to consult the proposal data.

Contract Cancellation will be used in this journey for contract cancellation.

​
Use Case Model – Embedded Journey

Below is a sample of an embedded journey in which BMP will be responsible for the end-to-end delivery of the solution, including the development of the frontend, backend, and API-driven service integrations.

This journey ensures full alignment between the wireframed flows and the final user experience, whether in native mobile applications (iOS/Android) or in a responsive web environment.

To support this, we’ve included a sample video showcasing the navigation experience and key user interaction points, with emphasis on the integration touchpoints handled by BMP systems:

​
Next Steps – Key Questions for Alignment

The current material only covers a single BMP service journey, where [Partner Name] is responsible for developing the embedded front-end solution for our credit services.

  1. Can we confirm whether the embedded service will include both front-end and back-end components?

  2. Will there be a financial disbursement related to this operation (i.e., a monetary transaction to an [Partner Name] or partner store account)?

  3. Who will be responsible for executing the disbursement — [Partner Name] or BMP?

I did not identify any post-contractual flows in the current journey. Is it planned to include functionalities such as:

  • Payment anticipation
  • Contract settlement
  • Generation of payment slips (boletos) for upcoming installments?

  1. Will there be any mechanism to revise or adjust the credit limits already configured?

  2. Regarding contract signing: – Will it be executed via a power-of-attorney clause (i.e., [Partner Name] signing on behalf of the end customer)? – Or will the contract be considered valid through SMS validation sent to the registered phone number?