CreateProcess

Nesta seção, você encontrará como criar um processo no by Client através da API REST

---

Antes de começar

---

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.

Endpoints:

• UAT: https://api.id.uat.unico.app/processes/v1;

• Produção: https://api.id.unico.app/processes/v1.

---

CreateProcess

Endpoint para criar um novo processo de verificação de identidade no by Client.

POSThttps://api.id.uat.unico.app/processes/v1/

Header parameters

Body

application/json

subject*object

useCase*string

Caso de uso da operação.

Example: "Onboarding"

imageBase64*string

Encrypted gerado pelo SDK ou base64.

Example: "/9j/4AAQSkZJR..."

Response

200400500

Processo criado com sucesso (SIM da Verificação de Identidade).

Body

application/json

idstring

ID do processo.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

statusinteger

Status do processo.

Example: 3

unicoIdobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.id.uat.unico.app/processes/v1/', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "APIKEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subject": {
        "code": "12345678909",
        "name": "Luke Skywalker"
      },
      "useCase": "Onboarding",
      "imageBase64": "/9j/4AAQSkZJR..."
    }),
});
const data = await response.json();

Response

200400500

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "yes"
  }
}

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.

Para implementar suas regras de negócio, sempre valide os status finais dos processos (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.

Responses de erro

---

400 Bad Request

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).

403 Forbidden

code	message	Descrição
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.

500 Internal Server Error

code	message	Descrição
99999	Internal failure! Try again later	Quando há algum erro interno.

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.

---

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.