Skip to Content
Apex Settlement
Customer

Get the Customer

Required permissioncustomer:read
GET
/v1/customer

The Customer the API key belongs to (or, with Apex-End-Customer, that End Customer): its legal name, type and country, its standing (onboarding, active, suspended or closed), its kind (direct, platform, or end_customer of a Platform) and the Providers that approved it. It answers while the Customer is still being onboarded or suspended, so a client can tell why other operations are refused.

Requires the customer:read permission. A Platform may call it for one of its End Customers with Apex-End-Customer.

Authorization

ApiKey
headerAuthorizationBearer <API key>

A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.

Header Parameters

Apex-End-Customer?string

A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers end_customer_not_found.

Formatuuid

Response Body

OK

application/json
  1. response
country*string
id*string
kind*string

kind is direct, platform (it may open End Customers) or end_customer (one of a Platform's End Customers).

Value in"direct""platform""end_customer"
legal_name*string
providers*array<string>

providers are the Providers that approved the Customer.

standing*string

standing is onboarding (still passing due diligence), active, suspended or closed (rejected).

Value in"onboarding""active""suspended""closed"
type*string
Value in"individual""business"
Example Request
curl -X GET 'http://localhost:3480/v1/customer'
Example Response
{  "country": "US",  "id": "2b7e4f1a-6c3d-4e8b-9a0f-1d2c3b4a5e6f",  "kind": "direct",  "legal_name": "Tom Becker",  "providers": [    "bvnk",    "zerohash"  ],  "standing": "active",  "type": "individual"}