Consulta do status da análise

Este endpoint possibilita consultar o status da análise dos documentos enviados pelo endpoint Envio de documentos pessoais.

A consulta de status é um passo imprescindível antes de iniciar a etapa de registro do cliente e antes do envio de cada imagem, pois, por meio do resultado, o parceiro poderá verificar se é necessário solicitar uma nova foto ao cliente.

❗️

Atenção

O parceiro deverá consultar o resultado da análise da imagem enviada previamente antes do envio da próxima imagem. Se as imagens não estiverem aprovadas, não será possível prosseguir com o cadastro. Consulte as recomendações contidas na página Orientações para envio de fotos.

A consulta pode ser realizada informando apenas o documento do cliente ou o documento e a lista de tokens correspondentes às análises solicitadas.

Requisição (Request)

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/document-analysis/{documentNumber}?resultLevel={resultLevel}&token={analysisToken}

--request GET 
--url 'https://api-mtls.sandbox.bankly.com.br/document-analysis/{documentNumber}?resultLevel={resultLevel}&token={analysisToken}' \ 
--header 'api-version: 1' \ 
--header 'Authorization: Bearer {{accessToken}}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

🚧

Importante

Recomendamos que o parceiro implemente o header cache-control em sua aplicação, para definir o intervalo de tempo de pooling, visando a um melhor desempenho entre cliente e servidor. O tempo sugerido é de 300 segundos (max-age=300). De todos os modos, reforçamos que o pooling deve ser evitado e recomendamos que a configuração de webhooks seja priorizada para a obtenção de informações.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará sucesso na consulta.

Para a análise de selfie, o retorno irá trazer os seguintes campos em formato JSON:

Para as análises de documento (frente e verso), o retorno trará os seguintes campos:

Status da análise da imagem

🚧

Importante

Uma análise de documento é concluída quando todo o pipeline é executado, resultando no status ANALYSIS_COMPLETED.

[
  { 
    "token": "string", 
    "`documentType`": "SELFIE", 
    "`documentSide`": "FRONT", 
    "status": "ANALYSIS_COMPLETED", 
    "liveness": { 
      "status": "LIVENESS_FOUND"
      }, 
    "faceDetails": { 
      "status": "DETECTED_FACE", 
      "confidence": 99.99689, 
      "ageRange": { 
        "low": 18, 
        "high": 23 
      }, 
      "gender": { 
        "value": "Male", 
        "confidence": 99.21723 
      }, 
      "sunglasses": { 
        "value": false, 
        "confidence": 99.40401 
      }, 
      "eyesOpen": { 
        "value": false, 
        "confidence": 57.259457 
      }, 
      "emotions": [ 
        { 
          "value": "CALM", 
          "confidence": 95.32976 
        }, 
        { 
          "value": "SAD", 
          "confidence": 2.078439 
        }, 
        { 
          "value": "CONFUSED", 
          "confidence": 0.9475501 
        }, 
        { 
          "value": "ANGRY", 
          "confidence": 0.6159508 
        }, 
        { 
          "value": "SURPRISED", 
          "confidence": 0.37119603 
        }, 
        {
          "value": "FEAR", 
          "confidence": 0.24299896 
        }, 
        { 
          "value": "HAPPY", 
          "confidence": 0.20983662 
        }, 
        { 
          "value": "DISGUSTED", 
          "confidence": 0.20425977 
        } 
      ] 
    }, 
    "analyzedAt": "2021-08-31T21:20:58.754Z" 
  }
]

[
  { 
    "token": "string", 
    "documentType": "RG", 
    "documentSide": "FRONT", 
    "status": "ANALYSIS_COMPLETED", 
    "faceMatch": { 
      "status": "HAS_FACE_MATCH", 
      "similarity": 99.98459, 
      "confidence": 99.99835 
    }, 
    "documentDetails": { 
      "status": "DETECTED_DOCUMENT", 
      "identified`documentType`": "RG", 
      "idNumber": "48151623", 
      "cpfNumber": "47742663023", 
      "birthDate": "1810-10-12", 
      "fatherName": "", 
      "motherName": "Dionísia Gonçalves Pinto", 
      "registerName": "Nísia Floresta", 
      "validDate": "2030-01-30", 
      "driveLicenseCategory": "string", 
      "driveLicenseNumber": "string", 
      "driveLicenseFirstQualifyingDate": "string", 
      "federativeUnit": "SP", 
      "issuedBy": "SSP", 
      "issuePlace": "SP", 
      "issueDate": "1820-10-12" 
    }, 
    "analyzedAt": "2021-08-31T21:20:58.754Z" 
  }
]

