BAbankly
Análise de documentos

Consulta do status da análise

<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]
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

Path parameters

documentNumberstring required

Número do documento CPF do cliente do cliente pessoal ou representante legal.

Número do documento CPF do cliente pessoa física ou representante legal da empresa. Informe somente números.

Query parameters

resultLevel'ONLY_STATUS' | 'DETAILED'

Tipo de retorno da API, o qual pode ser ONLY_STATUS ou DETAILED.

Tipo de retorno da API , qual pode ser ONLY_STATUS ou DETAILED.

tokenstring[] 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

Recurso encontrado.

tokenstring 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.

analyzedAtstring date-time nullable

Data da análise do documento.

Changes

No recorded changes to this operation across all 1 revision of this API.