Nesta seção, você encontrará as particularidades de criar um processo que tenha a Validação (1:1) como capacidade
Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.
Você pode ver mais sobre como gerar um access-token aqui.
Produção: https://api.id.unico.app/processes/v1.
Note que para a utilização da capacidade de Validação (1:1):
Na criação do processo, são obrigatórios subject.code
, referenteProcessId
e imageBase64
;
No response do processo, devolvemos o id
, authenticated
(resultado da Validação 1:1) e liveness
(resultado da Prova de vida).
Para este caso de uso, não há a necessidade de realizar o GetProcess, visto que a resposta é síncrona.
O endpoint acima considera o uso da capacidade Validação (1:1) em conjunto com a capacidade Prova de vida.
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.
Nesta seção, você encontrará as particularidades de criar um processo que tenha somente a Prova de vida como capacidade
Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.
Você pode ver mais sobre como gerar um access-token aqui.
Produção: https://api.id.unico.app/processes/v1.
Note que para utilizar a Prova de vida de forma isolada:
Na criação do processo, somente o subject.code
e imageBase64
são obrigatórios;
No response do processo, só devolvemos os parâmetros id
, status
e liveness
(resultado da Prova de vida).
Para este caso de uso, não há a necessidade de realizar o GetProcess, visto que a resposta é síncrona.
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.
Nesta seção, você encontrará as particularidades de criar um processo que tenha a Verificação de Identidade como capacidade, bem como seus complementos
Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.
Você pode ver mais sobre como gerar um access-token aqui.
Produção: https://api.id.unico.app/processes/v1.
Note que para a utilização da capacidade de Verificação de Identidade:
Na criação do processo, são obrigatórios subject.code
, subject.name
e imageBase64;
No response do processo, as respostas das capacidades podem vir em tempos diferentes, visto que o IDCloud possui Capacidades síncronas e assíncronas. Em função disso, deve-se implementar o método GetProcess a depender da combinação destas capacidades.
A capacidade de Verificação de Identidade pode ser combinada com outras capacidades, como Score de risco ou Detecção de Perfil Fraudador. Para encontrar mais informações das respostas possíveis, veja as seções Cenários de response e Especificação de Parâmetros.
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.
Nesta seção, você encontrará as particularidades de criar um processo que tenha a Captura de documentos como capacidade
Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.
Você pode ver mais sobre como gerar um access-token aqui.
Produção: https://api.id.unico.app/processes/v1.
Note que para a utilização da capacidade de Captura de documentos:
Na criação do processo, são obrigatórios subject.code
, subject.name
, document.Purpose
, document.files.documentId
ou document.files.data
e imageBase64;
O valor do parâmetro document.documenId
só será informado na requisição caso tenha encontrado um ID de documento na API "GetReusableDocuments".
Caso não tenha encontrado nenhum ID de documento na API "GetReusableDocuments", você deve enviar o base64 do documento capturado como um valor do parâmetro document.files.data
No response do processo, devolvemos o id
, status
e o document.id
. A resposta da capacidade é sempre assíncrona, portanto deve-se implementar o método GetProcess.
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.
Nesta seção, você encontrará como criar um processo no by Client através da API REST
Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.
Você pode ver mais sobre como gerar um access-token aqui.
Produção: https://api.id.unico.app/processes/v1.
Os parâmetros acima são os da utilização mais comum da API, mas podem sofrer alterações a depender das capacidades que estiver utilizando. Confira nas subseções desta seção as possibilidades de capacidades e suas diferenças.
3
,4
,5
). Para validar a reposta das capacidades IDCloud, só considere o status
= 3
para sua tomada de decisão. Veja mais sobre os possíveis status na seção Especificação de parâmetros.A API by Client não recusa as fotos (ou seja, não há drop). Os retornos existentes são da capacidade Verificação de Identidade e sempre serão: yes
, no
ou inconclusive
. Sendo assim, os casos de má qualidade na captura da imagem, prova de vida ou não titularidade, o retorno é inconclusive
. O retorno é um yes
quando é possível identificar uma pessoa ao vivo e que seja a real titular do CPF.
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.
code | message | Descrição |
---|---|---|
code | message | Descrição |
---|---|---|
code | message | Descrição |
---|---|---|
20900
O base64 informado não é válido.
O parâmetro base64 é inválido. Possíveis causas: Não é uma imagem ou é uma tentativa de injection.
20807
A imagem precisa estar no padrão HD ou possuir uma resolução superior a 640 x 480.
A resolução da imagem enviada é muito pequena.
20507
O parâmetro subject.code é inválido.
CPF fora do padrão ou inexistente.
20506
O base64 informado é muito grande. O tamanho máximo suportado é até 800kb.
Quando o e-mail informado não é vA imagem é muito grande. A imagem pode ser comprimida para JPEG92 sem perda de qualidade.
20505
O base64 informado não é suportado. Os formatos aceitos são png, jpeg e webp.
Quando o telefone informado não é válBase64 inválido. Possíveis causas: não é uma imagem válida ou prefixo inválido.
20009
O parâmetro imagebase64 não foi informado.
Falta o parâmetro imagebase64, que contém a selfie da pessoa.
20006
O parâmetro subject.name não foi informado.
Falta o parâmetro subject.name, que contém o nome da pessoa.
20005
O parâmetro subject.code não foi informado.
Falta o parâmetro subject.code, que contém o cpf da pessoa.
20004
O parâmetro subject não foi informado.
Falta o parâmetro subject, que contém os dados da pessoa (cpf, nome).
20003
The request body is missing or invalid.
Payload nulo ou inválido.
20002
O parâmetro APIKey não foi informado.
Falta o parâmetro APIKEY no cabeçalho da requisição.
20001
O parâmetro authtoken não foi informado
Falta o parâmetro do token de integração no cabeçalho da requisição.
10508
The JWT with the captured face has already been used.
O .jwt só pode ser usado uma única vez.
10507
The JWT with the captured face is expired.
JWT expirado. O .jwt deve ser enviado em até 10 minutos.
10506
The bundle is invalid.
Bundle inválido. APIKEY usa um método de segurança e esta solicitação não atende aos requisitos de segurança (SDK).
30017
Jwt header is an invalid JSON.
Quando o access-token utilizado contém caracteres errados.
10502
O token informado está expirado.
Quando o access-token utilizado expirou
10501
O token informado é inválido.
O token de autenticação é inválido.
10201
O AppKey informado é inválido.
O parâmetro APIKEY não foi informado ou não existe.
99999
Internal failure! Try again later
Quando há algum erro interno.
Endpoint para criar um novo processo de validação 1:1 no by Client.
Access-token válido.
APIKEY válida com a capacidade validação 1:1.
CPF do usuário.
"12345678909"
Identificador do processo que foi gerado durante a criação da transação biométrica, cuja foto será usada para comparação.
"80371b2a-3ac7-432e-866d-57fe37896ac6"
Encrypted gerado pelo SDK.
"/9j/4AAQSkZJR..."
Processo criado com sucesso (Usuário autenticado).
ID do processo.
"80371b2a-3ac7-432e-866d-57fe37896ac6"
Resultado da autenticação.
true
Resultado da prova de vida.
1
Endpoint para criar um novo processo de prova de vida no by Client.
Access-token válido.
APIKEY válida com a capacidade prova de vida.
CPF do usuário.
"12345678909"
Nome do usuário.
"Luke Skywalker"
Encrypted gerado pelo SDK.
"/9j/4AAQSkZJR..."
Processo criado com sucesso (Usuário ao vivo).
ID do processo.
"80371b2a-3ac7-432e-866d-57fe37896ac6"
Status do processo.
3
Resultado da prova de vida.
1
Endpoint para criar um novo processo de documentos no by Client.
Access-token válido.
APIKEY válida com a capacidade de captura e reaproveitamento de documentos.
CPF do usuário.
"12345678909"
Nome do usuário.
"Luke Skywalker"
E-mail do usuário.
"luke@unico.io"
Telefone do usuário.
"551972557070"
Informações sobre o documento que será capturado.
Indica o propósito do compartilhamento do documento. Pode receber os valores: creditprocess, carpurchase, paybypaycheck, onboarding ou fgts
ID do processo de biometria que deve ter sido realizado anteriormente. O ID deve ser de um processo concluído com uma biometria válida.
"80371b2a-3ac7-432e-866d-57fe37896ac6"
É o identificador do documento para ser reaproveitado. Você o encontrará ao utilizar a API GetReusableDocuments. Caso não encontre um documento para ser reaproveitado, deve-se capturar o documento e enviar o base64 no parâmetro data.files.
"80371b2a-3ac7-432e-866d-57fe37896ac6"
Base64 do documento do usuário caso não encontre um para ser reaproveitado na API GetReusableDocuments. O array pode conter 1 arquivo (ex: CNH inteira) ou 2 arquivos (ex: CNH frente e CNH verso)
Imagem do documento codificada em base64.
"/9j/4AAQSkZJR..."
Base64 da selfie do usuário.
"/9j/4AAQSkZJR..."
Processo de documento criado com sucesso.
ID do processo.
"80371b2a-3ac7-432e-866d-57fe37896ac6"
Status do processo.
3
ID do documento que foi criado.
"80371b2a-3ac7-432e-866d-57fe37896ac6"
Endpoint para criar um novo processo de verificação de identidade no by Client.
Access-token válido.
APIKEY válida com as capacidades que irá utilizar.
CPF do usuário.
"12345678909"
Nome do usuário.
"Luke Skywalker"
E-mail do usuário.
"luke@unico.io"
Telefone do usuário.
"551972557070"
Caso de uso da operação.
"Onboarding"
Encrypted gerado pelo SDK ou base64.
"/9j/4AAQSkZJR..."
Processo criado com sucesso (SIM da Verificação de Identidade).
ID do processo.
"80371b2a-3ac7-432e-866d-57fe37896ac6"
Status do processo.
3
Resultado da verificação de identidade.
"yes"
Endpoint para criar um novo processo de verificação de identidade no by Client.
Access-token válido.
APIKEY válida com as capacidades que irá utilizar.
CPF do usuário.
"12345678909"
Nome do usuário.
"Luke Skywalker"
E-mail do usuário.
"luke@unico.io"
Telefone do usuário.
"551972557070"
Caso de uso da operação.
"Onboarding"
Encrypted gerado pelo SDK ou base64.
"/9j/4AAQSkZJR..."
Processo criado com sucesso (INCONCLUSIVO da Verificação de Identidade).
ID do processo.
"80371b2a-3ac7-432e-866d-57fe37896ac6"
Status do processo.
2
Resultado da verificação de identidade.
"inconclusive"