Criar identidade

O processo de criação de identidade é necessário para habilitar a autenticação de um determinado usuário. Tentativas subsequentes de autenticação para esse usuário serão comparadas com essa identidade criada, com base no personId, enquanto os dados de contexto do usuário são armazenados. É necessária uma selfie nítida, usada para validação facial.

E-mail e telefone são opcionais para a API, mas obrigatórios se você pretende permitir OTPs como forma de reautenticar este usuário. Nesse caso, além de habilitar e-mail ou SMS na política de autenticação, os usuários devem ter um e-mail e um número de telefone cadastrados.

Todas as chamadas à API são autenticadas e devem ter o token ao lado do Bearer prefixo no Authorization cabeçalho da requisição. Chamadas com um token de acesso ausente ou inválido retornarão o código de status 401 ("Não autorizado").

O token usado para fazer solicitações à API é o token de acesso gerado de acordo com estas instruções..

Create Identity of new users

post

Create Identity of new users.

Parâmetros de cabeçalho

AuthorizationstringObrigatório

Identity Authorization Token

Example: Bearer your_token_here

Corpo

namestringObrigatório

The name of the user who will be authenticated.

Example: First Middle Last

personIdstringObrigatório

Unique identifier for the user (can be non-numeric). Allowed: letters, numbers, and @ . _ - (no spaces), 5-254 chars. If only numbers and . - /, these are removed and treated as a document mask.

Example: 952.360.980-76

imageUrlstringObrigatório

The url of the selfie of the user who will be authenticated.

Example: https://imageurlink.jpeg

emailstringOpcional

The email of the user who will be authenticated.

Example: [email protected]

phonestringOpcional

The phone number of the user who will be authenticated. You must inform phone with country and region code. (country code + region code + phone)

Example: 5521982895497

Respostas

200

Success

application/json

requestIdstringObrigatório

Unique identifier of request.

Example: xxxxx-cecd-4643-95c7-xxxxx

messageIdstringOpcional

Unique identifier for the identity creation message in the processing queue.

Example: xxxxx-abcd-8765-7c95-xxxxx

messagestringOpcional

Success message

Example: Identity creation queued

personIdstringOpcional

The personId as provided in the request, returned sanitized and processed if necessary. This is the identifier used for future lookups.

Example: 95236098076

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/identities

POST /identities HTTP/1.1
Host: api.identity.combateafraude.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "name": "First Middle Last",
  "personId": "952.360.980-76",
  "imageUrl": "https://imageurlink.jpeg",
  "email": "[email protected]",
  "phone": 5521982895497
}

{
  "requestId": "xxxxx-cecd-4643-95c7-xxxxx",
  "messageId": "xxxxx-abcd-8765-7c95-xxxxx",
  "message": "Identity creation queued",
  "personId": "95236098076"
}

Atualizado há 1 ano