Token Biometrico
Este artigo explica como utilizar a capacidade do IDToken para verificar a autenticidade de uma pessoa previamente cadastrada na base de dados do cliente. O IDToken permite identificar se a imagem de um rosto enviado corresponde a um rosto previamente registrado na base de dados do cliente utilizando o identificador do processo de referência para comparação. Pode ser utilizado em conjunto com a capacidade do IDLive.
Como usar?
Faça uma requisição POST para o endpoint:
Produção: https://api.id.unico.app/processes/v1
Homologação: https://api.id.uat.unico.app/processes/v1
Com o token de acesso válido, faça uma requisição para um dos endpoints acima enviando os seguintes parâmetros:
{
"referenteProcessId": "ID_DO_PROCESSO",
"imagebase64": "FOTO_PESSOA"
}
Caso estiver utilizando a combinação de capacidades IDToken + IDLive, será necessário enviar os seguintes parâmetros:
{
"subject": {
"code": "NUMERO_DO_DOCUMENTO_DA_PESSOA"
},
"referenceProcessId": "ID_DO_PROCESSO",
"imagebase64": "FOTO_PESSOA"
}
Parametros:
- HEADER PARAMETERS
Nome | Tipo | Mandatorio/Opcional | Descrição |
---|---|---|---|
APIKEY | String | Mandatório | API key |
Authorization | String | Mandatório | Token de acesso |
- REQUEST BODY SCHEMA
Nome | Tipo | Mandatorio/Opcional | Descrição |
---|---|---|---|
subject.code | String | Mandatório | Código do documento de identificação nacional (ex: CPF). |
referenceProcessId | String | Mandatório | Identificador do processo que foi gerado durante a criação da transação, cuja foto será usada para comparação. |
imagebase64 | String | Mandatório | Foto do pessoa. A imagem precisa ser em base64 (png, jpg, jpeg). Caso a captura da foto seja por meio do SDK da Unico com Liveness, a imagem enviada deve ser o Json Web Token (.jwt). O .JWT deve ser enviado em até 10 minutos evitando assim que a imagem expire. E esse .jwt só pode ser usado uma única vez. |
Exemplo de requisição:
{
"subject": {
"code": "1234568791"
},
"referenceProcessId": "D7A8B471-E69C-42B7-AF14-05E83365A944",
"imagebase64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}
Requisição com Sucesso
Se a requisição foi executada com sucesso, a resposta de retorno é um JSON contendo o status da verificação como a seguir:
{
"id": "D7A8B471-E69C-42B7-AF14-05E83365A944",
"authenticated": true,
"liveness": 1
}
- A propriedade authenticated é um valor booleano indicando se a foto enviada na requisição é a mesma pessoa que passou anteriormente no processo de referência (true - mesma pessoa / false - não é a mesma pessoa).
- A propriedade liveness é um valor inteiro indicando o resultado da validação da prova de vida (0 - Inconclusivo / 1 - Prova de vida passou / 2 - Prova de vida falhou).
Os exemplos acima consideram o uso do IDToken + IDLive. Caso utilize somente o IDToken, não há a necessidade de enviar o subject.code e também não receberá o retorno de liveness.
Erro na Requisição
Caso ocorra algum erro, a resposta de retorno é um JSON contendo o código e descrição do erro:
{
"Error": {
"code": "40004",
"description": "Descrição do erro"
}
}
Para mais infomações sobre os erros retornados, consulte a lista disponível no artigo Response Errors.
Dúvidas?
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.