Skip to main content
POST
/
v1
/
consumer
/
signup
Consumer Signup
curl --request POST \
  --url https://api.truthlocks.com/v1/consumer/signup \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "jsmith@example.com",
  "password": "<string>",
  "name": "<string>",
  "signup_type": "<string>",
  "company_name": "<string>"
}
'
{
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_token": "<string>"
}
Register a new consumer (B2C) account. Creates a personal tenant, organization, and user. The company_name field is optional — if omitted, it defaults to the user’s name + ‘s Workspace’. After signup, an email verification link is sent. Pending inbox deliveries (credentials minted before signup) are automatically claimed.

​
Parameters

​
email
string
required
Consumer’s email address
​
password
string
required
Password (minimum 10 characters)
​
name
string
Full name. Defaults to email prefix if omitted.
​
company_name
string
Organization name. Defaults to ‘Name’s Workspace’ or ‘Personal’.
​
country_code
string
ISO 3166-1 alpha-2 country code for region assignment.

​
Responses

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
​
email
string<email>
required
​
password
string<password>
required
​
name
string
required
​
signup_type
string

Set to 'tenant' for console signups

​
company_name
string

Response

201 - application/json

Account created

​
user_id
string<uuid>
​
tenant_id
string<uuid>
​
session_token
string