13 - Consultar Pessoa

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Pessoa/ConsultarPessoa \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "filter": {
    "tipoRegistro": 1,
    "documentoCliente": "<string>",
    "childDirectID": "<string>",
    "childSearch": "<string>"
  }
}
'

200

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "json": "<string>"
}

Por meio deste endpoint o parceiro realiza a consulta dos dados cadastrados em sistema.

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

filter · object

Mostrar atributos filhos

filter. tipoRegistro · enum<integer> · required

Opções disponíveis: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 14, 15, 16, 100, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 300, 301, 302

filter. documentoCliente · string | null · required

Documento federal do cliente

Maximum string length: 20

filter. childDirectID · string | null

filter. childSearch · string | null

Response

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Mostrar atributos filhos

messages. messageType · enum<integer>

Opções disponíveis: 1, 2, 3

messages. code · string | null

messages. context · string | null

messages. description · string | null

messages. field · string | null

json · string | null