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"
}
'const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({sub_client_id: '1NFHrqBHb3cTfLVkFSGmHZqdDPi'})
};
fetch('https://api.platform.dakota.xyz/customers/{customer_id}/sub-client', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.platform.dakota.xyz/customers/{customer_id}/sub-client"
payload = { "sub_client_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.platform.dakota.xyz/customers/{customer_id}/sub-client"
payload := strings.NewReader("{\n \"sub_client_id\": \"1NFHrqBHb3cTfLVkFSGmHZqdDPi\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"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
}{
"type": "about:blank",
"title": "Bad Request",
"status": 400,
"detail": "the sub-client association can only be set when a customer is created and cannot be changed afterwards"
}{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "Customer not found: 1NFHrqBHb3cTfLVkFSGmHZqdDPi"
}Update sub-client association for a customer
Deprecated and non-functional. The sub-client association is set only at customer creation and is immutable afterwards; this endpoint now rejects all requests with 400. Set sub_client_id on POST /customers instead.
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"
}
'const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({sub_client_id: '1NFHrqBHb3cTfLVkFSGmHZqdDPi'})
};
fetch('https://api.platform.dakota.xyz/customers/{customer_id}/sub-client', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.platform.dakota.xyz/customers/{customer_id}/sub-client"
payload = { "sub_client_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.platform.dakota.xyz/customers/{customer_id}/sub-client"
payload := strings.NewReader("{\n \"sub_client_id\": \"1NFHrqBHb3cTfLVkFSGmHZqdDPi\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"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
}{
"type": "about:blank",
"title": "Bad Request",
"status": 400,
"detail": "the sub-client association can only be set when a customer is created and cannot be changed afterwards"
}{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "Customer not found: 1NFHrqBHb3cTfLVkFSGmHZqdDPi"
}Authorizations
Path Parameters
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.
27^[0-9A-Za-z]{27}$"1NFHrqBHb3cTfLVkFSGmHZqdDPi"
Body
Request to update the sub-client association for a customer. Set sub_client_id to associate with a sub-client, or null to disassociate.
ID of the sub-client to associate with, or null to disassociate.
27^[0-9A-Za-z]{27}$"1NFHrqBHb3cTfLVkFSGmHZqdDPi"
Response
Sub-client association updated successfully
Response containing the current status of a KYB verification process including provider-specific statuses.
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.
27^[0-9A-Za-z]{27}$"1NFHrqBHb3cTfLVkFSGmHZqdDPi"
Name of the customer
"Acme Corp"
Type of entity - either an individual person or a company/organization
individual, business "business"
Overall status of the KYB verification process (e.g., pending, active, restricted).
active, pending, partner_review, rejected, frozen, auto_declined "pending"
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'screatedmaps tonot_started,completedtoapproved,needs_reviewtoin_review). pendingif the customer has an open onboarding application but no decision yet (Sumsub in-flight).not_startedotherwise.
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.
not_started, pending, expired, approved, rejected, in_review "pending"
Timestamp of when the link was created
1234567890
Timestamp of when the link was last updated.
1234567890
Email address of the customer
"contact@acmecorp.com"
Unique identifier for the customer in the client's system, as supplied when the customer was created. Omitted when no external ID was set.
"external_customer_123"
KYB Links for different providers used in the KYB process.
Show child attributes
Show child attributes
Detailed status information from different verification providers used in the KYB process.
Show child attributes
Show child attributes
Whether this customer is currently permitted to hold RD, derived
server-side from the same US-state geofence that guards RD account
creation. true when RD is allowed; false only when one of the
customer's governing US states is on the restricted list while the
geofence is active. Customers with no resolvable US governing state
— non-US customers, or those whose jurisdiction is unconfirmed — are
allowed. When the geofence is disabled (empty blocklist) this is
true for everyone.
This is the canonical read path for the RD-eligibility verdict: consumers read a boolean and never see or copy the underlying blocklist.
true
ID of the KYB application associated with this customer
27^[0-9A-Za-z]{27}$"1NFHrqBHb3cTfLVkFSGmHZqdDPi"
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.
pending, submitted, under_review, request_for_information, admin_revision, approved, declined, completed, compliance_review "submitted"
Application decision status
approved, declined, auto_declined, withdrawn "approved"
Why the application was decided. Populated for withdrawn/declined applications — for example, the fixed reason recorded when an applicant withdraws from an RFI resubmission email. Omitted when there is no decision or no reason was recorded.
"User withdrew the application from the request-for-information (RFI) email"
The single client-facing status for this customer, derived
server-side. It collapses three signals into one badge so a client
never has to reconcile kyb_status, kyc_status, and
application_status by hand.
Precedence (first match wins):
frozen— the customer has an open freeze; surfaced over a stale approval so an actionable freeze is never masked.- the most-recent application's decision —
approved,declined(declined or auto_declined), orwithdrawn. - the most-recent application's lifecycle —
info_requestedwhen a request for information is open (the customer owes a response); the internal in-review states collapse tosubmitted;pendingotherwise. pendingwhen the customer has no application yet.
Once a customer is approved / declined / withdrawn, that is the
final answer and kyb_status / kyc_status do not change it. Use
those fields only for the underlying breakdown.
frozen, declined, withdrawn, approved, info_requested, submitted, pending "info_requested"
URL for accessing the onboarding application. Always present when the
customer has an onboarding application, including during an open RFI
loop. In an RFI loop the additive resubmit_url is returned as well,
and the dashboard links to that resubmission page rather than this
plain application view.
"https://onboarding.example.com/applications/abc123?token=xyz789"
The resubmission link for a customer in an open RFI loop — the exact
/applications/{id}/resubmit?token=… URL the applicant receives in
the RFI email, built from the customer's existing onboarding token
(no new token is minted on read). Present only when status is
info_requested, and returned alongside application_url rather than
in place of it.
"https://onboarding.example.com/applications/abc123/resubmit?token=xyz789"
Timestamp of when the link was deleted
1234567890
ID of the sub-client this customer is associated with, if any.
27^[0-9A-Za-z]{27}$"1NFHrqBHb3cTfLVkFSGmHZqdDPi"
Name of the sub-client this customer is associated with, if any.
"Partner Corp"
Whether this customer is a sub-client. This is set when the customer is created and cannot be changed afterwards.
Was this page helpful?