Create a Business Account
POST /accounts/business
Description
Create a new business account with the provided information.
Request Body
- Media Type:
application/json
| Name | Type | Description |
|---|---|---|
| businessName* | string | (Required). Name of the business. Include in the request body. |
| incorporationDate | string (ISO 8601 date-time) | (Required). Date of incorporation of the business. Include in the request body. |
| industry | string | (Required). Industry or business category. Include in the request body. |
| tenantUserId | string | (Required). Unique identifier for the user within the tenant. Include in the request body. |
| mobileNumber | string | (Required). Mobile number associated with the business. Include in the request body. |
| countryOfIncorporation* | string | (Required). Country of incorporation for the business. Include in the request body. |
| incorporationType* | string | (Required). Type of incorporation (e.g., "LLC", "Corporation"). Include in the request body. |
| incorporationNumber* | string | (Required). Incorporation number for the business. Include in the request body. |
| websiteUrl | string | (Optional). Website URL of the business. Include in the request body if applicable. |
| businessTag | string | (Optional). A tag or label for the business. Include in the request body if applicable. |
| termsAndConditionsSignedAt* | string (ISO 8601 date-time) | (Required). Date when terms and conditions were signed. Include in the request body. |
| address* | object | (Required). Address information for the business. Include in the request body. |
| accountType* | string | (Required). Type of account, should be "CUSTOMER" for a business account. Include in the request body. |
| email* | string | (Required). Email address associated with the business. Include in the request body. |
| registeredBusinessAddress | string | (Optional). Registered business address. Include in the request body if applicable. |
| operatingAddress | string | (Optional). Operating address of the business. Include in the request body if applicable. |
| taxIdentificationNumber | string | (Optional). Tax identification number for the business. Include in the request body if applicable. |
| natureOfBusiness | string | (Optional). Nature of the business. Include in the request body if applicable. |
| shopName | string | (Optional). Name of the business shop. Include in the request body if applicable. |
| lga | string | (Optional). Local Government Area. Include in the request body if applicable. |
| bankName | string | (Optional). Name of the bank associated with the business. Include in the request body if applicable. |
| bankAccountNumber | string | (Optional). Bank account number for the business. Include in the request body if applicable. |
| bankAccountName | string | (Optional). Bank account name for the business. Include in the request body if applicable. |
| director1 | object | (Optional). Information about the first director. Include in the request body if applicable. |
| director2 | object | (Optional). Information about the second director. Include in the request body if applicable. |
| companyRepresentative | object | (Optional). Information about the company representative. Include in the request body if applicable. |
Response Code: 200 - OK
Description
Account creation successful.
Response Field
| Field | Type | Description |
|---|---|---|
| status | boolean | Indicates the overall success of the operation. |
| statusCode | integer | Represents the specific status code for the response. |
| message | string | Provides additional information about the response. |
| data | object | Contains the main data payload of the response. |
| errors | array | An array containing error details if issues occurred. |
| - message | string | Describes the error. |
| - descriptiveMessage | string | Provides a more detailed and descriptive message about the error. |
Example
<response>
<status>true</status>
<statusCode>0</statusCode>
<message>string</message>
<data></data>
<errors>
<error>
<message>string</message>
<descriptiveMessage>string</descriptiveMessage>
</error>
</errors>
</response>
Response Code: 400 - Bad Request
Description
Validation error.
Example
<response>
<status>false</status>
<statusCode>400</statusCode>
<message>Invalid account id</message>
<data></data>
<errors>
<error>
<message>Invalid account id</message>
<descriptiveMessage></descriptiveMessage>
</error>
</errors>
</response>
curlUrl: "/accounts/business" curlMethod: POST
Method: POST
>http://20.87.230.105/platform/wallets/accounts/businesses
Headers
| Content-Type | Value |
|---|---|
| apiKey | {{apiKey}} |
Body (raw)
{
"businessName": "string",
"incorporationDate": "2023-12-02T04:58:20.244Z",
"industry": "string",
"tenantUserId": "string",
"mobileNumber": "07036497792",
"countryOfIncorporation": "string",
"incorporationType": "string",
"incorporationNumber": "string",
"websiteUrl": "string",
"businessTag": "string",
"termsAndConditionsSignedAt": "2023-12-02T04:58:20.244Z",
"address": {
"addressLine1": "string",
"addressLine2": "string",
"state": "string",
"city": "string",
"zipCode": "string"
},
"accountType": "CUSTOMER",
"email": "string",
"registeredBusinessAddress": "string",
"operatingAddress": "string",
"taxIdentificationNumber": "string",
"natureOfBusiness": "string",
"shopName": "string",
"lga": "string",
"bankName": "string",
"bankAccountNumber": "string",
"bankAccountName": "string",
"director1": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateofBirth": "2023-12-02T04:58:20.244Z",
"gender": "string",
"bvn": "string",
"nin": "string",
"emailAddress": "badmuskola2021@gmail.com"
},
"director2": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateofBirth": "2023-12-02T04:58:20.244Z",
"gender": "string",
"bvn": "string",
"nin": "string",
"emailAddress": "string"
},
"companyRepresentative": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateofBirth": "2023-12-02T04:58:20.244Z",
"gender": "string",
"bvn": "string",
"nin": "string",
"emailAddress": "string"
}
}
🔑 Authentication bearer
| Param | value | Type |
|---|---|---|
| token | {{accessCode}} | string |
LANGUAGE
CURL REQUEST
curl --request POST \
--url /accounts/business \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!