Especificação de parâmetros

subject.code

string

Obrigatório

CPF válido do usuário.

subject.name

string

Obrigatório

Nome do usuário.

subject.email

string

Opcional

E-mail do usuário.

subject.phone

string

Opcional

Telefone do usuário. Ex.: 551190000-0000

useCase

string

Opcional

É o caso de uso da operação de biometria. Ex: "Abertura de conta".

imagebase64

string

Obrigatório

É a selfie do usuário. A imagem precisa ser em base64 (png, jpg, jpeg).

Caso utilize a Prova de vida com a SDK da Unico, deve-se enviar o arquivo encrypted. O encrypted deve ser enviado em até 10 minutos evitando que a imagem expire. E esse .jwt só pode ser usado uma única vez.

referenceProcessId

string

Obrigatório

Identificador do processo que foi gerado durante a criação da transação biométrica, cuja foto será usada para comparação.

Este parâmetro é obrigatório somente ao utilizar a capacidade Validação (1:1).

id

O identificador do processo.

status

string

Indica o status do processo. Pode receber os valores:

• 1: Indica que o processo está em processamento. Pode ter uma ou mais capacidades que ainda não foram concluídas;

• 2: Indica que o processo está em divergência (só ocorre quando há a utilização da capacidade Score de risco);

• 3: Indica que o processo foi concluído. Todas as capacidades associadas ao processo tiveram seu processamento concluído.

• 4: Indica que o processo foi cancelado. Ocorre quando a requisição é cancelada pelo cliente (ex: timeout) antes de ser devidamente processada;

• 5: Indica que houve algum erro no processamento. É recomendado que seja feito ao menos 3 novas tentativas e caso o erro persista, derivar para um fluxo de contingência e nos acionar nos canais de suporte.

Para o desenvolvimento correto da sua regra de negócio, só valide os resultados das capacidades IDCloud quando o status = 3.

unicoId.result

string

Indica o resultado da capacidade Verificação de Identidade. Pode receber os valores:

• yes: Indica que a face é a do real titular do CPF.

• no: Indica que a face não é a do real titular. Caso receba esta resposta, não haverá a orquestração com a capacidade Score de risco, independentemente que a APIKey esteja configurada com ambas as capacidades.

• inconclusive: Indica que não foi possível determinar se a face é a do real titular do CPF. Caso haja orquestração com o Score de risco, devolveremos um score de probabilidade de risco no parâmetro score.

liveness

integer

Indica o resultado da capacidade Prova de vida.

Pode receber os valores:

• 1: Indica que o usuário o usuário estava ao vivo no momento da captura da selfie;

• 2: Indica que o usuário não estava ao vivo no momento da captura da selfie.

Caso utilize a solução sem a Prova de vida, o retorno sempre será 1.

score

integer

Indica o resultado da capacidade Score de risco. Pode receber valores entre -90 e +95.

O score só irá retornar no response da API caso a APIKey esteja devidamente configurada com a capacidade E a resposta da capacidade Verificação de Identidade tenha sido inconclusive.

identityFraudsters.result

string

Indica o resultado da capacidade Detecção de Perfil Fraudador. Pode receber os valores:

• sim: Indica que o usuário já esteve envolvido em transações fraudulentas de identidade;

• inconclusive: Indica que não foi possível encontrar transações fraudulentas associadas a esse usuário.

Caso seja utilizada em conjunto com o Score de risco, a resposta sim fará com que o cadastro não seja derivado para o score.

authenticated

boolean

É o resultado da autenticação ao utilizar a capacidade Validação (1:1). Pode ser true ou false.

government.serpro

integer

Indica o resultado do score de similaridade da serpro.

processAdditionalInfo.transactionId

string

Indica o ID da transação do processo criado. Este ID está relacionado à selfie do usuário e não é o mesmo ID do processo (primeiro item relacionado neste descritivo).

processAdditionalInfo.personName

string

Indica o nome do usuário do processo criado.

processAdditionalInfo.personDocument

string

Indica o documento de identificação do usuário do processo criado.

processAdditionalInfo.personImage

string

Indica a imagem do usuário do processo criado.

processAdditionalInfo.finishedAt

string

Indica a data e hora do término do processo criado.

id

string

Indica o ID do processo criado com o envio da foto.

status

integer

Indica o status do processo. Pode receber os valores:

• 1: Indica que o processo está em processamento;

• 3: Indica que o processo foi concluído;

• 4: Indica que o processo foi cancelado. Ocorre quando a requisição é cancelada pelo cliente (ex: timeout) antes de ser devidamente processada;

• 5: Indica que houve algum erro no processamento. É recomendado que seja feito ao menos 3 novas tentativas e caso o erro persista, derivar para um fluxo de contingência e nos acionar nos canais de suporte.

Para o desenvolvimento correto da sua regra de negócio, só valide os resultados das capacidades IDCloud quando o status = 3.

document.id

string

Indica o ID do documento criado.

document.type

string

Indica o tipo do documento retornado pela tipificação.

document.cpfMatch

string

Retorna se o CPF informado é igual ao contido no documento. Caso o CPF enviado seja inválido (exemplo: 123.456.789.12) esse campo é devolvido como falso automaticamente antes da comparação.

document.content

list

Lista de informações contidas no documento. Ela será devolvida sempre que a qualidade do documento permitir a extração de dados. O conteúdo retornado no document.content vai variar de acordo com o parâmetro document.type. **Mais detalhes na próxima tabela.

document.fileUrls

integer

Urls assinadas dos arquivos que compõem o documento. Para ter acesso às imagens do documento é só acessar essas urls que tem um tempo de expiração de 10 minutos.

items.documentType

string

Tipo do documento encontrado.

items.documentId

string

ID do documento encontrado. Para reutilizar, deve-se usar esse id na chamada de Create Process.