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
Onboarding
5 - Onboarding Status Consultation
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Pessoa/ConsultarSituacaoOnBoarding \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"documentoFederal": "<string>"
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"onBoarding": {
"nome": "<string>",
"documentoFederal": "<string>",
"situacaoCallback": "<string>",
"dtCallback": "2023-11-07T05:31:56Z"
}
}
Through this endpoint, the partner queries the status of the onboarding process.
Categoria | Operação | Ação | Código | Código Detalhado | Mensagem |
---|---|---|---|---|---|
Pessoa | ConsultaSituacaoOnBoarding | ConsultarSituacaoOnBoarding | C0043 | V0001 | Documento Inválido |
Pessoa | ConsultaSituacaoOnBoarding | ConsultarSituacaoOnBoarding | C0108 | V0001 | Documento Federal deve ser informado |
Pessoa | ConsultaSituacaoOnBoarding | ConsultarSituacaoOnBoarding | C0108 | V0002 | Cliente não encontrado com o documento |
Pessoa | ConsultaSituacaoOnBoarding | ConsultarSituacaoOnBoarding | C0108 | V0003 | Cliente não cadastrado pelo parceiro de integração |
Authorizations
Informe o token
Headers
Body
Response
200
text/plain
OK
Was this page helpful?
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Pessoa/ConsultarSituacaoOnBoarding \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"documentoFederal": "<string>"
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"onBoarding": {
"nome": "<string>",
"documentoFederal": "<string>",
"situacaoCallback": "<string>",
"dtCallback": "2023-11-07T05:31:56Z"
}
}