End customers

Generated page, from the OpenAPI specification the gateway serves (GET /v1/openapi.json). Do not edit it by hand: it is rewritten on every build.

Method	Path	Description
GET	/v1/customers	List your end customers
POST	/v1/customers	Register an end customer
GET	/v1/customers/{id}	Retrieve an end customer
PATCH	/v1/customers/{id}	Update an end customer

GET /v1/customers

List your end customers

Your own end customers. external_id filters exactly; search matches loosely on name, phone and email. Scope can_read_customers.

Parameters

Name	In	Required	Description
external_id	query	no	Your own identifier — an exact filter.
search	query	no
limit	query	no	20 by default, 100 at most.
offset	query	no

Responses

• 200 — OK
• 401 — API key missing or rejected
• 403 — The key does not carry the required scope (can_read_customers / can_write_customers), or the account is not active
• 429 — The key's request budget is exceeded

POST /v1/customers

Register an end customer

Registers a person you already know, BEFORE their first payment. Two effects: a player whose age you declare you have verified is never held on a restricted corridor for want of verification, and their risk profile is pre-warmed, which takes that work off the payment path. Answers 200 with already_existed: true when the person was already known: the deduplication key is shared with the payment path, so a “create” often lands on a record your own payments already made. Scope can_write_customers.

Responses

• 200 — The person was already known; the existing record is returned, filled in where fields were empty
• 201 — End customer created
• 401 — API key missing or rejected
• 403 — The key does not carry the required scope (can_read_customers / can_write_customers), or the account is not active
• 422 — Age verification incomplete or outside the vocabulary
• 429 — The key's request budget is exceeded

GET /v1/customers/{id}

Retrieve an end customer

Scope can_read_customers.

Parameters

Name	In	Required	Description
id	path	yes	The end customer's identifier.

Responses

• 200 — OK
• 401 — API key missing or rejected
• 403 — The key does not carry the required scope (can_read_customers / can_write_customers), or the account is not active
• 404 — No end customer with that identifier
• 429 — The key's request budget is exceeded

PATCH /v1/customers/{id}

Update an end customer

An omitted field is unchanged. This is how you answer a re-verification request (customer.reverification_requested): send the verification you carried out, and the restriction placed in the meantime is lifted in the same transaction. Scope can_write_customers.

Parameters

Name	In	Required	Description
id	path	yes	The end customer's identifier.

Responses

• 200 — Updated
• 401 — API key missing or rejected
• 403 — The key does not carry the required scope (can_read_customers / can_write_customers), or the account is not active
• 404 — No end customer with that identifier
• 422 — Age verification incomplete or outside the vocabulary
• 429 — The key's request budget is exceeded