Skip to main content
POST
/
v1
/
users
Invite User
curl --request POST \
  --url https://api.truthlocks.com/v1/users \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "jsmith@example.com",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>"
}
'
{
  "id": "990e8400-e29b-41d4-a716-446655440000",
  "org_id": "440e8400-e29b-41d4-a716-446655440000",
  "email": "newuser@example.com",
  "name": "John Doe",
  "status": "INVITED",
  "created_at": "2026-01-13T12:00:00Z"
}
Invites a new user to the organization. The user will receive an email with instructions to complete setup.

​
Parameters

​
email
email
required
Email address to invite
​
name
string
Full name of the user
​
role_id
uuid
required
Role to assign to the user

​
Responses

{
  "id": "990e8400-e29b-41d4-a716-446655440000",
  "org_id": "440e8400-e29b-41d4-a716-446655440000",
  "email": "newuser@example.com",
  "name": "John Doe",
  "status": "INVITED",
  "created_at": "2026-01-13T12:00:00Z"
}

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
​
email
string<email>
required
​
role_id
string<uuid>
required
​
name
string

Response

201 - application/json

User invited

​
id
string<uuid>
​
org_id
string<uuid>
​
email
string<email>
​
name
string
​
status
enum<string>
Available options:
ACTIVE,
INVITED,
SUSPENDED
​
created_at
string<date-time>