5 - Onboarding Status Consultation

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

Show Messages - Onboarding Status Consultation

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

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

application/jsontext/jsonapplication/*+json

dto · object

Show child attributes

Response

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

onBoarding · object

Show child attributes