Status da validação de documento V2

Consulte o status da operação de validação morfológica. Este Endpoint deve ser chamado repetidamente até que a operação de análise seja concluída. Veja Status do Processo como referência dos diferentes valores de status.

Endpoint

POST /verify/documentValidation/v2/status

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
x-api-key	string	Sim	API Key de autorização de acesso.
family	string	Não	Valor: Onboarding. Obrigatório com o serviço de Tracking.

Todas as chamadas aos Endpoints para Tracking com Identity Platform devem conter o cabeçalho family.

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
scanReference	string	Sim	Número de referência do escaneamento.
type	string	Não	⚠️ Valor obsoleto. Será removido em versões futuras.
tracking	object	Não	Objeto que representa as informações de Tracking necessárias.
tracking.extraData	string	Não	Token gerado pelo SDK Mobile/Web. Contém informações de Tracking tokenizadas com a Plataforma.
tracking.operationId	string	Não	Identificador de operação gerado pelo SDK Mobile/Web.

Exemplo de solicitação

{
  "scanReference": "fe294c25-17e1-4d98-a958-710edbf00064",
  "tracking": {
    "extraData": "BQABAQG2gBNjuHN4kLmPqYf7R...",
    "operationId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Respostas

200 Sucesso

Parâmetros de resposta

Parâmetro	Tipo	Descrição
timestamp	string	Marca temporal (UTC) da resposta em formato ISO 8601.
scanReference	string	Número de referência do escaneamento.
status	string	Status da operação. Valores possíveis: PENDING, DONE, FAILED. Consulte Status do Processo.

Status do Processo

O Endpoint de status retorna um dos seguintes valores para indicar o status atual do processo de validação:

Status	Descrição
PENDING	Análise em andamento. Se recomenda consultar a cada 5 segundos até que seja concluída.
DONE	Validação concluída com sucesso. Execute o serviço Document Validation Data V2 para obter os resultados da análise.
FAILED	O processo de validação encontrou um erro e não pôde ser concluído.

Exemplo de resposta

{
  "timestamp": "1970-01-01T00:00:00.000Z",
  "scanReference": "fe294c25-17e1-4d98-a958-710edbf00064",
  "status": "DONE"
}

400 Requisição inválida

{
  "status": 400,
  "title": "Bad Request",
  "detail": "Invalid request.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400",
  "errors": []
}

401 Não autorizado

{
  "message": "Unauthorized"
}

403 Proibido

{
  "Message": "User is not authorized to access this resource with an explicit deny"
}

502 Gateway inválido

{
  "status": 502,
  "title": "Bad Gateway",
  "detail": "Server got an invalid response.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502"
}

504 Gateway Timeout

{
  "message": "Endpoint request timed out"
}