Resumo
As APIs ID Verification, Face Match e Liveness (KYC por sessão) retornam um campowarnings quando o provedor de verificação sinaliza problemas não bloqueantes ou flags de risco. warnings é um array de strings com códigos de risco (ex.: "POSSIBLE_DUPLICATED_USER", "LOW_FACE_MATCH_SIMILARITY"). Os clientes podem usar esses códigos para:
- Exibição: Mapear cada código para uma mensagem legível (ex.: via i18n próprio ou as descrições abaixo).
- Lógica: Agir conforme o código (ex.: UX diferente para
DOCUMENT_EXPIREDvsPOSSIBLE_DUPLICATED_USER).
Se o provedor retornar um código não listado aqui, você ainda pode recebê-lo em
warnings. Trate códigos desconhecidos como avisos genéricos e exiba o código ou uma mensagem de fallback.ID Verification
Retornado em POST /api/kyc/id-verification e GET /api/kyc/id-verification/verifications/:id no arraywarnings.
| Código | Descrição |
|---|---|
ID_DOCUMENT_IN_BLOCKLIST | O documento corresponde a uma entrada da sua lista de documentos bloqueados (fraudulentos, roubados ou problemáticos). |
BARCODE_NOT_DETECTED | Não foi possível localizar ou ler o código de barras do documento. |
BARCODE_VALIDATION_FAILED | O código de barras não pôde ser validado com os demais dados do documento. |
QR_NOT_DETECTED | Não foi possível localizar ou ler o código QR do documento. |
QR_VALIDATION_FAILED | O código QR não pôde ser validado com os demais dados do documento. |
MRZ_NOT_DETECTED | Não foi encontrada ou lida a zona de leitura mecânica (MRZ) do documento. |
MINIMUM_AGE_NOT_MET | A idade do usuário está abaixo do mínimo exigido. |
DATA_INCONSISTENT | Os dados OCR e do chip NFC não coincidem; possível alteração ou inconsistência. |
COULD_NOT_RECOGNIZE_DOCUMENT | Não foi possível confirmar a autenticidade ou validade do documento. |
PORTRAIT_IMAGE_NOT_DETECTED | Não foi possível identificar ou processar a foto do documento. |
DOCUMENT_NUMBER_NOT_DETECTED | Não foi possível localizar ou ler o número do documento. |
DATE_OF_BIRTH_NOT_DETECTED | Não foi possível identificar a data de nascimento no documento. |
EXPIRATION_DATE_NOT_DETECTED | Não foi possível identificar a data de validade no documento. |
NAME_NOT_DETECTED | Não foi possível identificar o nome e/ou sobrenome no documento. |
MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME | Há diferenças entre o MRZ e os dados extraídos por OCR; possível alteração do documento. |
MRZ_VALIDATION_FAILED | O MRZ não atende ao formato esperado ou contém dados inválidos. |
INVALID_DATE | Uma ou mais datas do documento não são válidas ou não coincidem com o formato esperado. |
DOCUMENT_EXPIRED | A data de validade do documento já passou. |
DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION | O tipo de documento não é aceito neste processo de verificação. |
DOCUMENT_SIDES_MISMATCH | As faces do documento não coincidem com o formato esperado. |
COULD_NOT_DETECT_DOCUMENT_TYPE | Não foi possível determinar o tipo de documento enviado. |
DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS | O nome neste documento não coincide com o de outros documentos já verificados para este usuário. |
POSSIBLE_DUPLICATED_USER | O sistema identificou um possível usuário duplicado com documentos aprovados em outra sessão; investigação necessária. |
LOW_FRONT_CAMERA_FACE_MATCH_SIMILARITY | O rosto capturado não corresponde suficientemente à foto do documento. |
FULL_NAME_MISMATCH_WITH_PROVIDED | O nome completo fornecido não coincide com o extraído do documento. |
DOB_MISMATCH_WITH_PROVIDED | A data de nascimento fornecida não coincide com a do documento. |
GENDER_MISMATCH_WITH_PROVIDED | O gênero fornecido não coincide com o do documento. |
COUNTRY_MISMATCH_WITH_PROVIDED | O país fornecido não coincide com o do documento. |
NATIONALITY_MISMATCH_WITH_PROVIDED | A nacionalidade fornecida não coincide com a do documento. |
IDENTIFICATION_NUMBER_MISMATCH_WITH_PROVIDED | O número de identificação fornecido não coincide com o do documento. |
SCREEN_CAPTURE_DETECTED | O documento parece ser captura de tela ou foto de documento exibido na tela, não o físico. |
PRINTED_COPY_DETECTED | O documento parece ser uma cópia impressa, não o original oficial. |
PORTRAIT_MANIPULATION_DETECTED | Foi detectada possível manipulação da área da foto do documento. |
UNPARSED_ADDRESS | O endereço do documento não pôde ser interpretado ou geolocalizado. |
DOCUMENT_NUMBER_FORMAT_MISMATCH | O número do documento não coincide com o formato esperado para este tipo. |
PERSONAL_NUMBER_FORMAT_MISMATCH | O número pessoal não coincide com o formato esperado para este tipo de documento. |
ID_VERIFICATION_DATA_MISMATCH_BETWEEN_DOCUMENTS | Os dados extraídos de vários documentos desta sessão não coincidem (nome ou data de nascimento). |
Face Match
Retornado em POST /api/kyc/face-match e GET /api/kyc/face-match/verifications/:id no arraywarnings.
| Código | Descrição |
|---|---|
LOW_FACE_MATCH_SIMILARITY | Os traços faciais da imagem não correspondem suficientemente à imagem de referência. |
NO_REFERENCE_IMAGE | Falta uma imagem de referência para a comparação facial. |
Liveness (KYC por sessão)
Retornado nas respostas de validação KYC por sessão (ex.: validação atual, listagem) quando são realizadas verificações de vivacidade. O arraywarnings do payload pode conter estes códigos.
| Código | Descrição |
|---|---|
FACE_IN_BLOCKLIST | O rosto corresponde a uma entrada da sua lista de rostos bloqueados. |
POSSIBLE_FACE_IN_BLOCKLIST | O sistema identificou um possível rosto na lista de bloqueados. |
LOW_LIVENESS_SCORE | A verificação de vivacidade resultou em pontuação baixa. |
NO_FACE_DETECTED | Não foi identificado um rosto durante a verificação de vivacidade. |
LIVENESS_FACE_ATTACK | Foi detectada possível tentativa de burlar a verificação de vivacidade. |
DUPLICATED_FACE | Foi identificado um rosto duplicado de outra sessão aprovada. |
POSSIBLE_DUPLICATED_FACE | Este rosto pode coincidir com outro usuário já aprovado no sistema. |
MULTIPLE_FACES_DETECTED | Foram detectados vários rostos na imagem. É usado o maior para a verificação. (Apenas Liveness passivo) |
LOW_FACE_QUALITY | A qualidade da imagem facial está abaixo do limite aceitável. (Apenas Liveness passivo) |
LOW_FACE_LUMINANCE | A imagem facial está muito escura. (Apenas Liveness passivo) |
HIGH_FACE_LUMINANCE | A imagem facial está muito clara ou superexposta. (Apenas Liveness passivo) |
Exemplo de resposta (ID Verification)
Exemplo de resposta (Face Match)
ID Verification
Verificar frente/verso do documento e extrair dados
Face Match
Comparar foto do documento e selfie