Onboarding
14 - Consultar Situação Onboarding
Guia Inicial
- Sobre o Credit as a Service
- Operações de crédito
Métodos de Assinaturas
Guia do Desenvolvedor
- Guia de Integração Via API
APIs Reference
- Análises de Crédito
- Simulações
- Onboarding
- POST10 - Cadastro do cliente
- POST11 - Cadastro do endereço
- POST12 - Consultar Documento
- POST13 - Consultar Pessoa
- POST14 - Consultar Situação Onboarding
- POST15 - Incluir Documento
- POST16 - Incluir pessoa Onboarding
- POST17 - Salvar Endereços
- POST18 - Salvar Sócio
- POST19 - Salvar Sócios
- POST20 - Incluir Avalista
- POST21 - Incluir Avalistas
- POST
- Contratação
- Garantias
- Impressão de Documentos
- Assinaturas
- Desembolso
Casos de Uso
- Capital de Giro com/sem Garantia
- Capital de Giro com/sem Garantia (Cessão BTG)
- Crédito Direto ao Consumidor (CDC)
- Empréstimo Pessoal
- Home Equity
- Consignado Público e Privado
- Financiamento de Veículos
Onboarding
14 - Consultar Situação Onboarding
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"
}
}
Por meio deste endpoint o parceiro realiza a consulta do status em que se encontra o processo de onboarding.
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
Esta página foi útil?
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"
}
}