46 - Consultar Status

cURL

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

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

cURL

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

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

Se o evento de webhook for perdido, também é possível consultar apenas o status de uma análise específica. Para isso é preciso o token retornado na geração do link pelo Onboarding ou pelo FaceAuthenticator; sem ele a consulta não é permitida. O retorno contém apenas os campos relativos à validação (resultado e atributos de verificação), sem incluir a selfie nem as imagens do documento

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": Numero,
    "Data": {
        "Report": "String",
        "Uuid": "String",
        "StatusReasons": [
            {
                "Category": "String",
                "Description": "String",
                "ResultStatus": "String",
                "ResultCustomStatus": "String",
                "Code": "String",
                "Status": "String",
                "ManualReprovalReasons": "String"
            }
        ],
        "TemplateId": "String",
        "OnboardingId": "String",
        "Type": "String",
        "Date": "Date"
    }
}

Autorizações

Authorization

string

header

obrigatório

Informe o token

Cabeçalhos

IdempotencyKey

string

obrigatório

Corpo

consulta

object

Show child attributes

Resposta

Success

msg

string | null

messages

object[] | null

Show child attributes

hasError

boolean

falha

boolean

json

string | null

45 - Consultar Dados

Documentation Index

Autorizações

Cabeçalhos

Corpo

Resposta