12 - Consultar Documento

cURL

cURL

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 '
{
  "busca": {
    "authHeaderName": "<string>",
    "authHeaderValue": "<string>",
    "method": "<string>",
    "contentType": "<string>",
    "url": "<string>",
    "body": "<string>"
  }
}
'

200

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "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="
}

Por meio deste endpoint o sistema transmite uma chamada na URL definida pelo parceiro e em seguida obtém um retorno onde constará o documento a ser anexado na API de Pessoa.

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

busca · object

Show child attributes

Resposta

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

codigo · string<uuid> | null

tipoDocumento · integer<int32>

nomeArquivo · string | null

extensao · string | null

dtValidade · string<date-time> | null

arquivo · string<byte> | null