Skip to main content
POST
/
v1
/
users
Create a user
curl --request POST \
  --url https://prod.truv.com/v1/users/ \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>' \
  --data '
{
  "external_user_id": "12345",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "+14155554193",
  "ssn": "222233333"
}
'
{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "external_user_id": "12345",
  "created_at": "2022-05-04T11:30:00.000Z",
  "updated_at": "2022-05-04T12:00:00.000Z",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "+14155554193",
  "ssn": "222233333"
}

Authorizations

​
X-Access-Client-Id
string
header
required

Client ID

​
X-Access-Secret
string
header
required

Client Access Key

Body

application/json
​
external_user_id
string
required

External user id.

Example:

"12345"

​
first_name
string
required

First name of the user.

Example:

"John"

​
last_name
string
required

Last name of the user.

Example:

"Doe"

​
email
string<email>

User's email.

Example:

"john.doe@example.com"

​
phone
string

User's phone number.

Example:

"+14155554193"

​
ssn
string

User's SSN.

Example:

"222233333"

Response

​
id
string
required
read-only

Unique identifier of the user.

Maximum string length: 32
Example:

"24d7e80942ce4ad58a93f70ce4115f5c"

​
external_user_id
string | null
required

External user id.

Example:

"12345"

​
created_at
string<date-time>
required
read-only

Timestamp when the user was created.

Example:

"2022-05-04T11:30:00.000Z"

​
updated_at
string<date-time>
required
read-only

Timestamp when the user was updated last time.

Example:

"2022-05-04T12:00:00.000Z"

​
first_name
string

First name of the user.

Example:

"John"

​
last_name
string

Last name of the user.

Example:

"Doe"

​
email
string<email> | null

User's email.

Example:

"john.doe@example.com"

​
phone
string | null

User's phone number.

Example:

"+14155554193"

​
ssn
string

User's SSN.

Example:

"222233333"