v1

latestOpenAPI 3.1.02026-07-226250251.5 KB
Customers

List Customers V2

Retrieve a list of customers filtered by type

get/v2/customers

Query parameters

type'INDIVIDUAL' | 'BUSINESS' required

Filter customers by type

per_pageinteger

Number of items to return per page

current_pageinteger

The page number to retrieve

Response

List of customers retrieved successfully

Example response

{
  "data": {
    "pagination": {
      "current_page": 1,
      "per_page": 40,
      "total_page": 1,
      "total": 4
    },
    "customers": [
      {
        "customer_id": "56c41b8e-e650-4f55-94f6-26a888a9b64d",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com",
        "phone": "+14155551234",
        "country_of_residence": "USA",
        "customer_status": "INCOMPLETE",
        "tos_policies_url": "https://orchestration.fin.com/orchestration-customer-tos?customer_id=56c41b8e-e650-4f55-94f6-26a888a9b64d&tos_policies_value=e9414388-fbdf-4407-b5c2-bc39eae3645b",
        "created_at": "2026-04-01T12:03:03Z",
        "updated_at": "2026-04-01T12:03:03Z"
      }
    ]
  }
}