Skip to main content
GET
/
customers
/
{id}
Retrieve a customer record by ID
curl --request GET \
  --url https://api.platform.dakota.xyz/customers/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
  "name": "Acme Corp",
  "customer_type": "company",
  "kyb_status": "pending",
  "created_at": 1234567890,
  "updated_at": 1234567890,
  "email": "contact@acmecorp.com",
  "kyb_links": [
    {
      "provider_id": "trm_labs",
      "link_type": "persona",
      "url": "https://verify.provider.com/kyb/a1b2c3d4e5f6",
      "status": "pending",
      "created_at": 1234567890,
      "updated_at": 1234567890,
      "expires_at": 1234567890,
      "deleted_at": 1234567890
    }
  ],
  "provider_statuses": [
    {
      "provider_id": "trm_labs",
      "status": "approved",
      "endorsements": [
        "<string>"
      ]
    }
  ],
  "application_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
  "decision": "approved",
  "application_url": "https://onboarding.example.com/applications/abc123?token=xyz789",
  "deleted_at": 1234567890
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
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
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

Response

Customer record retrieved successfully

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

​
id
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
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:
person,
company
Example:

"company"

​
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
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

​
email
string

Email address of the customer

Example:

"contact@acmecorp.com"

​
kyb_links
object[]

KYB Links for different providers used in the KYB process.

​
provider_statuses
object[]

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

​
application_id
string

ID of the KYB application associated with this customer

Required string length: 27
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

​
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