Customers

Customers can only be created via the application process. Once created, customers can have multiple accounts associated with them.

Endpoints

GET /customers Retrieve customers GET /customers/{id} Retrieve customer PATCH /customers/{id} Update customer GET /customers/{id}/individuals/{individual_id} Retrieve individual PATCH /customers/{id}/individuals/{individual_id} Update individual
GET /customers

Retrieve a list of customers with optional filtering.

Query Parameters

Parameter Type Description
type string Filter by type (INDIVIDUAL, CORPORATION)
status string Filter by status (ACTIVE, PENDING, EDD, FROZEN, DORMANT, CLOSED)
limit integer Number of results to return (default: 20)
cursor string Pagination cursor

Response

200 OK 
{
  "data": [
    {
      "id": "cust_987654321",
      "type": "INDIVIDUAL",
      "status": "ACTIVE",
      "email": "john.doe@example.com",
      "created_at": "2026-01-15T10:30:00Z"
    },
    {
      "id": "cust_123456789",
      "type": "CORPORATION",
      "status": "ACTIVE",
      "email": "contact@acmecorp.com",
      "created_at": "2026-01-10T08:00:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "cursor_abc123"
  }
}
GET /customers/{id}

Retrieve details of a specific customer.

Path Parameters

Parameter Type Description
id required string The customer ID

Response

200 OK 
{
  "id": "cust_987654321",
  "type": "INDIVIDUAL",
  "status": "ACTIVE",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "individual": {
    "first_name": "John",
    "last_name": "Doe",
    "date_of_birth": "1990-01-15",
    "address": {
      "line1": "123 Main St",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "US"
    }
  },
  "accounts": [
    {
      "id": "acc_123456789",
      "currency": "USD",
      "status": "ACTIVE"
    }
  ],
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T14:45:00Z"
}
PATCH /customers/{id}

Update customer information. Note: Major changes may require a new application.

Request Body

Field Type Description
email string Updated email address
phone string Updated phone number
address object Updated address

Response

200 OK 
{
  "id": "cust_987654321",
  "email": "john.newemail@example.com",
  "updated_at": "2026-01-15T16:00:00Z"
}
GET /customers/{id}/individuals/{individual_id}

Retrieve details of an individual associated with a corporate customer.

Response

200 OK 
{
  "id": "ind_456789",
  "customer_id": "cust_123456789",
  "role": "BENEFICIAL_OWNER",
  "first_name": "Jane",
  "last_name": "Smith",
  "email": "jane.smith@acmecorp.com",
  "ownership_percentage": 30,
  "address": {
    "line1": "456 Oak Ave",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94102",
    "country": "US"
  },
  "created_at": "2026-01-10T08:00:00Z"
}
PATCH /customers/{id}/individuals/{individual_id}

Update individual's information.

Request Body

Field Type Description
email string Updated email address
phone string Updated phone number
address object Updated address

Response

200 OK 
{
  "id": "ind_456789",
  "updated_at": "2026-01-15T17:00:00Z"
}