Onboarding
Onboarding Options
The profiles your instance onboards under and the provider each one uses
GET
/
customers
/
api
/
onboarding
/
options
curl "https://api.trusset.org/customers/api/onboarding/options" \
-H "X-API-Key: trusset_your_key_here"
const response = await fetch('https://api.trusset.org/customers/api/onboarding/options', {
headers: { 'X-API-Key': 'trusset_your_key_here' }
});
const { data } = await response.json();
const professional = data.profiles.find((profile) => profile.key === 'PROFESSIONAL');
{
"success": true,
"data": {
"profiles": [
{
"key": "PROFESSIONAL",
"name": "Professional",
"description": "Professional investor",
"entityType": "INDIVIDUAL",
"professionalOnly": true,
"onChainInvestorType": 2,
"blockedCountries": [],
"reverifyDays": null,
"requiredFields": [
{ "id": "identity", "label": "Government ID", "types": ["PASSPORT", "ID_CARD", "DRIVERS"], "required": true, "idDocSetType": "IDENTITY" },
{ "id": "selfie", "label": "Selfie / liveness", "types": ["SELFIE"], "required": true, "idDocSetType": "SELFIE" }
],
"defaultProvider": "KYC_SOURCE",
"providers": {
"TRUSSET": { "available": true, "levelName": "basic-kyc-level" },
"KYC_SOURCE": {
"available": true,
"sources": [{ "id": "cmwgx2jnn003diinmv99ki3kh", "name": "Hanse Haftungsdach", "status": "ACTIVE" }]
}
}
}
],
"sealedKyc": { "enabled": true, "recordKeySet": true }
},
"error": null,
"metadata": {
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2026-11-14T21:27:29.700Z"
}
}
Lists the enabled verification profiles of your instance with what an onboarding under each one involves: the provider it defaults to, the KYC sources that verify for it, and the rules a review is held to. Use it to decide in your app which flow to show a customer.
defaultProvider is the provider Start Onboarding uses when you name none. It is KYC_SOURCE for a profile with an active KYC source and TRUSSET for every other profile.
Response Fields
Show child attributes
Show child attributes
Show child attributes
Show child attributes
curl "https://api.trusset.org/customers/api/onboarding/options" \
-H "X-API-Key: trusset_your_key_here"
const response = await fetch('https://api.trusset.org/customers/api/onboarding/options', {
headers: { 'X-API-Key': 'trusset_your_key_here' }
});
const { data } = await response.json();
const professional = data.profiles.find((profile) => profile.key === 'PROFESSIONAL');
{
"success": true,
"data": {
"profiles": [
{
"key": "PROFESSIONAL",
"name": "Professional",
"description": "Professional investor",
"entityType": "INDIVIDUAL",
"professionalOnly": true,
"onChainInvestorType": 2,
"blockedCountries": [],
"reverifyDays": null,
"requiredFields": [
{ "id": "identity", "label": "Government ID", "types": ["PASSPORT", "ID_CARD", "DRIVERS"], "required": true, "idDocSetType": "IDENTITY" },
{ "id": "selfie", "label": "Selfie / liveness", "types": ["SELFIE"], "required": true, "idDocSetType": "SELFIE" }
],
"defaultProvider": "KYC_SOURCE",
"providers": {
"TRUSSET": { "available": true, "levelName": "basic-kyc-level" },
"KYC_SOURCE": {
"available": true,
"sources": [{ "id": "cmwgx2jnn003diinmv99ki3kh", "name": "Hanse Haftungsdach", "status": "ACTIVE" }]
}
}
}
],
"sealedKyc": { "enabled": true, "recordKeySet": true }
},
"error": null,
"metadata": {
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2026-11-14T21:27:29.700Z"
}
}
Error Codes
| Code | HTTP | Cause |
|---|---|---|
RATE_LIMIT_EXCEEDED | 429 | More than 240 onboarding reads in the minute |
ONBOARDING_OPTIONS_FAILED | 500 | The read failed on the server |
⌘I
curl "https://api.trusset.org/customers/api/onboarding/options" \
-H "X-API-Key: trusset_your_key_here"
const response = await fetch('https://api.trusset.org/customers/api/onboarding/options', {
headers: { 'X-API-Key': 'trusset_your_key_here' }
});
const { data } = await response.json();
const professional = data.profiles.find((profile) => profile.key === 'PROFESSIONAL');
{
"success": true,
"data": {
"profiles": [
{
"key": "PROFESSIONAL",
"name": "Professional",
"description": "Professional investor",
"entityType": "INDIVIDUAL",
"professionalOnly": true,
"onChainInvestorType": 2,
"blockedCountries": [],
"reverifyDays": null,
"requiredFields": [
{ "id": "identity", "label": "Government ID", "types": ["PASSPORT", "ID_CARD", "DRIVERS"], "required": true, "idDocSetType": "IDENTITY" },
{ "id": "selfie", "label": "Selfie / liveness", "types": ["SELFIE"], "required": true, "idDocSetType": "SELFIE" }
],
"defaultProvider": "KYC_SOURCE",
"providers": {
"TRUSSET": { "available": true, "levelName": "basic-kyc-level" },
"KYC_SOURCE": {
"available": true,
"sources": [{ "id": "cmwgx2jnn003diinmv99ki3kh", "name": "Hanse Haftungsdach", "status": "ACTIVE" }]
}
}
}
],
"sealedKyc": { "enabled": true, "recordKeySet": true }
},
"error": null,
"metadata": {
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2026-11-14T21:27:29.700Z"
}
}
