Skip to main content
GET
Verify the caller credential

Headers

x-api-key
string
x-signature
string
required

Required for API-key authenticated requests. HMAC-SHA256(secretKey, timestamp + METHOD + path + body) as lowercase hex. Omit only for JWT/OAuth session tokens or public routes.

x-timestamp
string
required

Required with x-signature. Epoch milliseconds; rejected if drift exceeds 5 minutes. Omit only for JWT/OAuth session tokens or public routes.

Response

authenticated
boolean
required
Example:

true

authMethod
enum<string>
required
Available options:
oauth,
apiKey,
jwt
userId
string
required
scopes
string[]
required
clientId
string | null
required

OAuth client the token was issued to; null for API keys and JWTs.

expiresAt
string | null
required

ISO expiry; null when the credential does not expire.

isDeveloper
boolean
required

True when the user has an active developer registration. Webhook agents need it to receive signals.

developerStatus
enum<string> | null
required
Available options:
pending,
active,
suspended