> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/docs.facephi-pt-br/api-rest/identity-api/identity-api-reference/onboarding/morphology/document-validation-v2/document-validation-data-v2.md). # Dados da validação de documento V2 Obtém os resultados da análise morfológica do documento **assim que o processo de validação for concluído com êxito**. {% hint style="info" %} Os campos da resposta dependerão do provedor de morfologia configurado. {% endhint %} ### Endpoint ``` POST /verify/documentValidation/v2/data ``` ### 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. | {% hint style="info" %} Todas as chamadas aos Endpoints para Tracking com **Identity Platform** devem conter o cabeçalho `family`. {% endhint %} ### 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 ```json { "scanReference": "fe294c25-17e1-4d98-a958-710edbf00064", "tracking": { "extraData": "BQABAQG2gBNjuHN4kLmPqYf7R...", "operationId": "123e4567-e89b-12d3-a456-426614174000" } } ``` ### Respostas #### `200` Sucesso #### Parâmetros de resposta — raiz | Parâmetro | Tipo | Descrição | | -------------- | ------ | ------------------------------------------------------------------------------- | | `status` | string | Estado do serviço. Valores possíveis: `success`, `fail` | | `verification` | object | Objeto com os resultados da verificação. Consulte as tabelas detalhadas abaixo. | #### Parâmetros de resposta — `verification` | Parâmetro | Tipo | Nullable | Descrição | | ----------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `acceptanceTime` | string | Não | Marca de tempo inicial no formato **YYYY-MM-DDThh**:flag\_mm:**ss.SSSZ**. | | `code` | integer | Não | Código de status correspondente. Valores possíveis: `7001`, `7002`, `9001`, `9102`, `9103`, `9104`, `9121`. Consulte [Resultados da verificação](#verification-results). | | `decisionTime` | string | Não | Marca de tempo correspondente ao momento da **decisão final**. | | `merchantScanReference` | string | Não | Número de referência da validação. | | `scanReference` | string | Não | Referência interna fornecida no estado de início. | | `status` | string | Não | Estado do processo de validação do documento. Valores possíveis: `Started`, `Submitted`, `Approved`, `Declined`, `Resubmission`, `Expired/Abandoned`, `Review`. Consulte [Resultados da verificação](#verification-results). | | `reason` | string | Sim | Descrição do motivo de rejeição do documento (status declined). Null se o estado for approved. Consulte [Código de Resultado do Serviço](#service-result-code). | | `reasonCode` | integer | Sim | Código associado ao motivo de rejeição. Null se o estado for approved. Consulte [Códigos de motivo](#reason-codes). | | `document` | object | Não | Informações do documento. Consulte a tabela a seguir. | | `person` | object | Não | Informações da pessoa. Consulte a tabela a seguir. | #### Parâmetros de resposta — `verification.document` | Parâmetro | Tipo | Nullable | Descrição | | -------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------- | | `type` | string | Não | Tipo de documento. Valores possíveis: `PASSPORT`, `DRIVING_LICENSE`, `ID_CARD`, `VISA`, `UNSUPPORTED` | | `country` | string | Não | Código do país emissor no formato **ISO 3166-1 alpha-3**. | | `number` | string | Não | Número do documento. | | `validFrom` | string | Sim | Data de emissão do documento. | | `validUntil` | string | Não | Data de expiração do documento. | | `placeOfIssue` | string | Não | Local de emissão. | | `firstIssue` | string | Não | Data da primeira emissão do documento. | | `issueNumber` | string | Não | Número de emissão. | | `issuedBy` | string | Não | Autoridade emissora. | #### Parâmetros de resposta — `verification.person` | Parâmetro | Tipo | Nullable | Descrição | | -------------- | ------ | -------- | --------------------------------------------- | | `firstName` | string | Sim | Nome do usuário. | | `lastName` | string | Sim | Sobrenome do usuário. | | `idNumber` | string | Sim | Número do documento do usuário. | | `citizenship` | string | Sim | Cidadania. | | `nationality` | string | Sim | Nacionalidade. | | `gender` | string | Sim | Gênero. | | `dateOfBirth` | string | Sim | Data de nascimento no formato **YYYY-MM-DD**. | | `yearOfBirth` | string | Sim | Ano de nascimento **YYYY**. | | `placeOfBirth` | string | Sim | Local de nascimento. | #### Código de Resultado do Serviço O `serviceResultCode` indica o resultado geral da execução do serviço: | serviceResultCode | Descrição | Código HTTP | | ----------------- | -------------------------------------------------------------------------------------- | ----------- | | 0 | A execução do serviço foi bem-sucedida, o módulo processou a solicitação corretamente. | 200 | #### Resultados da verificação O campo `verification.status` na resposta de Document Validation Data indica o resultado da verificação: | Status | Código | Descrição | | --------------------- | ------ | ------------------------------------------------------- | | **Started** | 7001 | O processo de validação foi iniciado. | | **Submitted** | 7002 | Enviado para processamento de validação. | | **Approved** | 9001 | Verificado e aprovado com êxito. | | **Declined** | 9102 | A validação falhou e foi rejeitada. | | **Resubmission** | 9103 | Requer reenvio com correções ou informações adicionais. | | **Expired/Abandoned** | 9104 | O processo de validação expirou ou foi abandonado. | | **Review** | 9121 | Em revisão manual para verificação adicional. | #### Códigos de motivo A tabela a seguir contém os códigos de motivo detalhados que fornecem contexto adicional para os resultados do serviço (`reasonCode`). {% hint style="info" %} Os códigos obsoletos dos intervalos **200** e **600** foram substituídos/migrados para os intervalos **500** e **900**. Consulte a tabela de [Migração de códigos](#migracion-de-codigos) para conhecer as equivalências. {% endhint %} | Código | Descrição | | ------ | -------------------------------------------------------------------------------------------------------------------- | | 101 | Documento físico não utilizado | | 102 | Suspeita de adulteração do documento | | 103 | A pessoa que apresenta o documento não parece corresponder à foto do documento | | 104 | O nome informado não corresponde ao nome no documento | | 105 | Comportamento suspeito | | 106 | Fraude conhecida | | 107 | Velocidade/abuso | | 108 | Velocidade/abuso: usuário final duplicado | | 109 | Velocidade/abuso: dispositivo duplicado | | 110 | Velocidade/abuso: ID duplicado | | 111 | Sessão acessada de forma fraudulenta | | 112 | Localização de IP restrita | | 113 | Comportamento suspeito - Identity Farming | | 120 | A pessoa no retrato não parece corresponder à foto de referência | | 121 | ID do usuário ausente | | 122 | Nenhuma referência encontrada | | 123 | Não foi possível passar nas verificações do registro | | 124 | O rosto já existe na coleção de rostos | | 126 | Possível correspondência com PEP | | 127 | Correspondência facial com lista de bloqueio | | 128 | Incompatibilidade do ID do usuário final | | 501 | Alta probabilidade de tentativa fraudulenta | | 502 | Múltiplas partes presentes na sessão | | 503 | Tentativa de engano | | 504 | Tentativa de engano, tela do dispositivo usada | | 505 | Tentativa de engano, impressão usada | | 506 | Documento apresentado adulterado | | 507 | Documento apresentado adulterado, cruzamento de dados | | 508 | Documento apresentado adulterado, similaridade do documento com o espécime | | 509 | A pessoa que apresenta o documento não corresponde à foto do documento | | 510 | Tipo de documento apresentado não suportado | | 511 | Documento apresentado expirado | | 512 | Documento apresentado anulado ou danificado | | 513 | Documento apresentado anulado | | 514 | O documento apresentado está danificado | | 515 | Tentativa de engano, tela do dispositivo usada para imagem facial | | 516 | Tentativa de engano, tela do dispositivo usada para imagem do documento | | 517 | Tentativa de engano, tela do dispositivo usada para imagem da frente do documento | | 518 | Tentativa de engano, tela do dispositivo usada para imagem do verso do documento | | 519 | Tentativa de ataque de injeção | | 520 | Tentativa de engano, impressão usada para imagem facial | | 521 | Tentativa de engano, impressão usada para imagem do documento | | 522 | Tentativa de engano, impressão usada para imagem da frente do documento | | 523 | Tentativa de engano, impressão usada para imagem do verso do documento | | 524 | Documento apresentado adulterado, o cruzamento de dados da frente do documento e da MRZ não corresponde | | 525 | Documento apresentado adulterado, o cruzamento de dados da frente do documento e do código de barras não corresponde | | 526 | Tentativa de engano, fotos transmitidas | | 527 | Não foi possível coletar os dados do comprovante de endereço | | 528 | Data de emissão do comprovante de endereço muito antiga | | 529 | Não foi possível validar os dados do documento de identidade nacional | | 530 | A pessoa tem menos de 13 anos | | 531 | A pessoa tem menos de 14 anos | | 532 | A pessoa tem menos de 16 anos | | 533 | A pessoa tem menos de 18 anos | | 534 | A pessoa tem menos de 20 anos | | 535 | A pessoa tem menos de 21 anos | | 536 | A pessoa tem menos de 25 anos | | 537 | Não foi possível recortar o retrato da mídia do documento | | 538 | Não foi possível consultar o banco de dados CIFAS | | 539 | Limite de reenvio excedido | | 540 | Pontuação de confiança baixa para a sessão | | 541 | O nome no documento não corresponde ao nome nos dados de inicialização da sessão | | 542 | Não foi possível validar o CPF | | 543 | A imagem facial de referência tem baixa qualidade | | 544 | O registro não respondeu | | 545 | Imagem de referência ausente | | 546 | Qualidade da imagem facial insuficiente | | 547 | Rosto ausente | | 548 | Tentativa de engano, com referência facial ausente | | 549 | A validação NFC falhou | | 550 | O nome no documento relacionado ao endereço não corresponde ao nome nos dados de inicialização da sessão | | 551 | Documento não reconhecido | | 552 | A frente do documento está ausente | | 553 | O verso do documento está ausente | | 554 | A frente do documento não está totalmente enquadrada | | 555 | O verso do documento não está totalmente enquadrado | | 556 | A imagem facial não está claramente visível | | 557 | Os dados do documento não estão visíveis | | 558 | Não foi possível coletar os dados do sobrenome | | 559 | Não foi possível coletar os dados dos nomes | | 560 | Não foi possível coletar os dados da data de nascimento | | 561 | Não foi possível coletar os dados do número do documento | | 562 | Não foi possível coletar os dados da data de validade | | 563 | Não foi possível coletar os dados do número pessoal | | 564 | Muitas tentativas incorretas ou MFA incompleto | | 565 | Categoria de carteira de motorista não suportada | | 566 | Falha no processamento do sistema | | 567 | Os critérios de decisão não foram atendidos | | 568 | Entrada inválida | | 569 | Não foi possível recortar o rosto da imagem facial | | 570 | Rejeição personalizada | | 571 | Não foi possível identificar o país | | 572 | O número do documento no documento não corresponde ao número do documento nos dados de inicialização da sessão | | 573 | O endereço no documento não corresponde ao endereço nos dados de inicialização da sessão | | 574 | O endereço fornecido está sem campos obrigatórios | | 575 | Certificado inválido | | 576 | A data de nascimento no documento não corresponde à data de nascimento nos dados de inicialização da sessão | | 577 | O número pessoal no documento não corresponde ao número pessoal nos dados de inicialização da sessão | | 578 | O gênero no documento não corresponde ao gênero nos dados de inicialização da sessão | | 579 | Não foi possível validar a assinatura PDF | | 580 | A correspondência de endereço falhou devido a restrições regionais | | 581 | A imagem facial fornecida não corresponde à imagem facial no registro | | 582 | O nome fornecido não corresponde ao nome no registro | | 583 | A data de nascimento fornecida não corresponde à data de nascimento no registro | | 584 | O número pessoal fornecido não corresponde ao número pessoal no registro | | 585 | Data de emissão do documento muito antiga | | 586 | Entrada obrigatória ausente | | 587 | A ocupação no documento não corresponde à ocupação nos dados de inicialização da sessão | | 643 | Não foi possível recortar a imagem facial da frente de um documento | | 655 | Não foi possível coletar nome adicional | | 901 | Ocorreu um erro do provedor de registro ao se conectar ao registro | | 902 | Não foi possível encontrar a pessoa no registro | | 903 | Algumas verificações de informações pessoais falharam | | 904 | Documento reportado como perdido ou roubado | | 905 | A sessão do provedor de identidade digital expirou | | 906 | Nem todos os campos e documentos de identidade digital obrigatórios foram compartilhados | | 1001 | O ID da consulta deve ter entre 20 e 40 caracteres | | 1002 | O ID da consulta deve ser um UUID V4 válido | | 1003 | O ID da consulta deve ser exclusivo, ele já foi usado. | | 1102 | Faltam parâmetros obrigatórios na solicitação. | | 1104 | A solicitação inclui parâmetros inválidos. | | 1201 | Timestamp inválido. O timestamp não pode ser mais antigo que uma hora. | | 1202 | O formato do timestamp está incorreto. YYYY-MM-DDTHH:MM:S+Timezone Offset | | 1203 | Data ISO 8601 inválida. A data precisa estar no formato YYYY-MM-DD. | | 1301 | Os recursos solicitados não são suportados. | | 1302 | Apenas URLs de retorno HTTPS são permitidas. | | 1303 | Status inválido. | | 1304 | Não é possível fazer a transição para o status "$STATUS". | | 1308 | O número de ID está ausente. | | 1309 | A validação de SSN requer que person firstName + lastName OU fullName seja fornecido. | | 1310 | A validação de SSN requer que person.dateOfBirth ou dados de address sejam fornecidos. | | 1400 | Dados da imagem não encontrados. | | 1401 | A imagem não está em base64 válido. | | 1402 | O contexto da imagem não é suportado. | | 1403 | A propriedade da imagem está ausente. | | 1500 | O campo vendorData não pode ter mais de 1000 caracteres. | | 1501 | vendorData deve ser uma string. | | 2003 | A data de nascimento não é uma data válida. | | 2101 | O número do documento deve ter entre 6 e 9 caracteres. | | 2102 | O número do documento pode conter apenas letras e números A-Z, 0-9. | | 2103 | O tipo de documento não é suportado. | | 2104 | O documento do país fornecido não é suportado. | #### Migração de códigos Os códigos obsoletos dos intervalos **200** e **600** foram substituídos por novos códigos no intervalo **500**. A tabela a seguir mostra as equivalências entre os códigos antigos e os novos: | Código anterior (obsoleto) | Descrição anterior | Novo código | Descrição nova | | -------------------------- | ---------------------------------------------------- | ----------- | -------------------------------------------------------- | | 605 | Imagem facial ausente | 547 / 545 | Rosto ausente / imagem de referência ausente | | 608 | Frente do documento ausente | 552 | A frente do documento está ausente | | 609 | Verso do documento ausente | 553 | O verso do documento está ausente | | 614 | A frente do documento não está totalmente enquadrada | 554 | A frente do documento não está totalmente enquadrada | | 615 | O verso do documento não está totalmente enquadrado | 555 | O verso do documento não está totalmente enquadrado | | 619 | Dados do documento não visíveis | 557 | Os dados do documento não estão visíveis | | 620 | Documento apresentado expirado | 511 | Documento apresentado expirado | | 625 | Não foi possível coletar o sobrenome | 558 | Não foi possível coletar os dados do sobrenome | | 626 | Não foi possível coletar os nomes | 559 | Não foi possível coletar os dados dos nomes | | 627 | Não foi possível coletar a data de nascimento | 560 | Não foi possível coletar os dados da data de nascimento | | 629 | Não foi possível coletar a data de validade | 562 | Não foi possível coletar os dados da data de validade | | 631 | Não foi possível coletar o número do documento | 561 | Não foi possível coletar os dados do número do documento | | 632 | Não foi possível coletar o número pessoal | 563 | Não foi possível coletar os dados do número pessoal | | 636 | Documento apresentado não real, tela usada | 504 | Tentativa de engano, tela do dispositivo usada | | 637 | Documento apresentado não real, impressão usada | 505 | Tentativa de engano, impressão usada | | 647 | Documento não reconhecido | 551 | Documento não reconhecido | #### Exemplo de resposta ```json { "status": "success", "verification": { "acceptanceTime": "2019-11-06T07:15:27.000Z", "code": 9001, "decisionTime": "2019-11-06T07:18:36.916Z", "merchantScanReference": "12345678", "scanReference": "12df6045-3846-3e45-946a-14fa6136d79a", "status": "approved", "reason": null, "reasonCode": null, "document": { "type": "DRIVERS_LICENSE", "country": "ESP", "number": "PEREZ771116SM1AJ", "validFrom": null, "validUntil": "2024-04-20", "placeOfIssue": "MADRID", "firstIssue": "2015-03-21", "issueNumber": "01", "issuedBy": "ISSUER" }, "person": { "firstName": "MATIAS", "lastName": "PEREZ", "idNumber": null, "citizenship": null, "nationality": null, "gender": null, "dateOfBirth": "1973-03-30", "yearOfBirth": "1973", "placeOfBirth": "MADRID" } } } ``` #### `400` Requisição inválida ```json { "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 ```json { "message": "Unauthorized" } ``` #### `403` Proibido ```json { "Message": "User is not authorized to access this resource with an explicit deny" } ``` #### `502` Gateway inválido ```json { "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 ```json { "message": "Endpoint request timed out" } ```