v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB
Subject

Create Subject

Recebe dados do sujeito para verificação biométrica e biográfica, e o cadastra em caso de sucesso.

Requisitos:

  1. A imagem do documento deve ter no mínimo 1000 pixels de largura. Para melhores resultados, é recomendável que possua pelo menos 2000 pixels.

  2. A foto do sujeito deve ter resolução mínima de 250 x 250 pixels.

  3. Os campos Documento e QR Code são opcionais, mas pelo menos um deles deve estar presente, caso seja enviado os dois, o campo Documento será ignorado.

  4. Para Documento e Selfie somente os formatos JPG e PNG são aceitos no momento.

  5. Para QR Code os formatos JPG, PNG, PDF e binário são aceitos.

  6. Tamanho de cada imagem não pode ultrapassar 5MB.

  7. Pode ser enviado somente a foto do sujeito e o CPF, criando assim um cadastro simplificado *

Liveness:

  • Liveness pode ser usado nessa operação.

  • O uso de liveness, por padrão, é definido pela aplicação, mas pode ser sobrescrito em cada chamada com parâmetro 'liveness', que aceita valores booleanos, presente no corpo da requisição.

  • O teste de liveness pode ser realizado à partir de uma foto ou de uma evidência de liveness.

  • A foto deve ser enviada no campo 'selfie'. A evidência deve ser enviada no campo 'liveness_evidence'.

  • Caso opte por usar a evidência de livensess, a foto usada na operação será extraída da mesma.

  • O resultado do liveness ('liveness_result') será incorporado ao cadastro.

Importante: Os campos 'selfie' e 'liveness_evidence' são mutualmente exclusivos, ou seja: Não devem ser eviados juntos na mesma requisição.

Em caso de reprovação no teste de liveness, a operação é anulada.

Para mais informações sobre o exceções, leia a documentação da rota (Liveness Validation)

Datavalid:

Caso ocorra um problema na validação dos dados no Datavalid, a API irá retornar um dos seguintes erros:

messageerror_codeStatus HTTP
LGPD: Dados de menor de idade4041422
CPF inválido4042422
Situação do CPF inválido4046422
Imagem da face não encontrada nas bases4058422
Não foi possível reconhecer a face na imagem4059422
Tamanho da imagem da face inválido4060422
Qualidade baixa da imagem da face4063422
Foi reconhecido mais de uma face na imagem4064422
Formato da imagem da face inválido4065422
post/api/v2/subject

Response

uuidstring required
cpfstring required
is_qualifiedboolean required
created_atstring required
updated_atstring required