Run in Apidog
This endpoint creates new accounts that are classified as either BUSINESS or PERSON based on the clientType
provided. For BUSINESS accounts, the account opener's fullName
is required, while for PERSONAL accounts, both the firstname
and lastname
must be provided to ensure proper account setup. Request Body # Field Name Type Required Description clientType string true Must be set to PERSON
for personal accounts. firstname string true Account opener's first name. lastname string true Account opener's last name. email string true Account opener's email address. mobileNo string true Account opener's mobile phone number. bvn string true Account opener's Bank Verification Number (BVN). nin string false Account opener's National Identity Number (NIN). productId integer true Transaction Point Product ID (e.g., Savings Account, Current Account).
Field Name Type Required Description clientType string true Must be set to BUSINESS
for business accounts. dateOfBirth string true Client's date of birth (format: DD-MM-YYYY). fullName string true Account opener's full name. email string true Account opener's email address. mobileNo string true Account opener's mobile phone number. bvn string true Account opener's Bank Verification Number (BVN). nin string false Account opener's National Identity Number (NIN). productId integer true Transaction Point Product ID (e.g., Savings Account, Current Account).
Response Body # Field Name Type Description id integer Unique identifier for the account record. firstname string Account opener's first name. lastname string Account opener's last name. email string Account opener's email address. mobileNo string Account opener's mobile phone number. nuban string Generated NUBAN (bank account number). productId integer Transaction Point Product ID (e.g., Savings Account, Current Account). clientId integer Unique identifier for the client.
Field Name Type Description id integer Unique identifier for the account record. email string Account opener's email address. mobileNo string Account opener's mobile phone number. nuban string Generated NUBAN (bank account number). productId integer Transaction Point Product ID (e.g., Savings Account, Current Account). clientId integer Unique identifier for the client. subLedgerActivated boolean Indicates whether the Sub Ledger Account has been activated for this account.
Request Body Params application/json
{
"clientType" : "BUSINESS" ,
"dateOfBirth" : "01-01-1990" ,
"fullName" : "TPGateway Business" ,
"email" : "user1@gmail.com" ,
"mobileNo" : "373737999312" ,
"bvn" : "838121211122" ,
"productId" : 100
}
Request Code Samples
curl --location --request POST '/core/account' \
--header 'Content-Type: application/json' \
--data-raw '{
"clientType": "BUSINESS",
"dateOfBirth": "01-01-1990",
"fullName": "TPGateway Business",
"email": "user1@gmail.com",
"mobileNo": "373737999312",
"bvn": "838121211122",
"productId": 100
}'
Responses application/json Generate Code
{
"id" : 69 ,
"firstname" : "Sample" ,
"lastname" : "Account 1" ,
"email" : "sampleaccount1@gmail.com" ,
"mobileNo" : "373737322" ,
"nuban" : "0000000355" ,
"productId" : 100 ,
"clientId" : 70
}
Modified at 2025-03-19 15:01:34