Início da validação de documento

Inicia o processo de validação morfológica de documentos de identidade enviando as imagens do documento, país e tipo de documento a analisar.

Endpoint

POST /verify/documentValidation/start

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 header family.

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
country	string	Sim	Código do país ISO 3166-1 alpha-3.
idType	string	Sim	Tipo do documento fornecido. Valores possíveis: PASSPORT, DRIVING_LICENSE, ID_CARD, VISA
frontsideImage	string	Sim	Imagem codificada em Base64, aberta ou tokenizada, da frente do documento.
backsideImage	string	Não	Imagem codificada em Base64, aberta ou tokenizada, do verso do documento. Opcional para documentos de uma única face como PASSPORT.
merchantIdScanReference	string	Não	Referência personalizada da operação. Comprimento máximo: 100 caracteres.
rastreamento	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

{
  "country": "ESP",
  "idType": "ID_CARD",
  "frontsideImage": "BAMBAQLNHJoWGPjfeuDIzDXdZuP...",
  "backsideImage": "BAMBAQLNHJoWGPjfeuDIzDXdZuP...",
  "merchantIdScanReference": "my-scan-ref-001",
  "tracking": {
    "extraData": "BQABAQG2gBNjuHN4kLmPqYf7R...",
    "operationId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Respostas

200 Sucesso

Parâmetros de resposta

Parâmetro	Tipo	Descrição
timestamp	string	Carimbo de data/hora (UTC) da resposta no formato ISO 8601.
scanReference	string	Número de referência para cada escaneamento.
type	string	⚠️ Valor obsoleto. Será removido em versões futuras.

Exemplo de resposta

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

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 Acesso negado

{
  "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 Tempo limite do gateway

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