Skip to main content
POST
/
accounts
Error
A valid request URL is required to generate request examples
{
  "status": "00",
  "message": "The process was completed successfully",
  "data": {
    "customer_id": "1234567890",
    "account_type": "SBA",
    "status": "ACTIVE",
    "custom_properties": [
      {
        "id": "1",
        "description": "custom_property",
        "type": "string",
        "value": "custom_property"
      }
    ]
  }
}
{
  "status": "01",
  "error_code": "MISSING_FIELD",
  "message": "The field is missing",
  "data": {}
}
{
  "status": "02",
  "message": "The authentication failed",
  "data": {}
}
{
  "status": "03",
  "message": "You are not allowed to perform this operation",
  "data": {}
}
{
  "status": "04",
  "message": "The resource you are looking for does not exist",
  "data": {}
}
{
  "status": "05",
  "message": "An unknown error occurred",
  "data": {}
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
connection-id
string

Connection ID for the target bank

​
idempotency-key
string
required

Unique key to ensure idempotency of the request

​
signature
string
required

SHA-256 signature of client_secret + ";" + idempotency-key

Body

application/json
​
customer_ref
string

The customer reference for whom the account is being opened

​
product_id
string

Unique identifier of the product for which the account would be opened

Example:

"SBA123"

​
name_on_account
string

The name on the account

Example:

"Ado John Sule"

​
dob
string

The date of birth of the account holder

Example:

"1990-01-01"

​
first_name
string

The first name of the account holder

Example:

"Ado"

​
middle_name
string

The middle name of the account holder

Example:

"John"

​
surname
string

The surname of the account holder

Example:

"Sule"

​
gender
enum<string>

The gender of the account holder

Available options:
M,
F
Example:

"M"

​
email
string

The email of the account holder

Example:

"ado.john@example.com"

​
phone
string

The phone number of the account holder

​
proof_of_id
object
​
proof_of_address
object
​
address
object
​
next_of_kin
object
​
custom_properties
object[]

Response

Account created successfully

​
status
string
Example:

"00"

​
message
string
Example:

"The process was completed successfully"

​
data
object