Skip to main content
GET
/
v1
/
consumer
/
me
Get consumer profile
curl --request GET \
  --url https://api.truthlocks.com/v1/consumer/me \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "tenant_id": "<string>",
  "email": "<string>",
  "name": "<string>",
  "username": "<string>",
  "mfa_enabled": true,
  "roles": [
    "<string>"
  ],
  "permissions": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Get profile

GET/v1/consumer/me
Returns the authenticated consumer’s profile, including display name, email, MFA status, roles, and permissions. Use this endpoint to populate profile pages or check the current user’s access level.

​
Parameters

No parameters required. The user is identified from the authentication token.

​
Responses

​
Update profile

PUT/v1/consumer/me
Update the authenticated consumer’s display name, region, or language preference. All fields are optional — only non-empty values are applied.

​
Parameters

​
name
string
Display name shown on your profile and public portfolio.
​
region_code
string
ISO 3166-1 alpha-2 region code (e.g. US, GB, DE). Controls data residency preferences.
​
language
string
Preferred language code (e.g. en, es, fr). Stored in your tenant settings.

​
Responses

​
Claim username

PUT/v1/consumer/me/username
Claim a globally unique username for your account. Once claimed, your public portfolio is available at verify.truthlocks.com/portfolio/{username}. Usernames must be 3–30 characters long. Choose a lowercase alphanumeric name, optionally with hyphens or underscores.

​
Parameters

​
username
string
required
The username to claim. Must be unique, 3–30 characters, lowercase alphanumeric with optional hyphens or underscores.

​
Responses

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Response

Consumer profile

​
id
string
​
tenant_id
string
​
email
string
​
name
string
​
username
string
​
mfa_enabled
boolean
​
roles
string[]
​
permissions
string[]