Create Bank Account

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Asynchronous issuance

A 201 response creates an account request; it does not confirm activation. Save data.id and track the existing account through Fetch Bank Account and Issuance Events. Bank details may be null while status is pending. Only display funding instructions after the account is active.

Prepare the holder using the USD person requirements. New personal USD issuance may require RFIs. List them with account_id, handle standard responses or hosted links, and wait for account.created or account.issuance.failed. Completing an inquiry is not proof that the account is active.

If a create request times out, check List Bank Accounts for the holder before retrying; do not blindly create another request.

New live EUR account requests are currently unavailable. Existing EUR accounts and test EUR requests are unchanged.

Sandbox RFI options

For test person USD accounts only, pass either sandbox_scenario or sandbox_options. These options are not accepted for live, business, or other-currency requests. Omitting both preserves ordinary test issuance and its holder/document prerequisites.

sandbox_scenarioResult
rfi_successStandard RFI, then hosted action, then activation
rfi_rejectedStandard RFI, then hosted action, then issuance failure
rfi_expired_linkStandard RFI, then an expired hosted action requiring refresh, then activation

Example request body (use an existing test person ID):

{
  "person_id": "<TEST_PERSON_ID>",
  "label": "Sandbox RFI success",
  "currency": "USD",
  "autosweep_enabled": false,
  "sandbox_scenario": "rfi_success"
}

To customise the sequence, use sandbox_options instead:

{
  "person_id": "<TEST_PERSON_ID>",
  "label": "Custom sandbox RFI sequence",
  "currency": "USD",
  "autosweep_enabled": false,
  "sandbox_options": {
    "rfi_sequence": [
      {"type": "standard"},
      {"type": "link", "link_status": "expired"}
    ],
    "outcome": "success"
  }
}

rfi_sequence accepts 1–10 step objects; types may repeat. Each step has type: standard|link. Only link steps accept link_status: available|expired (default available). outcome is success (default) or rejected. An empty sandbox_options object uses standard then available-link steps and success. Supplying both options, string-array steps, a global link status, or invalid values returns 400.

Each RFI appears only when its turn begins. All steps must complete before the selected final outcome. Sandbox hosted links expire 14 days after issuance or refresh. Refresh preserves the inquiry ID and invalidates that step's old link.

Body Params
string

Required for business accounts

string

Required for personal accounts

string
required
string
enum
required
Defaults to USD
Allowed:
boolean
Defaults to false

When 'autosweep_enabled' is set to true, any funds deposited in the account will automatically flow to your master wallet; if set to false, the deposited money stays in the balance of this account.

boolean
Defaults to false

Enable this if you want to restrict deposits to only come from a specific bank account. This option is only available to NGN accounts

whitelist
object

Specific the bank account details you wish to whitelist. Note that only deposits from this specific account would be allowed for the account you're creating now.

string
enum

Test person USD accounts only. Choose rfi_success, rfi_rejected, or rfi_expired_link. Mutually exclusive with sandbox_options; omission preserves ordinary issuance.

Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json