Skip to main content
GET
/
customers
List all customer records
curl --request GET \
  --url https://api.platform.dakota.xyz/customers \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
      "name": "Acme Corp",
      "email": "contact@acmecorp.com",
      "customer_type": "business",
      "kyb_status": "pending",
      "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",
      "created_at": 1234567890,
      "updated_at": 1234567890,
      "deleted_at": 1234567890
    }
  ],
  "meta": {
    "total_count": 100,
    "has_more_after": true,
    "has_more_before": false
  }
}

Authorizations

ā€‹
x-api-key
string
header
required

Query Parameters

ā€‹
starting_after
string

A cursor for use in pagination. starting_after is a KSUID for the object you are listing that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with ID 2B5J8KZ9N7M1K3P6Q8R4T7V9, your subsequent call can include starting_after=2B5J8KZ9N7M1K3P6Q8R4T7V9 in order to fetch the next page of the list. 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"

ā€‹
ending_before
string

A cursor for use in pagination. ending_before is a KSUID for the object you are listing that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with ID 2B5J8KZ9N7M1K3P6Q8R4T7V9, your subsequent call can include ending_before=2B5J8KZ9N7M1K3P6Q8R4T7V9 in order to fetch the previous page of the list. 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"

ā€‹
limit
integer
default:20

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Required range: 1 <= x <= 100
ā€‹
external_id
string

Filter customers by external ID

ā€‹
search
string

Search customers by name, email, or customer ID (case-insensitive)

ā€‹
kyb_status
enum<string>

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

Available options:
active,
pending,
partner_review,
rejected,
frozen
Example:

"pending"

Response

List of all customer records

ā€‹
data
object[]
required
ā€‹
meta
object
required

Meta information about the response