Initial Guide
- About Credit as a Service
- Credit Operations
Developer's Guide
- API Integration Guide
APIs Reference
- Simulations
- Onboarding
- POST1 - Client Registration
- POST2 - Address Registration
- POST3 - Document Consultation
- POST4 - Person Consultation
- POST5 - Onboarding Status Consultation
- POST6 - Include Document
- POST7 - Include Person Onboarding
- POST8 - Save Addresses
- POST9 - Save Partner
- POST10 - Save Partners
- POST11 - Include Guarantor
- POST12 - Include Guarantors
- POST
- Hiring
- Guarantees
- Document Printing
- Signatures
- Disbursement
Use Cases
- Personal Loan
- CDC (Partner A)
Onboarding
3 - Document Consultation
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Pessoa/ConsultarDocumento \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"documentoCliente": "<string>"
},
"busca": {
"authHeaderName": "<string>",
"authHeaderValue": "<string>",
"method": "<string>",
"contentType": "<string>",
"url": "<string>",
"body": "<string>"
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tipoDocumento": 123,
"nomeArquivo": "<string>",
"extensao": "<string>",
"dtValidade": "2023-11-07T05:31:56Z",
"arquivo": "aSDinaTvuI8gbWludGxpZnk="
}
Through this endpoint, the system transmits a request to the URL defined by the partner and then obtains a response containing the document to be attached to the Person API.
Authorizations
Informe o token
Headers
Body
Response
200
text/plain
OK
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Pessoa/ConsultarDocumento \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"documentoCliente": "<string>"
},
"busca": {
"authHeaderName": "<string>",
"authHeaderValue": "<string>",
"method": "<string>",
"contentType": "<string>",
"url": "<string>",
"body": "<string>"
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tipoDocumento": 123,
"nomeArquivo": "<string>",
"extensao": "<string>",
"dtValidade": "2023-11-07T05:31:56Z",
"arquivo": "aSDinaTvuI8gbWludGxpZnk="
}
Assistant
Responses are generated using AI and may contain mistakes.