Request Business Key
Endpoint
Copy to Clipboard
Description
This endpoint requests a business key for a registered business entity. It requires business address details and FIRS (Federal Inland Revenue Service) credentials to authenticate and generate the business key.
Request Details
Headers
| Header | Value | Required |
|---|---|---|
| Content-Type | application/json | Yes |
| accept | */* | Yes |
Request Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| businessAddress | string | Yes | The full business address |
| businessAddressLg | string | Yes | Business address local government area |
| businessAddressStreetName | string | Yes | Street name of the business address |
| businessCity | string | Yes | City where the business is located |
| businessCountry | string | Yes | Country where the business is located |
| businessFirsId | string | Yes | FIRS identification number for the business |
| businessPostalCode | string | Yes | Postal/ZIP code of the business address |
| businessState | string | Yes | State/province where the business is located |
| contactEmail | string | Yes | Contact email address for the business |
| entityFirsId | string | Yes | FIRS identification number for the entity |
| firsApiKey | string | Yes | API key for FIRS authentication |
| firsApiSecret | string | Yes | API secret for FIRS authentication |
Request Example
Copy to Clipboard
Response
Response Status
Response Body
| Field | Type | Description |
|---|---|---|
| businessFirsId | string | The FIRS identification number for the business |
| businessKey | string | The generated business key for API authentication |
| responseCode | string | Status code indicating the result of the operation |
| responseMessage | string | Descriptive message about the operation result |
Response Example
Copy to Clipboard
Error Responses
The API may return error responses with appropriate HTTP status codes and error messages in the response body.
Common Error Codes
| Status Code | Description |
|---|---|
| 400 | Bad Request – Invalid input parameters |
| 401 | Unauthorized – Invalid FIRS credentials |
| 500 | Internal Server Error – Server-side error occurred |
Notes
- Ensure all FIRS credentials (firsApiKey and firsApiSecret) are kept secure and not exposed in client-side code
- The business key returned should be stored securely for subsequent API calls
- All string fields should be properly validated before submission
Body Params – application/json
Copy to Clipboard
