> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trusset.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Onboarding Options

> The profiles your instance onboards under and the provider each one uses

Lists the enabled [verification profiles](https://docs.trusset.org/endpoints/customers/list-verification-profiles.md) 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](https://docs.trusset.org/endpoints/customers/start-onboarding.md) 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

**data** `object`

**profiles** `array`

**key** `string`

The value to send as `profile`.

**name** `string`

The display name.

**description** `string`

Or `null`.

**entityType** `string`

`INDIVIDUAL` for natural persons, `COMPANY` for legal entities.

**professionalOnly** `boolean`

Whether the profile is limited to professional clients.

**onChainInvestorType** `integer`

`1` retail, `2` professional, `3` eligible counterparty.

**blockedCountries** `string[]`

ISO 3166-1 alpha-3 codes a customer cannot be onboarded from.

**reverifyDays** `integer`

Days until a verification under the profile lapses, or `null`.

**requiredFields** `array`

The documents the identity check asks for.

**defaultProvider** `string`

`TRUSSET` or `KYC_SOURCE`.

**providers** `object`

`TRUSSET` with `available` and `levelName`, the Sumsub level of the profile. `KYC_SOURCE` with `available` and `sources`, each `id`, `name` and `status` (`ACTIVE` or `PAUSED`). A KYC source is available when one is active, your instance has a record key, and sealed KYC records are enabled for it.

**sealedKyc** `object`

`enabled` and `recordKeySet` for your instance. See [Availability](https://docs.trusset.org/endpoints/customers/introduction.md#availability).

```bash cURL theme={null}
curl "https://api.trusset.org/customers/api/onboarding/options" \
  -H "X-API-Key: trusset_your_key_here"
```

```typescript TypeScript theme={null}
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');
```

```json Response theme={null}
{
  "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 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.