Crie solicitações seguras de verificação de identidade via NFC a partir do seu próprio sistema. Convide usuários por e-mail ou SMS, ou envie você mesmo o link gerado. O usuário escaneia o chip NFC no aplicativo móvel e você obtém apenas os campos necessários para o seu processo.
O ID Scan foi desenvolvido para fornecedores de software e organizações que desejam incorporar a verificação de identidade sem precisarem criar por conta própria todo o fluxo de digitalização móvel.
Crie uma solicitação de digitalização a partir do seu backend. Adicione uma referência externa, idioma, prazo de validade, configurações de entrega, campos solicitados e verificações.
Deixe que o ID Scan envie o e-mail ou SMS, ou utilize seu próprio canal de comunicação com o link de verificação recebido.
O usuário abre o aplicativo móvel, escaneia a MRZ, lê o chip NFC e, opcionalmente, realiza uma verificação em tempo real por meio de uma selfie em comparação com a foto de rosto do DG2.
Recupere o status, as verificações, os campos solicitados e as informações de auditoria por meio da API. Apenas os campos configurados são retornados.
As chamadas de API são enviadas para a URL base da API do ID Scan e autenticadas por meio de uma chave de API gerada no portal do ID Scan. A chave de API é enviada por meio de um cabeçalho de solicitação dedicado e só deve ser usada no lado do servidor. Nunca exponha chaves de API no código front-end ou em aplicativos móveis.
Quando uma solicitação de digitalização é criada, a API retorna o ID da solicitação, a chave da solicitação, a data de validade e os links de verificação. Utilize o WebUrl retornado em seu próprio e-mail, SMS, portal ou fluxo de trabalho ao usar o envio direto. Em dispositivos móveis, o DeepLinkUrl permite abrir o aplicativo diretamente.
Você pode escolher como o usuário receberá a solicitação de verificação. Isso permite que o ID Scan se adapte tanto a fluxos de comunicação totalmente automatizados quanto a fluxos personalizados.
O ID Scan envia um e-mail de convite com a identidade da marca e um link de verificação seguro.
O ID Scan envia o link de verificação por SMS. Útil para fluxos de cadastro voltados para dispositivos móveis.
Seu sistema recebe o link e o envia por e-mail, SMS, portal ou fluxo de mensagens.
Uma solicitação de verificação passa por uma série de etapas. As integrações podem usar essas etapas para mostrar o andamento, enviar lembretes ou determinar se é necessária uma nova solicitação.
| Status | Descrição |
|---|---|
requested | The request has been created and is waiting for the user to start or complete the verification. |
completed | The user completed the flow. Use IsSuccess and the check fields to determine whether verification passed. |
expired | The request expired before the user completed the verification. |
deleted | The request was deleted and is no longer available for completion. |
failed | The request could not be completed successfully because of an error or failed verification step. |
Use uma referência externa para vincular uma solicitação de verificação ao seu próprio cliente, funcionário, dossiê, pedido ou registro de integração. A mesma referência é exibida quando você consulta os detalhes da solicitação.
Vincule a solicitação ao registro do seu próprio cliente.
Associe o resultado a um dossiê do Wwft, de RH ou de conformidade.
Use a referência para dar continuidade aos fluxos de trabalho automatizados após a conclusão da verificação.
O ID Scan apoia a minimização de dados. Configure exatamente quais campos devem ser enviados ao seu sistema. O usuário pode ser informado sobre quais dados serão compartilhados antes do envio.
| Campo | Descrição | Fonte |
|---|---|---|
surname | Surname / family name from the identity document. | NFC DG1 |
given_names | Given names from the identity document. | NFC DG1 |
date_of_birth | Date of birth. Can also be used for age checks. | NFC DG1 |
date_of_expiry | Document expiry date. | NFC DG1 |
document_number | Document number. Can be returned full or masked depending on template settings. | NFC DG1 |
document_type | Document type, such as passport or identity card. | NFC DG1 |
issuing_country | Country that issued the document. | NFC DG1 |
country_of_issue | Country of issue when available. | NFC DG1 |
nationality | Nationality from the identity document. | NFC DG1 |
gender | Gender marker from the document, if requested. | NFC DG1 |
photo | Portrait photo from the NFC chip. Only return when explicitly needed. | NFC DG2 |
mrz_masked_image | Masked MRZ image as proof of scan without exposing all MRZ data. | Camera/MRZ |
selfie_image | Live selfie image. Usually only included for manual review. | Camera/selfie |
É possível solicitar verificações como parte do fluxo de verificação. Algumas verificações são de natureza técnica relacionadas à tecnologia NFC, enquanto outras dizem respeito a regras comerciais, como a idade mínima ou a verificação por selfie.
| Verificar | Descrição | Resultado obtido |
|---|---|---|
nfc_read_success | Indicates whether the NFC chip was successfully read. | true / false |
chip_authentication_success | Indicates whether chip authentication or chip verification succeeded. | true / false |
document_not_expired | Checks if the document expiry date is in the future. | true / false |
minimum_age | Checks whether the person meets a configured minimum age without necessarily returning the date of birth. | { required, passed } |
sod_signature_valid | Checks the SOD signature when available. | true / false |
dg1_hash_valid | Checks whether DG1 data matches the signed document data. | true / false |
dg2_hash_valid | Checks whether the portrait photo data matches the signed document data. | true / false |
active_auth_ok | Optional active authentication result when supported by the document. | true / false / not available |
selfie_check | Optional live selfie verification matched against the DG2 portrait photo. | { requested, consent_given, passed, status, method } |
O endpoint de resultados retorna o status da solicitação, o status da verificação, a referência externa, os campos de identidade selecionados, as imagens selecionadas e os resultados da verificação. Os campos que não foram solicitados não são retornados.
Solicitados, concluídos, expirados, excluídos ou com falha, incluindo registros de data e hora de criação e conclusão.
Apenas dados de identificação configurados, como nome, nacionalidade, data de nascimento ou data de validade do documento.
Status de leitura NFC, autenticação do chip, validade do documento, verificação por selfie e dados opcionais em PDF/relatórios.
Campos de imagem, como a foto de rosto DG2, a imagem MRZ mascarada e a selfie, são retornados diretamente como dados codificados em Base64 quando solicitados. As imagens não são retornadas como URLs públicas.
Use o valor do dado como dados de imagem binários codificados em Base64.
Use o tipo de conteúdo, como image/jpeg, para reconstruir a imagem corretamente.
Os dados da imagem só são incluídos quando o campo é explicitamente solicitado no modelo.
O número do documento pode ser exibido na íntegra ou oculto. A ocultação ajuda a reduzir a exposição desnecessária dos números dos documentos, sem impedir a realização de verificações de correspondência ou de auditoria no seu próprio sistema.
| Valor | Opção | Descrição |
|---|---|---|
(empty) | No masking | Return the document number as read from the identity document. Only use when the full document number is required. |
last4_visible | Last 4 visible | Mask the document number and only return the last four characters, for example *****7P44. |
first4_visible | First 4 visible | Mask the document number and only return the first four characters. |
O exemplo abaixo cria uma solicitação de verificação, pede ao ID Scan para enviar o convite por e-mail e retorna apenas os campos e verificações selecionados.
Após a conclusão, seu sistema poderá recuperar o resultado por meio do ID da solicitação ou da chave da solicitação. A referência externa pode ser usada para conectar o resultado ao seu próprio sistema.
As configurações de retenção podem ser definidas por locatário. Os dados de verificação podem ser excluídos após um período determinado, após a leitura ou de acordo com a política de privacidade configurada. Isso ajuda a limitar o armazenamento desnecessário de dados confidenciais de identidade.
Excluir os dados de verificação após um número de dias definido.
Marcar os dados como lidos assim que forem recuperados e programar a exclusão a partir desse momento.
Utilize configurações de retenção distintas para os fluxos de trabalho do portal e da API, quando necessário.
Além de criar e recuperar solicitações, as integrações podem reenviar convites ou excluir uma solicitação. A exclusão de uma solicitação pode ser utilizada quando um fluxo de trabalho é cancelado ou quando uma verificação não é mais necessária.
POST /api/scan-requests/{id}/resend
DELETE /api/scan-requests/{id}
GET /api/scan-requests/{id}/details
O modo de teste pode ser usado para validar todo o fluxo de integração antes da entrada em operação. As solicitações de teste são marcadas com “IsTest” na resposta da API, para que seu sistema possa separar os dados de teste dos fluxos de trabalho de produção.
Valide a criação de solicitações, a entrega, a verificação de aplicativos e a recuperação de resultados sem utilizar fluxos de trabalho de produção.
A resposta à solicitação de criação contém o campo IsTest, o que facilita a identificação das solicitações de teste.
Comece com uma chave de API de teste ou uma configuração de locatário de teste e mude para a verificação em produção após a validação.
Nem todas as solicitações resultam em uma verificação bem-sucedida. O usuário pode interromper o fluxo, a solicitação pode expirar ou a leitura NFC pode falhar. Use os campos Status, HasResult, IsSuccess e os campos de verificação para determinar o resultado final.
Crie uma conta gratuita, gere uma chave de API e teste todo o fluxo antes de colocar em produção.