Skip to content

Validate Api Key

POST
/auth/api-keys/validate

Validate an API key.

This endpoint is used by consuming services to validate API keys. It does NOT require authentication (the API key is the credential).

Returns: Validation result with user_id, business_id, and scopes if valid

Note: This endpoint is public and should be rate-limited at the ALB/Cloudflare level.

ValidateAPIKeyRequest

Validate API key request.

object
key
required
Key

API key to validate

string

Successful Response

ValidateAPIKeyResponse

API key validation response.

object
valid
required
Valid
boolean
user_id
Any of:
string
business_id
Any of:
string
scopes
Scopes
Array<string>
default:

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object