Register an account

post

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

Registers an account for a customer and starts provisioning it.

Provisioning and events

The response is 202 with the account PENDING. The wallet address appears once provisioning completes; poll GET /api/accounts/{accountRef} for it. No callback URL is supplied on this request.

The service also produces account.provisioned and account.provisioning_failed business events for delivery through configured webhooks; verify delivery in your environment.

Prerequisites

The customer must exist and be ACTIVE, and the asset must have an ACTIVE contract, before an account can be registered.

Retrying failed provisioning

A FAILED account can be re-registered, but only by the customer that owns it and under the same assetId: the account is reset to PENDING, and provisioning starts again. Re-registering it with a different customerRef or assetId is rejected with 409 Conflict and the account is left FAILED, because an account cannot change hands.

A reference linked to an account in any other status is rejected with 409 Conflict too.

Recipes

Create a customer and provision an account

Open Recipe

Body Params

customerRef

string

required

length ≤ 128

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

The customer the account belongs to. Must already exist and be ACTIVE.

accountRef

string

required

length ≤ 128

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

The bank's own reference for the account. Unique within the organisation.

assetId

string

required

length ≤ 16

[A-Za-z0-9]+

The asset the account holds. Case-insensitive, and must have an ACTIVE contract.

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

202Accepted. The account exists and is PENDING; provisioning is under way.

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.)

404The customer does not exist, or the asset has no active contract.

422The customer exists but is INACTIVE, or an earlier request reused this Idempotency-Key with a different payload.

500An unexpected error occurred while handling the request.