Use this article to understand what your ROOK client_uuid identifies, how it relates to Sandbox and Production, and how it is used when integrating with the ROOK API.
What is a ROOK client UUID?
A ROOK client_uuid is a unique identifier in UUID4 format assigned to a ROOK client within a specific environment.
ROOK uses the client_uuid to identify which client and environment an integration or API request belongs to.
It also allows ROOK to associate users with the correct client configuration and environment.
Does Sandbox and Production use the same client UUID?
No. Sandbox and Production have separate client_uuid values.
Always use the client_uuid associated with the environment you are currently integrating with.
Important: Do not use a Sandbox client_uuid for Production requests or a Production client_uuid for Sandbox requests.
What is the client UUID used for?
The client_uuid allows ROOK to identify your client account and associate requests and users with the correct environment.
It is commonly used together with other ROOK credentials when interacting with the ROOK API.
For API endpoints that require Basic Authentication, the client_uuid is used together with your Secret Key.
Where can I find my client UUID?
You can find the client_uuid for the selected environment in the Credentials area of the ROOK Portal.
Before copying the value, confirm whether the portal is currently displaying Sandbox or Production.
Because each environment has its own client_uuid, switching environments will display the identifier associated with that environment.
Is the client UUID the same as the Secret Key?
No. The client_uuid and Secret Key serve different purposes.
The client_uuid identifies your ROOK client and environment.
The Secret Key is the confidential credential used to authenticate supported API requests.
For endpoints using Basic Authentication, both credentials are used together.
ROOK Portal: portal.tryrook.io