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>"
  }
}'
{
  "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
​
busca
object

Response

200
text/plain
OK
​
msg
string | null
​
hasError
boolean
​
messages
object[] | null
​
codigo
string | null
​
tipoDocumento
integer
​
nomeArquivo
string | null
​
extensao
string | null
​
dtValidade
string | null
​
arquivo
string | null

Was this page helpful?