Register a customer

post

https://api.qfp.quantnetwork.net/api/customers

Registers a customer, active from the start. customerRef is the bank's own reference and is never interpreted; it need only be unique within the organisation.
Replaying the same Idempotency-Key returns the first response unchanged.

Recipes

Create a customer and provision an account

Open Recipe

Body Params

customerRef

string

required

length ≤ 128

[A-Za-z0-9._:-]+

The bank's own reference, never interpreted by this service. Unique within the organisation.

Headers

API-Version

string

required

^\d+\.\d+\.\d+$

The version of the Quant Flow API the request follows, as major.minor.patch (for example 1.0.0). The request is interpreted, and the response shaped, according to that version.

Idempotency-Key

string

required

length ≤ 255

Caller-supplied key making the write at-most-once. Replay semantics are endpoint-specific: customer and account registry writes replay the original response and reject a changed payload with 422; transaction and deployment submissions return the current operation with 200 and ignore a changed payload. See the operation's response documentation. Use one key per intent. Missing, blank or longer than 255 characters is a 400.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Customer registered, active.

400A required field is missing or invalid, or the Idempotency-Key header is missing, blank or longer than 255 characters.

401Returned once authentication is enforced, when the request carries no Authorization header or an unresolvable token. (planned — not returned today, see the API description.)

409Either the customerRef is already registered, in which case the body carries customerRef and existingStatus, or an earlier request under the same Idempotency-Key is still running, which carries neither and comes with a Retry-After header. Only the second is worth retrying.

422The Idempotency-Key was already used for a different payload.

500An unexpected error occurred while handling the request.