14 - Consultar Situação Onboarding

cURL

cURL

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 '{}'

200

{
  "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.

​

Mensagens de erro

A tabela abaixo representa as mensagens de erro que podem ser retornadas ao tentar realizar uma requisição.

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

No exemplo de retorno ao lado, o campo code representa a coluna Código desta tabela; o campo context representa a coluna Código Detalhado; e o campo message representa a coluna Mensagem.

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

Autorizações

Authorization · string · header · obrigatório

Informe o token

Cabeçalhos

IdempotencyKey · string · obrigatório

Corpo

application/jsontext/jsonapplication/*+json

dto · object

Show child attributes

Resposta

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

onBoarding · object

Show child attributes