3 - Document Consultation

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

200

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

Through this endpoint, the system transmits a request to the URL defined by the partner and then obtains a response containing the document to be attached to the Person API.

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

dto · object

Show child attributes

dto. documentoCliente · string | null · required

Documento federal do cliente

Maximum string length: 20

busca · object

Show child attributes

busca. authHeaderName · string | null

Parâmetro para autenticação na URL do parceiro

busca. authHeaderValue · string | null

Valor do parâmetro para autenticação na URL do parceiro

busca. method · string | null

GET/POST/PUT

busca. contentType · string | null

Indica o formato desejado pela URL, Exemplo: text/plain, application/json

busca. url · string | null

Url definida pelo parceiro que deverá devolver como resposta o DTO

busca. body · string | null

Corpo da mensagem que a URL deve receber. Exemplo: Parâmetros para que localize o documento na base do parceiro.

Response

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

messages. messageType · enum<integer>

Available options: 1, 2, 3

messages. code · string | null

messages. context · string | null

messages. description · string | null

messages. field · string | null

codigo · string<uuid> | null

tipoDocumento · integer<int32>

nomeArquivo · string | null

extensao · string | null

dtValidade · string<date-time> | null

arquivo · string<byte> | null