Skip to navigation

Introspect API key

For gateways validating raw API keys; this does not introspect JWT or OAuth access tokens. Invalid/missing keys return 200 with active: false. An internal fault returns 503 with error: service_unavailable and Retry-After, never active: false, so retry rather than reject the key. Accepts JSON or form-encoded token. Limits are 120 requests/minute independently per trusted client IP and matched API key.

Request

This endpoint expects an object.
tokenstringRequired

Raw sk_live_* or sk_test_* API key, not an exchanged JWT.

Response

Success
activeboolean
client_idstring or nullOptional
token_typeenumOptional
Allowed values:
scopestringOptional
org_idstringOptional
user_idstring or nullOptional
api_key_idintegerOptional
errorstringOptional

Errors

429
Too Many Requests Error
503
Service Unavailable Error