Create Sub Account (Corporate)

Creates a sub-account for a company: a reserved (static) account number that does not expire.

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

Verify at least one director first with Initiate Verification and Validate Verification. Then send identityType: "vID", that verification's _id as identityId, and the company's companyRegistrationNumber (RC or BN number).

If callbackUrl is not set, payment notifications go to the webhook URL on your dashboard.

Body Params
string
required
Defaults to +2348000000000

This is the phone number of the account holder. It should begin with the country code.

string
required
Defaults to [email protected]

This is the email address.

string
required

This is an external reference to be attached to the account object.

string
required
Defaults to vID

Identification method the account holder, should be vID (Provided you have Validated the KYC of at least one director of the company).

string
required

The _id from the Safe Haven Verification Endpoint.

string
required

The company's RC or BN number. Example: 1234567.

string

If not provided, the webhook URL on your Dashboard will be used.

string

The company name.

boolean
Defaults to false

This should be set when creating a virtual account. It determines if auto sweep should be enabled or disabled.

autoSweepDetails
object

This contains the auto sweep details to be filled if creating a virtual account.

Headers
string
required

Your ibs_client_id, returned by Exchange Client Credentials.

Responses

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