Create Virtual Account

This endpoint provides a unique virtual customer account for processing transactions for existing customers. POST /api/account/v1/createvirtualaccount

Headers

Name
Value

Content-Type*

application/json

Authorization*

Bearer <token>

Request-Reference

{unique-reference}

Body

Name
Data Type (length)
Required
Description

accountName

string

Name associated with the account

lastName

string

Customer's last name

firstName

string

Customer's first name

otherNames

string

Customer's other names

phoneNumber

string

Customer's phone number

email

string

Customer's email address

ignorePrefix

boolean

This flag indicates whether an account should be prefixed by a custom alias configured by the financial institution. Set true for active and false for inactive. The default value is active.

productCode

string

The customer's savings account product code

bvn

string

Bank Verification Number (BVN)

nin

string

National Identification Number (NIN)

maritalStatus

string

The customer's marital status. The enumerations are:

1 = Married,

2 = Single, 3 = Divorced, 4 = Widow, 5 = Widower

religion

string

The customer's religion. The enumerations are:

1 = Christianity,

2 = Islamic, 3 = Others

hometown

string

Customer's hometown

dateOfBirth

date

The customer's Date of birth. The format should be YYYY-MM-DD (e.g., 2025-30-12)

nationality

string

Customer's nationality

state

string

Customer's state of residence

lga

string

Local Government Area (LGA)

identificationType

string

Type of identification (e.g., driver's license, passport) The enumerations are:

1 = National ID (Default),

2 = Drivers License, 3 = Voters Card, 4 = International Passport

identificationNumber

integer

Identification number for the chosen identification type. The product settings will apply if not supplied.

pep

boolean

Politically Exposed Person (PEP) status. Set true for yes and false for no

tin

string

Tax Identification Number (TIN)

employeeID

string

Employee ID if the account is related to employment

address

string

Customer's residential address

documentIdentifier

string

This is an identifier that will link all documents associated with the user. It can be a Guid value or any valid string with no special characters. Guid is recommended

isBusinessAccount

boolean

Set true if the account is for business purposes and false if it's not

Sample Request
// Some codecurl --location -g '{{baseurl}}/api/account/v1/createvirtualaccount' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--data-raw '{
  "accountName": "",
  "lastName": "",
  "firstName": "",
  "otherNames": "Bertram_Maggio36",
  "phoneNumber": "",
  "email": ".@gmail.com",
  "ignorePrefix": true,
  "productCode": "301",
  "bvn": "string",
  "nin": "string",
  "maritalStatus": "string",
  "religion": "Christianity",
  "hometown": "Ikorodu",
  "dateOfBirth": "2000-01-01",
  "nationality": "Nigerian",
  "state": "Lagos",
  "lga": "Ikorodu",
  "identificationType": "DriversLicense",
  "identificationNumber": "string",
  "pep": true,
  "tin": "string",
  "employeeID": "",
  "address": "5, Bajulaiye road, Isolo",
  "documentIdentifier": "",
  "isBusinessAccount": true
}'

Response

{
  "status": true,
  "message": "string",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountNumber": "string"
  }
}

Last updated