Regenerate Business Key

Endpoint

Copy to Clipboard

Description

This endpoint regenerates a business key for an existing business. This is typically used when a business key needs to be rotated for security purposes or when the existing key has been compromised.

Request Details

Headers

Header Value  Required
accept */* Yes

Path Parameters

Parameter Type Required Description
businessFirsId string Yes The FIRS identification number for the business whose key needs to be regenerated. For example: 26ede24b-ac50-475f-aacc-5ea6339f0863

Request Body

This endpoint does not require a request body.

Request Example

Copy to Clipboard

Response

Response Status

  • 200 OK – Request successful

Response Body

Field Type Description
businessFirsId string The FIRS identification number for the business
businessKey string The newly 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 business FIRS ID format
404 Not Found – Business with the specified FIRS ID does not exist
401 Unauthorized – Authentication required
500 Internal Server Error – Server-side error occurred

Notes

  • Security Warning: Regenerating a business key will invalidate the previous key. Ensure all systems using the old key are updated with the new key to avoid service interruptions
  • The new business key should be stored securely and distributed only to authorized systems
  • It’s recommended to implement a key rotation schedule for enhanced security
  • Consider implementing a grace period where both old and new keys are valid during the transition
  • Log all key regeneration events for audit purposes

Responses

  • 200 OK