Update sub-client association for a customer

curl --request PATCH \ --url https://api.platform.dakota.xyz/customers/{customer_id}/sub-client \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data ' { "sub_client_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi" } '

{ "id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi", "name": "John Doe", "customer_type": "individual", "kyb_status": "pending", "kyc_status": "not_started", "is_sub_client": false, "sub_client_id": "2ABCrqBHb3cTfLVkFSGmHZqdXYZ", "sub_client_name": "Partner Corp", "created_at": 1700000000, "updated_at": 1700000000 }

Authorizations

x-api-key

string

header

required

Path Parameters

customer_id

string

required

Unique identifier (ksuid) of the customer record KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27

Pattern: ^[0-9A-Za-z]{27}$

Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

Body

application/json

Request to update the sub-client association for a customer. Set sub_client_id to associate with a sub-client, or null to disassociate.

sub_client_id

string | null

ID of the sub-client to associate with, or null to disassociate.

Required string length: 27

Pattern: ^[0-9A-Za-z]{27}$

Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

Response

Sub-client association updated successfully

Response containing the current status of a KYB verification process including provider-specific statuses.

string

required

KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27

Pattern: ^[0-9A-Za-z]{27}$

Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

name

string

required

Name of the customer

Example:

"Acme Corp"

customer_type

enum<string>

required

Type of entity - either an individual person or a company/organization

Available options:

individual,

business

Example:

"business"

kyb_status

enum<string>

required

Overall status of the KYB verification process (e.g., pending, active, restricted).

Available options:

active,

pending,

partner_review,

rejected,

frozen,

auto_declined

Example:

"pending"

kyc_status

enum<string>

required

Provider-agnostic effective KYC/B status for this customer, derived server-side for display convenience. Returns the same answer for both Sumsub-verified and Persona-verified customers without the client having to know which provider did the work.

Derivation order (most authoritative first):

The customer's onboarding application decision, if set (approved → approved; declined/auto_declined → rejected; withdrawn → expired).
The most-recently-updated non-deleted persona kyb_link's status (legacy customers from before the orchestration layer — Persona's created maps to not_started, completed to approved, needs_review to in_review).
pending if the customer has an open onboarding application but no decision yet (Sumsub in-flight).
not_started otherwise.

Advisory, not authoritative. This field is provided for badge rendering and operator UIs. The derivation rules may evolve as new verification providers are added. For compliance-critical decisions, consult decision, kyb_links, and provider_statuses directly.

Available options:

not_started,

pending,

expired,

approved,

rejected,

in_review

Example:

"pending"

created_at

integer

required

Timestamp of when the link was created

Example:

1234567890

updated_at

integer

required

Timestamp of when the link was last updated.

Example:

1234567890

string

Email address of the customer

Example:

"contact@acmecorp.com"

kyb_links

object[]

KYB Links for different providers used in the KYB process.

Show child attributes

provider_statuses

object[]

Detailed status information from different verification providers used in the KYB process.

Show child attributes

application_id

string

ID of the KYB application associated with this customer

Required string length: 27

Pattern: ^[0-9A-Za-z]{27}$

Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

application_status

enum<string>

Current lifecycle state of the customer's onboarding application (e.g. pending, submitted, under_review, approved, declined). Omitted when the customer has no application.

Use this field to drive workflow UI — it tracks where the customer is in the onboarding flow. For the orthogonal questions "is this customer cleared to transact?" and "what's the provider-agnostic KYC verdict?", see kyb_status and kyc_status respectively.

Available options:

pending,

submitted,

under_review,

request_for_information,

admin_revision,

approved,

declined,

completed,

compliance_review

Example:

"submitted"

decision

enum<string>

Application decision status

Available options:

approved,

declined,

auto_declined,

withdrawn

Example:

"approved"

application_url

string

URL for accessing the onboarding application

Example:

"https://onboarding.example.com/applications/abc123?token=xyz789"

deleted_at

integer

Timestamp of when the link was deleted

Example:

1234567890

sub_client_id

string

ID of the sub-client this customer is associated with, if any.

Required string length: 27

Pattern: ^[0-9A-Za-z]{27}$

Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

sub_client_name

string

Name of the sub-client this customer is associated with, if any.

Example:

"Partner Corp"

is_sub_client

boolean

default:false

Whether this customer is acting as a sub-client (has other customers associated with it).