A valid request URL is required to generate request examples{
"organization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "live"
},
"api_key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prefix": "<string>"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Identify the API key
The first call an integrator makes to check that their key works. The environment reported here is the one the key belongs to — no header or parameter can name a different one, which is what makes test data unreachable with a live key and vice versa.
A valid request URL is required to generate request examples{
"organization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "live"
},
"api_key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prefix": "<string>"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
An organization API key, uk_sk_live_… or uk_sk_test_…. The environment is resolved from the stored key row on every request, never from a request parameter.
Every route behind this credential is rate limited per key — 1000 requests a minute — with a second ceiling of 3000 a minute across all the keys of one environment, so splitting your traffic across keys isolates it and minting more keys does not buy more of it. A test key can never spend a live key's allowance. Every response carries the current state in headers; see the rate-limits guide.