The response tab lists field types, not an example payload. Actual values depend on customer state.
Request parameters
JSON body
programIduuidRequired
The programId value for this operation. Its accepted type and constraints are listed above and below.
requestIduuidRequired
Business request UUID. Reuse for retries of one operation; generate a new value for a new operation.
Response fields
Successful responses include requestId and scope. Use the actual business status or accepted field to determine the result. Optional fields are omitted when unavailable.
HTTP 200 · application/json
requestIduuidRequired
Server-generated HTTP request UUID. Include it when reporting a failed request.
scopeobjectRequired
The App and environment of this response. Headers only verify scope; they cannot switch key scope.
Show child fields
projectIdstringRequired
App ID bound to the credential.
minLength: 1
environmentenumRequired
Separate data scope: sandbox or live.
Show allowed values
"sandbox""live"
referralCodeobjectRequired
The referralCode value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
iduuidRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
programIduuidRequired
The programId value for this operation. Its accepted type and constraints are listed above and below.
codestringRequired
The code value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^[A-Z0-9][A-Z0-9_-]{2,31}$
createdAtdate-timeRequired
ISO 8601 UTC time when the record was created.
Handle errors
Common failures
Code
Recovery
UNAUTHENTICATED
Verify the key or refresh the expired customer token once.
FORBIDDEN
Check current key permissions and customer access.
INVALID_REQUEST
Check field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCH
Use the App and environment bound to the credential.
Common failures
UNAUTHENTICATED
Recovery
Verify the key or refresh the expired customer token once.
FORBIDDEN
Recovery
Check current key permissions and customer access.
INVALID_REQUEST
Recovery
Check field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCH
Recovery
Use the App and environment bound to the credential.