Pular para o conteúdo principal

Processamento

O processamento é o coração da nossa API, permitindo que você envie documentos e imagens faciais para análises automatizadas e receba resultados estruturados conforme o tipo de processamento escolhido.

Este endpoint unifica as capacidades da plataforma:

  • Documentos: Envie imagens de documentos (RG, CNH, DNI, CIN, INE) para Tipificação, OCR e Documentoscopia
  • Comparação facial: Compare faces entre si com Facematch ou valide a selfie contra o documento com Facedoc
Liveness e Biometria

Os processamentos de Liveness (13), Biometria (14) e Liveness + Biometria (15) são realizados exclusivamente via SDK ou interface Tirrell. Consulte a documentação de Tipos de Processamento para mais detalhes.

Consulte a documentação de Tipos de Processamento para escolher a análise adequada ao seu caso de uso.

Como funciona​

O processo acontece em duas etapas:

  1. Você envia as imagens (documentos ou faces) com os parâmetros necessários para processamento
  2. O sistema retorna um ticket confirmando que recebeu a solicitação e iniciou o processamento

Os resultados completos serão enviados posteriormente via webhook para a URL configurada na requisição.

Importante

Para processamento de documentos, é essencial enviar frente (face A) e verso (face B) para uma análise completa e precisa.

Enviando imagens para processamento​

Para enviar dados ao sistema, você deve possuir um token válido e montar o JSON com os parâmetros necessários para o processamento.

Solicitação​

Endpoint:

POST https://ticketsentrypoint-api.spekter.com.br/Ticket

Cabeçalhos necessários:

Content-Type: application/json
Accept: application/json
Authorization: Bearer {seu_token}

Corpo da requisição (JSON):

Importante

A estrutura de entrada varia entre tipos de processamento de documentos e comparação facial.

Veja abaixo as duas estruturas disponíveis:

Tipos: 1, 2, 4, 7

{
  "idExterno": "string",
  "idTipoProcessamento": 0,
  "urlRetornoTicket": "https://sua-url-webhook.com",
  "cpf": "12345678910",
  "arquivos": ["string1Base64", "string2Base64"]
}

Parâmetros de entrada​

Requisição para documentos (Tipos 1, 2, 4, 7)​

ParâmetroTipoObrigatórioDescrição
idExternostring (varchar 45)SimCódigo de identificação interna do cliente
idTipoProcessamentointeger (int64)SimCódigo do tipo de processamento a ser realizado
urlRetornoTicketstringSimURL do webhook onde será enviado o resultado da análise
arquivosarray[string]SimLista de imagens (JPG, JPEG, PNG) codificadas em base64 (utf-8)
cpfstring (varchar 11)NãoCPF do portador do documento

Requisição para comparação facial (Tipos 16 e 20)​

ParâmetroTipoObrigatórioDescrição
idExternostring (varchar 45)SimCódigo de identificação interna do cliente
idTipoProcessamentointeger (int64)SimCódigo do tipo: 16 (Facematch) ou 20 (Facedoc)
arquivosstringSimImagem em base64 da face cadastrada na base de dados do cliente
selfiestringSimImagem em base64 da face capturada para comparação

Retorno da solicitação​

Importante

A estrutura de saída varia entre tipos de processamento de documentos e comparação facial.

Veja abaixo as duas estruturas de resposta:

Tipos: 1, 2, 4, 7

{
  "id": 360681,
  "idExterno": "123",
  "ticket": "0c15af60-c69c-4223-b89d-db4712267dbe",
  "dtCriacao": "2022-11-23T19:10:53.7427443-03:00",
  "idCliente": "08d806f7-6c08-46b6-8455-c115d3ccb720",
  "idSubcliente": "00000000-0000-0000-0000-000000000000",
  "idUsuario": "08d905b4-653b-4842-8fa0-d400108b98fc",
  "statusProcessamento": 3,
  "dtStatusProcessamento": "2022-11-23T19:10:53.7427581-03:00",
  "idTipoProcessamento": 4,
  "urlRetornoTicket": "https://sua-url-webhook.com",
  "base64FaceA": "/9j/4AAQSkZJRgABAQAAAQABAAD/...",
  "base64FaceB": "/9j/4AAQSkZJRgABAQAAAQABAAD/...",
  "documentoEncontrado": true,
  "tipoDocumento": "CNH",
  "subtipoDocumento": "CNH 2022"
}

Campos do retorno​

Retorno para documentos (Tipos 1, 2, 4, 7)​

Informações do ticket​

CampoTipoDescrição
idinteger (int64)Identificação interna do ticket
idExternostringCódigo de identificação interna do cliente
ticketstring (UUID)Identificador único do processamento
dtCriacaostring (date-time)Data e hora de criação do ticket
idClientestring (UUID)Identificação do cliente no sistema
idSubclientestring (UUID)Identificação do subcliente no sistema
idUsuariostring (UUID)Identificação do usuário

Status e processamento​

CampoTipoDescrição
statusProcessamentointeger (int64)Código do status de processamento
dtStatusProcessamentostring (date-time)Data e hora da última atualização do status
idTipoProcessamentointeger (int64)Código do tipo de processamento realizado
urlRetornoTicketstringURL do webhook configurado para receber o resultado

Imagens processadas​

CampoTipoDescrição
base64FaceAstringImagem da face A (frente) em base64
base64FaceBstringImagem da face B (verso) em base64

Documento identificado​

CampoTipoDescrição
documentoEncontradobooleanIndica se um documento foi identificado na imagem
tipoDocumentostringTipo do documento identificado (RG, CNH, etc.)
subtipoDocumentostringSubtipo do documento (ex: CNH 2022)

Retorno para comparação facial (Tipos 16 e 20)​

CampoTipoDescrição
status.idintegerCódigo do status do processamento
status.nomestringNome do status (ex: "Processado")
baseComparacaostringImagem em base64 da face cadastrada utilizada na comparação
selfiestringImagem em base64 da selfie enviada
facematch.statusbooleanIndica se a comparação foi realizada com sucesso
facematch.verificadobooleanIndica se as faces correspondem (true = match positivo)
ticketstring (UUID)Identificador único do processamento

Próximos passos​

Após enviar as imagens para processamento, você receberá um ticket de confirmação. Os resultados completos serão enviados para a urlRetornoTicket configurada assim que o processamento for concluído.

Consulte a documentação de Webhook para entender como receber e processar os resultados, e a documentação de Status de Processamento para conhecer todos os possíveis status.