Transacional

URL Base:

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

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

Criar Processo Transacional

post

Endpoint para criar um novo processo Transacional no by Client.

Parâmetros de cabeçalho

AuthorizationstringObrigatório

Access-token válido.

APIKEYstringObrigatório

APIKEY válida com as capacidades para uso do Transacional.

Corpo

application/json

referenceProcessIdstringObrigatório

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

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

useCasestringOpcional

Caso de uso da operação.

Example: Onboarding

subsidiaryIdstringOpcional

o ID da filial onde o processo será criado. Caso haja somente uma filial associada a conta de serviço, não há a necessidade de passar este parâmetro. Caso haja separação de processos por filial, você receberá os IDs das filiais do time Unico.

Example: 35d734c4-7fbb-4b2f-a1dc-7e1575514819

imageBase64stringObrigatório

Arquivo encrypted gerado pelo SDK ou base64 (caso não utilize a Prova de vida).

Example: /9j/4AAQSkZJR...

Respostas

200

Processo criado com sucesso (Usuário autenticado).

application/json

idstringOpcional

ID do processo.

Example: fda9bdb4-00cd-4ddb-bfea-d8cfe78eaa34

statusinteger · enumOpcional

Status do processo. Valores possíveis: '3' - Concluído; '5' - Erro.

Example: 3Valores possíveis:

livenessinteger · enumOpcional

Resultado da prova de vida. Valores possíveis: '1' - Prova de vida aprovada; '2' - Prova de vida recusada.

Example: 1Valores possíveis:

400

Bad Request.

application/json

403

Forbidden.

application/json

500

Internal Server Error.

application/json

post

/processes/v1

HTTPcURLJavaScriptPython

POST /processes/v1 HTTP/1.1
Host: api.id.uat.unico.app
Authorization: text
APIKEY: text
Content-Type: application/json
Accept: */*
Content-Length: 313

{
  "subject": {
    "code": "12345678909",
    "name": "Luke Skywalker",
    "gender": "M",
    "birthDate": "2000-05-20",
    "email": "[email protected]",
    "phone": "551972557070"
  },
  "referenceProcessId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "useCase": "Onboarding",
  "subsidiaryId": "35d734c4-7fbb-4b2f-a1dc-7e1575514819",
  "imageBase64": "/9j/4AAQSkZJR..."
}

{
  "id": "fda9bdb4-00cd-4ddb-bfea-d8cfe78eaa34",
  "status": 3,
  "unicoId": {
    "result": "yes"
  },
  "identityFraudsters": {
    "result": "yes"
  },
  "biometryToken": {
    "result": "true"
  },
  "liveness": 1
}

Pontos Importantes:

• Para utilizar a capacidade Prova de vida, é indispensável o uso dos nossos SDKs:

  • É possível utilizar a capacidade de Validação (1:1) sem a Prova de vida. Para este caso de uso, não devolveremos o parâmetro liveness no response da API. Neste cenário não há nenhuma validação da prova de vida, nem mesmo passiva;

  • Ao utilizar a Validação (1:1) com outras capacidades, é necessário sempre considerar os retornos separadamente.

• Para este caso de uso, não é possível orquestrar com Score de risco;

• Caso utilize processos de referência do by Unico, o valor que deve ser utilizado como referenceProcessId deve ser referente ao parâmetro authenticationInfo.authenticationId.

• Caso ocorra algum erro no processamento, o processo retornará um status = 5, como no exemplo abaixo:

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

Erros

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.	A 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.	Base64 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

500 Internal Server Error