Create identity

The identity creation process is necessary to enable authentication for a given user. Subsequent authentication attempts for this user will be compared against this created identity, based on the personId, while storing the user's context data. A clear selfie is required, used for facial validation.

Email and phone are optional for the API, but required if you intend to allow OTPs as a means of re-authenticating this user. In this case, in addition to enabling email or SMS in the authentication policy, users must have an email and phone number registered.

All calls to the API are authenticated and must have the token next to Bearer prefix in the Authorization header of the request. Calls with a missing or invalid access token will return status code 401 ("Unauthorized").

The token used to make requests to the API is the access token generated according to these instructions..

Create Identity of new users

post

Create Identity of new users.

Header parameters

AuthorizationstringRequired

Identity Authorization Token

Example: Bearer your_token_here

Body

application/json

namestringRequired

The name of the user who will be authenticated.

Example: First Middle Last

personIdstringRequired

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

imageUrlstringRequired

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

Example: https://imageurlink.jpeg

emailstringOptional

The email of the user who will be authenticated.

Example: [email protected]

phonestringOptional

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

Responses

200

Success

application/json

requestIdstringRequired

Unique identifier of request.

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

messageIdstringOptional

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

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

messagestringOptional

Success message

Example: Identity creation queued

personIdstringOptional

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

HTTPcURLJavaScriptPython

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"
}