Sign in
latestOpenAPI 3.0.12026-08-16171142480.4 KB

ff1699330afa

Account API

Get async account creation status

Returns the current status of an asynchronous account creation request. Status values: QUEUED (waiting to be processed), PROCESSING (currently being created), COMPLETED (success, includes the account), FAILED (includes error message). Statuses are retained for 1 hour after completion.

get/rest/api/v1/accounts/async/{requestId}

Path parameters

requestIdstring required

The requestId returned by the async POST /accounts call

Response

OK

callbackUrlstring

The callback URL where the result will be sent

errorstring

Error message (only present when status is FAILED)

messagestring

Status message

requestIdstring

Unique request ID for tracking this async operation

status'QUEUED' | 'PROCESSING' | 'COMPLETED' | 'FAILED'

Processing status of the async request

Example response

{
  "account": {
    "callbackUrl": "https://example.com/webhook/account-created"
  },
  "callbackUrl": "https://example.com/webhook/account-created",
  "message": "Account creation request accepted. The result will be POSTed to the provided callback URL.",
  "requestId": "acc_a1b2c3d4e5f67890",
  "status": "QUEUED"
}