Business Settings - Update
POST
{{baseUrl}}/{{stage}}/external/businesses/{{businessID}}/settings
Update Business Settings
POST {{baseUrl}}/{{stage}}/external/businesses/{{businessID}}/settingsRequest
Headers
| Header | Value | Required |
|---|---|---|
X-Business-Key | businessKey | ✅ |
Content-Type | application/json | ✅ |
Path Parameters
| Parameter | Type | Description |
|---|---|---|
businessID | string | Your business NRS ID |
Body Parameters
| Parameter | Type | Description |
|---|---|---|
webhookUrl | string | HTTPS URL to receive invoice notifications (B2B transmissions, status updates) |
webhookAuth | string | Authentication token/header value for webhook requests |
qrCodePublicKey | string | Public key for QR code validation on invoices |
qrCodeCertificate | string | Certificate for QR code generation |
Field Details
webhookAuth sent as Authorization header in webhook requests to your endpointThe Nigeria Revenue Service (NRS) issues cryptographic key pairs to each taxpayer for invoice QR code generation.
Key File Contents
.txt file contains the following:Retrieving Your Keys
API Configuration
business-settings endpoint.Response
Success (200)
{
"responseCode": "00",
"responseMessage": "Completed successfully"
}| Field | Description |
|---|---|
responseCode | 00 = success, 106 = validation failed |
responseMessage | Success / Failed response |
Errors
{
"responseCode": "106",
"responseMessage": "Validation failed: webhookUrl must be a valid HTTPS URL"
}{
"responseCode": "03",
"responseMessage": "Invalid or expired business key"
}{
"responseCode": "02",
"responseMessage": "Business not found with ID: {businessID}"
}businessID in URL matches your registered NRS ID{
"responseCode": "99",
"responseMessage": "An internal error occurred while updating settings",
"requestId": "req_xyz123"
}requestId if persistent.Example Requests
Webhook Configuration
{
"event": "invoice.transmitted",
"data": {
"invoiceIRN": "IRN_7H3K9M2P4S6V8X1Z",
"status": "TRANSMITTED"
}
}webhookAuth headerCommon Issues
"Invalid certificate" → Use PEM format with BEGIN/END markers
"Logo not displaying" → Verify URL is publicly accessible
Webhook not firing → Check endpoint returns 200 and auth is correct
Security Notes
webhookAuth securely, rotate regularly⚠️ Protect private keys for QR certificates
⚠️ All URLs must use HTTPS
⚠️ Validate webhook payloads before processing
Request
Header Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '{{baseUrl}}/{{stage}}/external/businesses/{{businessID}}/settings' \
--header 'X-Business-Key: {{businessKey}}' \
--header 'Content-Type: application/json' \
--data '{
"webhookUrl": "",
"webhookAuth": "",
"qrCodePublicKey": "",
"qrCodeCertificate": ""
}'Response Response Example
{}Modified at 2026-08-21 08:48:10