> 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). # Document validation Data V2 Obtém os resultados da análise morfológica do documento **uma vez que o processo de validação foi 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** da digitalização. | | `type` | string | Não | ⚠️ Valor **obsoleto**. Será removido em versões futuras. | | `tracking` | object | Não | Objeto que representa as informações de rastreamento necessárias. | | `tracking.extraData` | string | Não | Token gerado pelo SDK Mobile/Web. Contém informações de rastreamento 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. Veja as tabelas detalhadas abaixo. | #### Parâmetros de resposta — `verification` | Parâmetro | Tipo | Nulável | Descrição | | ----------------------- | ------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `acceptanceTime` | string | Não | Carimbo de data/hora 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`. Veja [Resultados da verificação](#verification-results). | | `decisionTime` | string | Não | Carimbo de data/hora 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 status inicial. | | `status` | string | Não | Estado do processo de validação do documento. Valores possíveis: `created`, `started`, `submitted`, `inflow_completed`, `review`, `approved`, `declined`, `resubmission_requested`, `expired`, `abandoned`. Veja [Resultados da verificação](#verification-results). | | `reason` | string | Sim | Descrição do motivo da rejeição do documento (status `declined` ou `resubmission_requested`). Nulo se o status for `approved`. Veja [Código de resultado do serviço](#service-result-code). | | `reasonCode` | integer | Sim | Código associado ao motivo da rejeição. Nulo se o status for approved. Veja [Códigos de motivo](#reason-codes). | | `document` | object | Não | Informações do documento. Veja a tabela a seguir. | | `person` | object | Não | Informações da pessoa. Veja a tabela a seguir. | #### Parâmetros de resposta — `verification.document` | Parâmetro | Tipo | Nulável | 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 | Nulável | Descrição | | -------------- | ------ | ------- | --------------------------------------------- | | `firstName` | string | Sim | Nome do usuário. | | `lastName` | string | Sim | Sobrenome do usuário. | | `idNumber` | string | Sim | Número de 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. {% hint style="warning" %} O valor de `verification.status` é retornado **em minúsculas**, exatamente como aparece na coluna `status` da tabela a seguir (por exemplo `"status": "declined"`, `"status": "approved"`). O status de reenvio é transmitido como `resubmission_requested`, **no** como `Resubmission`. Compare sempre o valor exato. {% endhint %} | `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 definitivamente. | | `resubmission_requested` | 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. | Além dos anteriores, o processo pode retornar os estados intermediários `created` e `inflow_completed`, que a plataforma trata como estados em andamento junto com `started`, `submitted` e `review`. #### Códigos de motivo A tabela a seguir contém os códigos de motivo (`reasonCode`) que podem acompanhar o resultado do serviço, ordenados numericamente. A coluna **Status associado** indica o valor de `verification.status` com o qual cada código é publicado; os códigos marcados com `—` correspondem a erros de validação da solicitação ou de configuração, não a uma decisão de verificação. {% hint style="info" %} Esta enumeração segue a lista oficial publicada pelo provedor de verificação e pode ser ampliada no futuro. Em função da configuração de cada integração, é possível que uma integração específica não chegue a receber todos os códigos listados. {% endhint %} {% hint style="warning" %} * O serviço transmite o valor de `reasonCode` **tal qual**, sem filtrá-lo nem traduzi-lo: qualquer código desta lista pode chegar ao cliente. * Como **tendência geral**, os códigos do intervalo **5xx** normalmente acompanham `declined` e os do intervalo **6xx** a `resubmission_requested`, mas **há exceções** (por ex. `655` é `declined` e `643` pode aparecer com ambos os estados). Por isso, a decisão deve se ramificar **sempre** sobre `verification.status`, nunca sobre o intervalo numérico nem sobre o texto do motivo. Veja [Relação entre `reasonCode` e a decisão](#relacion-entre-reasoncode-y-la-decision). * O intervalo **900** (`901`–`906`) agrupa erros de consulta a registros e de provedores de identidade digital. Não deve ser confundido com os valores `9001`, `9102`, `9103`, `9104` e `9121`, que correspondem ao campo `verification.code` (status da verificação) e não a `reasonCode`. {% endhint %} | Código | Status associado | Descrição | | ------ | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 101 | `declined` | Não foi utilizado um documento físico | | 102 | `declined` | Suspeita de manipulação do documento | | 103 | `declined` | A pessoa que apresenta o documento não parece corresponder à foto do documento | | 104 | `declined` | O nome informado não coincide com o nome do documento | | 105 | `declined` | Comportamento suspeito | | 106 | `declined` | Fraude conhecida | | 107 | `declined` | Velocidade/abuso (uso abusivo do serviço) | | 108 | `declined` | Velocidade/abuso: usuário final duplicado | | 109 | `declined` | Velocidade/abuso: dispositivo duplicado | | 110 | `declined` | Velocidade/abuso: Documento de identidade duplicado | | 111 | `declined` | Acesso fraudulento à sessão | | 112 | `declined` | Localização IP restrita | | 113 | `declined` | Comportamento suspeito: criação massiva de identidades (*identity farming*) | | 120 | `declined` | A pessoa do retrato não parece corresponder à foto de referência | | 121 | `declined` | Falta o identificador do usuário | | 122 | `declined` | Não foi encontrada nenhuma referência | | 123 | `declined` | As verificações contra registros não foram superadas | | 124 | `declined` | O rosto já existe na coleção de rostos | | 126 | `declined` | Possível correspondência com uma pessoa politicamente exposta (PEP) | | 127 | `declined` | Correspondência do rosto com uma lista de bloqueio | | 128 | `declined` | O identificador do usuário final não coincide | | 201 | `resubmission_requested` | Faltam o vídeo e/ou as fotos | | 202 | `resubmission_requested` | O rosto não está nítido | | 203 | `resubmission_requested` | O documento não está completamente visível | | 204 | `resubmission_requested` | Má qualidade da imagem | | 205 | `resubmission_requested` | Documento danificado | | 206 | `resubmission_requested` | Tipo de documento não suportado | | 207 | `resubmission_requested` | Documento vencido | | 208 | `resubmission_requested` | Falta a selfie | | 209 | `resubmission_requested` | Falta a foto do documento | | 210 | `resubmission_requested` | A frente do documento foi fotografada duas vezes | | 211 | `resubmission_requested` | O documento não está visível na imagem do Documento de identidade | | 212 | `resubmission_requested` | Enquadramento do documento: parte do documento fica fora da imagem | | 213 | `resubmission_requested` | Documento encoberto: o Documento de identidade está parcialmente encoberto (por exemplo, pelos dedos) | | 214 | `resubmission_requested` | Selfie de má qualidade: qualidade insuficiente (por exemplo, escura demais ou borrada) | | 215 | `resubmission_requested` | Documento de má qualidade: o documento não é legível (por exemplo, borrado demais ou escuro) | | 216 | `resubmission_requested` | Documento de má qualidade: reflexos | | 217 | `resubmission_requested` | Reenvio personalizado | | 218 | `resubmission_requested` | O limite de uploads foi excedido | | 501 | `declined` | Alta probabilidade de tentativa fraudulenta | | 502 | `declined` | Várias pessoas presentes na sessão | | 503 | `declined` | Tentativa de fraude | | 504 | `declined` | Tentativa de fraude: uso de tela de dispositivo | | 505 | `declined` | Tentativa de fraude: uso de cópia impressa | | 506 | `declined` | Documento apresentado manipulado | | 507 | `declined` | Documento apresentado manipulado: cruzamento de dados | | 508 | `declined` | Documento apresentado manipulado: semelhança do documento com um espécime | | 509 | `declined` | A pessoa que apresenta o documento não corresponde à foto do documento | | 510 | `declined` | Tipo de documento apresentado não suportado | | 511 | `declined` | Documento apresentado vencido | | 512 | `declined` | Documento apresentado cancelado ou danificado | | 513 | `declined` | Documento apresentado cancelado | | 514 | `declined` | O documento apresentado está danificado | | 515 | `declined` | Tentativa de fraude: tela de dispositivo na imagem do rosto | | 516 | `declined` | Tentativa de fraude: tela de dispositivo na imagem do documento | | 517 | `declined` | Tentativa de fraude: tela de dispositivo na imagem da frente do documento | | 518 | `declined` | Tentativa de fraude: tela de dispositivo na imagem do verso do documento | | 519 | `declined` | Tentativa de ataque por injeção | | 520 | `declined` | Tentativa de fraude: cópia impressa na imagem do rosto | | 521 | `declined` | Tentativa de fraude: cópia impressa na imagem do documento | | 522 | `declined` | Tentativa de fraude: cópia impressa na imagem da frente do documento | | 523 | `declined` | Tentativa de fraude: cópia impressa na imagem do verso do documento | | 524 | `declined` | Documento apresentado manipulado: os dados da frente do documento e do MRZ não coincidem | | 525 | `declined` | Documento apresentado manipulado: os dados da frente do documento e do código de barras não coincidem | | 526 | `declined` | Tentativa de fraude: fotos retransmitidas em *streaming* | | 527 | `declined` | Não foi possível obter os dados do comprovante de endereço | | 528 | `declined` | A data de emissão do comprovante de endereço é antiga demais | | 529 | `declined` | Não foi possível validar os dados do Documento de identidade | | 530 | `declined` | A pessoa é menor de 13 anos | | 531 | `declined` | A pessoa é menor de 14 anos | | 532 | `declined` | A pessoa é menor de 16 anos | | 533 | `declined` | A pessoa é menor de 18 anos | | 534 | `declined` | A pessoa é menor de 20 anos | | 535 | `declined` | A pessoa é menor de 21 anos | | 536 | `declined` | A pessoa é menor de 25 anos | | 537 | `declined` | Não foi possível recortar o retrato do documento | | 538 | `declined` | Não foi possível consultar a base de dados CIFAS | | 539 | `declined` | O limite de reenvios foi excedido | | 540 | `declined` | Pontuação de confiança baixa para a sessão | | 541 | `declined` | O nome do documento não coincide com o nome informado ao iniciar a sessão | | 542 | `declined` | Não foi possível validar o CPF | | 543 | `declined` | A imagem de referência do rosto tem má qualidade | | 544 | `declined` | O registro não respondeu | | 545 | `declined` | Falta a imagem de referência | | 546 | `declined` | Qualidade insuficiente da imagem do rosto | | 547 | `declined` | Falta o rosto | | 548 | `declined` | Tentativa de fraude com imagem de referência do rosto ausente | | 549 | `declined` | A validação NFC falhou | | 550 | `declined` | O nome do comprovante de endereço não coincide com o nome informado ao iniciar a sessão | | 551 | `declined` | O documento não é reconhecido | | 552 | `declined` | Falta a frente do documento | | 553 | `declined` | Falta o verso do documento | | 554 | `declined` | A frente do documento não aparece completa na imagem | | 555 | `declined` | O verso do documento não aparece completo na imagem | | 556 | `declined` | A imagem do rosto não está nítida | | 557 | `declined` | Os dados do documento não estão visíveis | | 558 | `declined` | Não foi possível obter os sobrenomes | | 559 | `declined` | Não foi possível obter os nomes | | 560 | `declined` | Não foi possível obter a data de nascimento | | 561 | `declined` | Não foi possível obter o número do documento | | 562 | `declined` | Não foi possível obter a data de validade | | 563 | `declined` | Não foi possível obter o número pessoal | | 564 | `declined` | Muitas tentativas incorretas ou MFA incompleto | | 565 | `declined` | Categoria da carteira de motorista não suportada | | 566 | `declined` | Falha no processamento do sistema | | 567 | `declined` | Os critérios de decisão não são atendidos | | 568 | `declined` | Entrada inválida | | 569 | `declined` | Não foi possível recortar o rosto da imagem do rosto | | 570 | `declined` | Rejeição personalizada | | 571 | `declined` | Não foi possível identificar o país | | 572 | `declined` | O número do documento não corresponde ao número do documento informado ao iniciar a sessão | | 573 | `declined` | O endereço do documento não corresponde ao endereço informado ao iniciar a sessão | | 574 | `declined` | O endereço fornecido está sem campos obrigatórios | | 575 | `declined` | Certificado inválido | | 576 | `declined` | A data de nascimento do documento não corresponde à data de nascimento informada ao iniciar a sessão | | 577 | `declined` | O número pessoal do documento não corresponde ao número pessoal informado ao iniciar a sessão | | 578 | `declined` | O gênero do documento não corresponde ao gênero informado ao iniciar a sessão | | 579 | `declined` | Não foi possível validar a assinatura do PDF | | 580 | `declined` | A comparação do endereço falhou devido a restrições regionais | | 581 | `declined` | A imagem do rosto fornecida não corresponde à imagem do rosto do registro | | 582 | `declined` | O nome fornecido não corresponde ao nome do registro | | 583 | `declined` | A data de nascimento fornecida não corresponde à data de nascimento do registro | | 584 | `declined` | O número pessoal fornecido não corresponde ao número pessoal do registro | | 585 | `declined` | A data de emissão do documento é muito antiga | | 586 | `declined` | Falta uma entrada obrigatória | | 587 | `declined` | A ocupação do documento não corresponde à ocupação informada ao iniciar a sessão | | 602 | `resubmission_requested` | Tipo de documento apresentado não suportado | | 603 | `resubmission_requested` | Falta o vídeo | | 604 | `resubmission_requested` | Faltam as imagens do rosto e/ou do documento | | 605 | `resubmission_requested` | Falta a imagem do rosto | | 606 | `resubmission_requested` | O rosto não está nítido | | 607 | `resubmission_requested` | O documento está faltando na imagem | | 608 | `resubmission_requested` | Falta a frente do documento | | 609 | `resubmission_requested` | Falta o verso do documento | | 610 | `resubmission_requested` | Documento encoberto | | 611 | `resubmission_requested` | Frente do documento encoberta | | 612 | `resubmission_requested` | Verso do documento encoberto | | 613 | `resubmission_requested` | O documento não aparece completo na imagem | | 614 | `resubmission_requested` | A frente do documento não aparece completa na imagem | | 615 | `resubmission_requested` | O verso do documento não aparece completo na imagem | | 616 | `resubmission_requested` | Documento coberto por reflexos | | 617 | `resubmission_requested` | Frente do documento coberta por reflexos | | 618 | `resubmission_requested` | Verso do documento coberto por reflexos | | 619 | `resubmission_requested` | Os dados do documento não estão visíveis | | 620 | `resubmission_requested` | Documento apresentado vencido | | 621 | `resubmission_requested` | Documento anulado ou danificado | | 622 | `resubmission_requested` | Documento anulado | | 623 | `resubmission_requested` | Documento apresentado danificado | | 624 | `resubmission_requested` | A imagem do rosto no documento não está visível | | 625 | `resubmission_requested` | Não foi possível obter os sobrenomes | | 626 | `resubmission_requested` | Não foi possível obter os nomes | | 627 | `resubmission_requested` | Não foi possível obter a data de nascimento | | 628 | `resubmission_requested` | Não foi possível obter a data de emissão | | 629 | `resubmission_requested` | Não foi possível obter a data de validade | | 630 | `resubmission_requested` | Não foi possível obter o gênero | | 631 | `resubmission_requested` | Não foi possível obter o número do documento | | 632 | `resubmission_requested` | Não foi possível obter o número pessoal | | 633 | `resubmission_requested` | Não foi possível obter a nacionalidade | | 634 | `resubmission_requested` | Não foi possível obter o endereço residencial | | 635 | `resubmission_requested` | Faltam o documento e a imagem do rosto | | 636 | `resubmission_requested` | O documento apresentado não é real: uso de tela | | 637 | `resubmission_requested` | O documento apresentado não é real: uso de cópia impressa | | 638 | `resubmission_requested` | Não foi possível obter o local de emissão | | 639 | `resubmission_requested` | Não foi possível obter a data da primeira emissão | | 640 | `resubmission_requested` | A pessoa não deu seu consentimento | | 641 | `resubmission_requested` | Vários rostos foram detectados | | 642 | `resubmission_requested` | Vários documentos foram enviados | | 643 | `declined` / `resubmission_requested` | Não foi possível recortar a imagem do rosto da frente do documento | | 644 | `resubmission_requested` | Não foi possível obter o Identificador de Cidadão (INE) | | 645 | `resubmission_requested` | Reenvio: não foi possível obter o OCR (IFE) | | 646 | `resubmission_requested` | Não foi possível estimar a idade | | 647 | `resubmission_requested` | O documento não é reconhecido | | 648 | `resubmission_requested` | Problemas técnicos | | 649 | `resubmission_requested` | Não foi possível obter as informações de estrangeiro | | 650 | `resubmission_requested` | Não foi possível obter o número do processo | | 651 | `resubmission_requested` | Não foi possível obter as informações de ocupação | | 652 | `resubmission_requested` | Não foi possível obter as informações do empregador | | 653 | `resubmission_requested` | Não foi possível obter o tipo de autorização de residência | | 654 | `resubmission_requested` | Não foi possível obter o número da carteira de motorista | | 655 | `declined` | Não foi possível obter o nome adicional | | 656 | `resubmission_requested` | Há várias pessoas presentes na sessão | | 657 | `resubmission_requested` | Falta a imagem do Passaporte aberto | | 658 | `resubmission_requested` | Não foi possível obter o número de eleitor (*Elector Number*) | | 659 | `resubmission_requested` | Não foi possível obter o identificador eleitoral | | 660 | `resubmission_requested` | Não foi possível obter o primeiro sobrenome | | 661 | `resubmission_requested` | Não foi possível obter o segundo sobrenome | | 662 | `resubmission_requested` | Não foi possível obter as observações do documento | | 663 | `resubmission_requested` | Não foi possível obter o local de nascimento | | 664 | `resubmission_requested` | Não foi possível obter a categoria B | | 665 | `resubmission_requested` | Não foi possível obter a data de emissão da categoria B | | 666 | `resubmission_requested` | Não foi possível obter a data de validade da categoria B | | 667 | `resubmission_requested` | Não foi possível obter a categoria AM | | 668 | `resubmission_requested` | Não foi possível obter a categoria A | | 669 | `resubmission_requested` | Não foi possível obter o número de emissão do documento | | 670 | `resubmission_requested` | Não foi possível obter a autoridade emissora do documento | | 671 | `resubmission_requested` | Não foi possível obter os nomes adicionais | | 672 | `resubmission_requested` | Não foi possível obter os dados do código de barras | | 673 | `resubmission_requested` | O rosto não está centralizado | | 674 | `resubmission_requested` | O rosto está coberto pelos óculos | | 675 | `resubmission_requested` | O rosto não está dentro dos limites de rotação | | 676 | `resubmission_requested` | Não foi possível recortar o rosto da imagem do rosto | | 677 | `resubmission_requested` | Iluminação desigual no rosto | | 678 | `resubmission_requested` | Rosto desfocado | | 679 | `resubmission_requested` | Não foi possível obter a cor do cabelo | | 680 | `resubmission_requested` | Não foi possível obter a cor dos olhos | | 681 | `resubmission_requested` | Não foi possível obter a altura | | 682 | `resubmission_requested` | Não foi possível obter o peso | | 683 | `resubmission_requested` | O tamanho do rosto está incorreto em relação à imagem | | 684 | `resubmission_requested` | Os olhos não estão suficientemente abertos | | 685 | `resubmission_requested` | Ruído digital excessivo na imagem | | 686 | `resubmission_requested` | O contraste da imagem está muito baixo | | 687 | `resubmission_requested` | Não foi possível obter a categoria da carteira de motorista | | 688 | `resubmission_requested` | O número do documento não corresponde ao número do documento informado ao iniciar a sessão | | 689 | `resubmission_requested` | O endereço do documento não corresponde ao endereço informado ao iniciar a sessão | | 690 | `resubmission_requested` | A data de nascimento do documento não corresponde à data de nascimento informada ao iniciar a sessão | | 691 | `resubmission_requested` | O número pessoal do documento não corresponde ao número pessoal informado ao iniciar a sessão | | 692 | `resubmission_requested` | O gênero do documento não corresponde ao gênero informado ao iniciar a sessão | | 693 | `resubmission_requested` | O nome do documento não coincide com o nome informado ao iniciar a sessão | | 694 | `resubmission_requested` | Não foi possível obter nenhum nome | | 695 | `resubmission_requested` | Não foi possível identificar o tipo de documento a partir do documento | | 696 | `resubmission_requested` | A ocupação do documento não corresponde à ocupação informada ao iniciar a sessão | | 697 | `resubmission_requested` | Não foi possível validar a assinatura do PDF | | 901 | `declined` | Erro do provedor de registro ao conectar-se ao registro | | 902 | `declined` | A pessoa não foi encontrada no registro | | 903 | `declined` | A verificação de parte das informações pessoais falhou | | 904 | `declined` | Documento reportado como perdido ou roubado | | 905 | `declined` | A sessão do provedor de identidade digital expirou | | 906 | `declined` | Nem todos os campos e documentos de identidade digital obrigatórios foram compartilhados | | 1001 | — | Erro de validação da solicitação: o identificador da consulta (*Query ID*) deve ter entre 20 e 40 caracteres. | | 1002 | — / `declined` | Erro de validação da solicitação: o identificador da consulta (*Query ID*) deve ser um UUID v4 válido. Em integrações com dPAD habilitado, indica um ataque de reprodução de tela (*Ataque de reprodução de tela*), sempre com status `declined`. Veja a observação sobre dPAD após esta tabela. | | 1003 | — / `declined` | Erro de validação da solicitação: o identificador da consulta (*Query ID*) deve ser único; já foi usado. Em integrações com dPAD habilitado, indica uma cópia impressa em preto e branco (*Ataque de cópia impressa em preto e branco*), sempre com status `declined`. Veja a observação sobre dPAD após esta tabela. | | 1005 | `declined` | Somente em integrações com dPAD habilitado: substituição da foto do documento (*Ataque de substituição da foto*). Veja a observação sobre dPAD após esta tabela. | | 1102 | — | Faltam parâmetros obrigatórios na solicitação. | | 1104 | — | A solicitação inclui parâmetros inválidos. | | 1201 | — | Carimbo de data/hora inválido: não deve ter mais de uma hora de antiguidade. | | 1202 | — | O formato do carimbo de data/hora está incorreto. Deve ser `YYYY-MM-DDTHH:MM:S` + diferença de fuso horário. | | 1203 | — | Data ISO 8601 inválida: a data deve ter o formato `YYYY-MM-DD`. | | 1301 | — | As funcionalidades solicitadas não são suportadas. | | 1302 | — | Somente URLs de retorno HTTPS são permitidas. | | 1303 | — | Estado inválido. | | 1304 | — | Não é possível a transição para o estado indicado (`$STATUS`). | | 1308 | — | Falta o número de identificação (*ID number*). | | 1309 | — | A validação do SSN requer `firstName` + `lastName` ou `fullName` da pessoa. | | 1310 | — | A validação do SSN requer `person.dateOfBirth` ou dados de endereço. | | 1400 | — | Não foram encontrados os dados da imagem. | | 1401 | — | A imagem não está em um base64 válido. | | 1402 | — | O contexto da imagem não é suportado. | | 1403 | — | Falta uma propriedade da imagem. | | 1500 | — | O campo `vendorData` não pode exceder 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 só pode conter os caracteres A-Z e 0-9. | | 2103 | — | O tipo de documento não é suportado. | | 2104 | — | O documento do país indicado não é suportado. | **Códigos com duplo significado (dPAD)** Em integrações com a detecção passiva de ataques de apresentação do documento (**dPAD**) habilitada, os códigos `1002`, `1003` e `1005` são emitidos quando o diagnóstico da validação é uma tentativa de falsificação (*spoof*), sempre com `verification.status` = `declined`: | Código | Significado com dPAD habilitado | | ------ | -------------------------------------------------------------------------------- | | `1002` | Ataque de reprodução de tela (*Ataque de reprodução de tela*). | | `1003` | Cópia impressa em preto e branco (*Ataque de cópia impressa em preto e branco*). | | `1005` | Substituição da foto do documento (*Ataque de substituição da foto*). | Em integrações **sem** dPAD, `1002` e `1003` conservam apenas seu significado de erro de validação da solicitação e `1005` não é emitido. #### Relação entre `reasonCode` e a decisão O campo `reasonCode` explica **por que** a decisão foi tomada, mas **não indica por si só qual foi a decisão**. A decisão é sempre determinada por `verification.status`: | `verification.status` | Significado | | ------------------------ | -------------------------------------------------------------------------------------------------------------- | | `declined` | Rejeição **definitivo**. O processo foi encerrado; o usuário não pode corrigir o resultado tentando novamente. | | `resubmission_requested` | Rejeição **recuperável**. Solicita-se ao usuário um novo envio corrigindo o problema indicado. | {% hint style="warning" %} Um **mesmo motivo** pode aparecer sob códigos diferentes de acordo com a decisão associada: existem pares equivalentes em que o código 5xx corresponde a `declined` e o código 6xx a `resubmission_requested`. Alguns exemplos: documento vencido (`511` / `620`), tipo de documento não suportado (`510` / `602`), falta a frente (`552` / `608`), falta o verso (`553` / `609`), dados do documento não visíveis (`557` / `619`), documento não reconhecido (`551` / `647`), sobrenomes não obtidos (`558` / `625`) ou data de validade não obtida (`562` / `629`). Portanto, **não deduza o resultado a partir do texto de `reason` nem do intervalo numérico do código**: sempre ramifique com base no valor exato de `verification.status`. {% endhint %} #### 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": "Requisição inválida", "detail": "Solicitação inválida.", "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "errors": [] } ``` #### `401` Não autorizado ```json { "message": "Não autorizado" } ``` #### `403` Proibido ```json { "Message": "O usuário não está autorizado a acessar este recurso com uma negação explícita" } ``` #### `502` Gateway inválido ```json { "status": 502, "title": "Gateway inválido", "detail": "O servidor recebeu uma resposta inválida.", "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502" } ``` #### `504` Timeout do Gateway ```json { "message": "A solicitação de Endpoint expirou" } ```