45 - Consultar Dados

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "consulta": {
    "codigoId": "<string>"
  }
}
'

200

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

Em caso de perda do evento de webhook, é possível consultar os dados de uma análise específica.

Para executar a consulta é necessário o token gerado quando o link é criado pelo Onboarding ou pelo FaceAuthenticator. Sem esse token a consulta não pode ser realizada.

O retorno inclui os links das imagens enviadas pelo cliente selfie, frente e verso do documento cujo prazo de validade é de 1 hora; após esse período os links expiram.

Mostrar 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":.

{
    "Tecnologia": 0,
    "Data": {
        "RequestId": "String",
        "Id": "String",
        "Status": "String",
        "CustomStatus": "String",
        "Type": "String",
        "CreatedAt": "Date",
        "Sections": {
            "Ocr": {
                "Name": "String",
                "FirstDriverLicenseDate": "String",
                "BirthDate": "String",
                "BirthPlace": "String",
                "IssueDate": "String",
                "ExpirationDate": "String",
                "Acc": "String",
                "Rg": "String",
                "RgIssuingAuthority": "String",
                "RgIssueState": "String",
                "Cpf": "String",
                "RegistrationNumber": "String",
                "Category": "String",
                "Nationality": "String",
                "FatherName": "String",
                "MotherName": "String",
                "MirrorNumber": "String",
                "Notes": "String",
                "PlaceOfIssue": "String",
                "SecurityNumber": "String",
                "RenachNumber": "String"
            },
            "Cpf": {
                "StatusCode": "String",
                "RegistrationStatusCode": "String",
                "RegistrationStatusMessage": "String",
                "Name": "String",
                "BirthDate": "String",
                "IssueDate": "String",
                "DeathYear": "String",
                "DeathMessage": "String"
            },
            "Facematch": {
                "StatusCode": "String",
                "Confidence": Numero,
                "Identical": "String"
            },
            "OfficialData": {
                "Code": "String",
                "Confidence": Numero,
                "Probability": "String"
            }
        },
        "StatusReasons": [
            {
                "Category": "String",
                "Description": "String",
                "ResultStatus": "String",
                "ResultCustomStatus": "String",
                "Code": "String",
                "Status": "String",
                "ManualReprovalReasons": "String"
            }

        ],
        "Images": {
            "Back": "String",
            "Front": "String",
            "Selfie": "String",
            "SelectedFront": "String",
            "SelectedBack": "String"
        },
        "Attributes": {
            "Name": "String",
            "Cpf": "String",
            "BirthDate": "String",
            "AcceptedTermsData": [
                {
                    "Name": "String",
                    "Datetime": "Date",
                    "UserIp": "String",
                    "UserAgent": "String"
                }
            ]
        },
        "AcceptedTermsData": "String",
        "Address": "String",
        "Relationships": "String",
        "RelatedTransactions": "String",
        "Files": "String"
    }
}

Autorizações

Authorization · string · header · obrigatório

Informe o token

Cabeçalhos

IdempotencyKey · string · obrigatório

Corpo

application/jsontext/jsonapplication/*+json

consulta · object

Show child attributes

Resposta

200

text/plain

Success

msg · string | null

messages · object[] | null

Show child attributes

hasError · boolean

falha · boolean

json · string | null