v4

OpenAPI 3.0.12026-07-3189233676.2 KB

Users

Create a user

The endpoint creates a user.

post/v1/users/

Request body

external_user_idstring required

External user id.

first_namestring required

First name of the user.

last_namestring required

Last name of the user.

emailstring email

User's email.

phonestring

User's phone number. Accepted formats are normalized and stored as E.164 (+14155554193).

ssnstring

User's SSN — the full 9 digits or the last 4 digits. Dashes and spaces are accepted on input and stripped before storing. Returned masked in responses.

Example request

{
  "external_user_id": "12345",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "+14155554193",
  "ssn": "222233333"
}

Response

idstring required

Unique identifier of the user.

external_user_idstring nullable required

External user id.

first_namestring nullable

First name of the user.

last_namestring nullable

Last name of the user.

emailstring email nullable

User's email.

phonestring nullable

User's phone number in E.164 format (+ followed by the country code and number).

ssnstring nullable

User's SSN, masked. Only the last 4 digits are visible — the leading digits are replaced with * (for example *****3333). When only the last 4 digits are on file, the value is fully masked (****).

created_atstring date-time required

Timestamp when the user was created.

updated_atstring date-time required

Timestamp when the user was updated last time.

Example response

{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "external_user_id": "12345",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "+14155554193",
  "ssn": "*****3333",
  "created_at": "2022-05-04T11:30:00Z",
  "updated_at": "2022-05-04T12:00:00Z"
}