22 - Consulta Básica Síncrona

Este endpoint permite consultar de forma básica, os dados cadastrais de uma pessoa física no formato de resposta rápida (Síncrono). A resposta é retornada em ‘String JSON’ serializado e inclui as seguintes informações: nome, idade, nome da mãe, número do documento, informação da Receita e indicação de óbito.

Show Exemplo de retorno completo

O exemplo de retorno, mostrado no lado direito desta tela, está resumido. Na linha "json": "<string>" o retorno do Bureau vem de forma serializada, sendo necessário deserializar para melhor visualização. Aqui está um exemplo do retorno deserializado que vem no campo "json":.

{
    "Erro": true,
    "MensagemOperador": "String",
    "ResultadoConsulta": {
        "Name": "String",
        "Age": 66,
        "MotherName": "String",
        "TaxIdNumber": "String",
        "TaxIdOrigin": "String",
        "TaxIdStatus": "String",
        "TaxIdFiscalRegion": "String",
        "HasObitIndication": "Boolean",
        "Identificador": "String",
        "StatusConsulta": {
            "Code": 66,
            "Message": "String"
        },
        "identificador": "String"
    }
}

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

consulta · object

Show child attributes

Response

200

text/plain

Success

msg · string | null

messages · object[] | null

Show child attributes

hasError · boolean

falha · boolean

json · string | null