---
title: "Consulta do status da análise"
method: GET
path: "/document-analysis/{documentNumber}"
tags: ["Análise de documentos"]
---

# Consulta do status da análise

`GET /document-analysis/{documentNumber}`

## Request

- Base URL: `https://api-mtls.sandbox.bankly.com.br`
- URL: `https://api-mtls.sandbox.bankly.com.br/document-analysis/{documentNumber}`
- Auth: HTTP bearer

<div class="bkly-ref-description">
  <p>Consulte o <i>status</i> da análise dos documentos enviados pelo <i>endpoint</i> <a href="https://docs.bankly.com.br/docs/envio-documentos-analise-id-one">envio de documentos pessoais para análise com o ID ONE</a>. Para obter mais de um resultado, informe os <i>tokens</i> correspondentes às análises solicitadas.</p>
  <span class="bkly-ref-small-stable-tag">stable</span> 
  <span class="bkly-ref-scope-tag">scope: kyc.document.read</span>
</div>
[block:callout]
{
  "type": "info",
  "title": "Nota",
  "body": "Para mais informações, confira a documentação [Consulta do <i>status</i> da análise](/docs/consulta-status-analise)."
}
[/block]

## Path parameters

- `documentNumber` string, required: Número do documento CPF do cliente do cliente pessoal ou representante legal.

## Query parameters

- `resultLevel` 'ONLY_STATUS' | 'DETAILED': Tipo de retorno da API, o qual pode ser ONLY_STATUS ou DETAILED.
- `token` string[], nullable: Lista de <i>tokens</i> de análise do documento.

## Parameters

- `#/paths/~1devices/put/parameters/1` (unresolved $ref)
- `#/paths/~1devices/put/parameters/0` (unresolved $ref)

## Response `200`

Recurso encontrado.

- DocumentAnalysisResponse
  - `token` string, nullable: <i>Token</i> da imagem.
  - `documentType` 'RG' | 'CNH' | 'RNE' | 'CRNM' | 'DNI' | 'SELFIE': Tipo do documento.
  - `documentSide` 'FRONT' | 'BACK': Lado do documento. Quando o tipo do documento for SELFIE, este parâmetro será desprezado.
  - `status` 'ANALYZING' | 'PARTIALLY_ANALYZED' | 'ANALYSIS_COMPLETED' | 'UNEXPECTED_ERROR': <i>Status</i> da análise da imagem.
  - `faceMatch` FaceMatch: Informações da Análise <i>Face Match</i>.
    - `status` 'HAS_FACE_MATCH' | 'UNMATCHED_DOCUMENT' | 'MANY_FACES_DETECTED': Resultado da análise <i>face match</i>.
    - `similarity` number, double, nullable: Nível de similaridade entre as faces comparadas.
    - `confidence` number, double: Nível de confiança da análise.
  - `faceDetails` FaceDetails: Informações da análise facial.
    - `status` 'DETECTED_FACE' | 'MANY_FACES_DETECTED' | 'COULD_NOT_DETECT_FACE': Resultado da análise facial.
    - `confidence` number, double: Nível de confiança da análise.
    - `ageRange` AgeRange: Faixa de idade identificada.
      - `low` integer, nullable: Idade mínima detectada.
      - `high` integer, nullable: Idade máxima detectada.
    - `gender` FacialDetail
      - `value` object, nullable: Tipo do detalhe facial identificado.
      - `confidence` number, double: Nível de confiança da análise.
    - `sunglasses` FacialDetail
      - `value` object, nullable: Tipo do detalhe facial identificado.
      - `confidence` number, double: Nível de confiança da análise.
    - `eyesOpen` FacialDetail
      - `value` object, nullable: Tipo do detalhe facial identificado.
      - `confidence` number, double: Nível de confiança da análise.
    - `emotions` FacialDetail[], nullable: Lista de expressões detectadas.
      - `value` object, nullable: Tipo do detalhe facial identificado.
      - `confidence` number, double: Nível de confiança da análise.
  - `documentDetails` DocumentDetails: IObjeto que contém informações extraídas documento analisado.
    - `status` 'DETECTED_DOCUMENT' | 'NO_DOCUMENT_FOUND' | 'NO_INFO_FOUND': Resultado da análise OCR.
    - `identifiedDocumentType` string, nullable: Tipo do documento detectado.
    - `idNumber` string, nullable: Número do RG.
    - `cpfNumber` string, nullable: Número do CPF.
    - `birthDate` string, nullable: Data de nascimento.
    - `fatherName` string, nullable: Nome do pai do titular do documento.
    - `motherName` string, nullable: Nome do mãe do titular do documento.
    - `registerName` string, nullable: Nome do titular do documento.
    - `validDate` string, nullable: Validade do documento.
    - `driveLicenseCategory` string, nullable: Categoria da CNH (Carteira Nacional de Habilitação).
    - `driveLicenseNumber` string, nullable: Número da CNH.
    - `driveLicenseFirstQualifyingDate` string, nullable: Data da primeira CNH.
    - `federativeUnit` string, nullable: Unidade Federativa onde o documento foi emitido.
    - `issuedBy` string, nullable: Órgão emissor do documento.
    - `issuePlace` string, nullable: Localidade onde o documento foi emitido.
    - `issueDate` string, nullable: Data em que o documento foi emitido.
  - `liveness` Liveness: Informações da análise de prova de vida.
    - `status` 'LIVENESS_FOUND' | 'NO_LIVENESS' | 'COULD_NOT_DETECT_FACE': Resultado da análise de prova de vida.
  - `analyzedAt` string, date-time, nullable: Data da análise do documento.

## Other responses

- `400` (unresolved $ref)
- `403`: O acesso ao recurso foi negado pelo servidor.
- `404` (unresolved $ref)
- `500` (unresolved $ref)

---

[API](https://skmtc.dev/bankly/apis/id-one.md) - [All operations](https://skmtc.dev/bankly/apis/id-one/llms.txt) - [OpenAPI document](https://skmtc.dev/bankly/apis/id-one/revisions/7cda227a76f4?raw)