[
  { 
    "token": "string", 
    "documentType": "RG", 
    "documentSide": "BACK", 
    "status": "ANALYSIS_COMPLETED", 
    "documentDetails": { 
      "status": "DETECTED_DOCUMENT", 
      "identified`documentType`": "RG", 
      "idNumber": "48151623", 
      "cpfNumber": "47742663023", 
      "birthDate": "1810-10-12", 
      "fatherName": "", 
      "motherName": "Dionísia Gonçalves Pinto", 
      "registerName": "Nísia Floresta", 
      "validDate": "2030-01-30", 
      "driveLicenseCategory": "string", 
      "driveLicenseNumber": "string", 
      "driveLicenseFirstQualifyingDate": "string", 
      "federativeUnit": "SP", 
      "issuedBy": "SSP", 
      "issuePlace": "SP", 
      "issueDate": "1820-10-12" 
    }, 
    "analyzedAt": "2021-08-31T21:20:58.754Z" 
  }
]

[
    {
        "token": "wGW_jgBuoZNMxqBYwzFIPZGT0jbgRzJL",
        "documentType": "SELFIE",
        "documentSide": "FRONT",
        "status": "ANALYZING"
    },
    {
        "token": "pRW_jgBuoZNMxqFGwzFIPZGT0jbgRzKL",
        "documentType": "RG",
        "documentSide": "FRONT",
        "status": "ANALYZING"
    }
]

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.

Como as análises ocorrem

Análise da selfie

A análise de selfie primariamente identifica se há uma prova de vida na imagem. Posteriormente, essa imagem será utilizada como imagem base (source) ao ser comparada com a foto existente na frente do documento (target), com o intuito de comprovar se o portador do documento é a mesma pessoa que solicitou a abertura de conta.

Análise de prova de vida (Liveness)

Tem como principal objetivo identificar se há prova de vida, ou seja, se há uma pessoa na imagem e se a imagem não é a foto de uma foto.

Status da análise de prova de vida

🚧

Importante

Lembre-se de seguir todas as recomendações contidas na página Orientações para envio de fotos.

Análise de características faciais (Face details)

Visa identificar as características do rosto da pessoa. Como objetivo secundário, ajuda a verificar se há mais de uma face na selfie, indicando que há mais de uma pessoa.

Status da análise de características faciais

📘

Nota

Uma selfie é considerada válida para o processo de Onboarding quando os status das análises de liveness e face details são LIVENESS_FOUND e DETECTED_FACE respectivamente.

Análise da frente do documento de identidade

Essa análise tem como principal objetivo identificar se o documento que está sendo enviado é válido e se ele pertence à pessoa que está presente na selfie.

Por isso, é imprescindível que a selfie seja enviada antes da foto da frente do documento.

🚧

Importante

Lembre-se de seguir todas as recomendações contidas na página Orientações para envio de fotos.

Análise de comparação facial (Face match)

Essa análise tem como objetivo identificar a correspondência entre a face do titular do documento (target) e a da selfie previamente analisada (source).

Status da análise de comparação facial

🚧

Importante

Lembre-se de seguir todas as recomendações contidas na página Orientações para envio de fotos.

Extração de textos (OCR)

Essa análise tem como objetivo extrair os textos do documento e determinar se o tipo de documento enviado é o mesmo informado pelo cliente.

Status da extração de textos (OCR)

📘

Nota

Uma foto da frente do documento é considerada válida para o processo de Onboarding quando os status das análises de face match e OCR são HAS_FACE_MATCH e DETECTED_DOCUMENT, respectivamente.

Análise do verso do documento de identidade

Esse tipo de análise complementa a análise da frente do documento.

Não há uma ordem de envio das fotos de frente e verso. O importante é que a selfie seja enviada antes das duas imagens do documento e que todas essas imagens sejam enviadas antes do pedido de abertura da conta.

🚧

Importante

Lembre-se de seguir todas as recomendações contidas na página Orientações para envio de fotos.

Extração de textos (OCR)

Essa análise tem como objetivo extrair os textos do documento e determinar se o tipo de documento enviado é o mesmo informado pelo cliente.

📘

Nota

Uma foto do verso do documento é considerada válida para o processo de Onboarding quando os status da análise OCR é DETECTED_DOCUMENT.