v25

OpenAPI 3.1.0raw.githubusercontent.com2026-08-014254240.1 KB

API Key

Introspect current API key

Returns the API key resource for the key authenticating this request. Useful for verifying which key is in use and discovering its current authorization context without inferring it from rejected requests.

get/v1/api_key

Response

The authenticated API key

type'api_key' required

Resource type discriminator.

idstring required

Unique identifier of the API key.

merchant_idstring required

Identifier of the merchant the key belongs to.

scopesstring[] required

The effective set of scopes for this key. Stored aliases (e.g. full_access, read_only) are always expanded to concrete resource:action scopes against the current registry before they appear here.

ip_allow_liststring[] required

IP addresses or CIDR ranges this key is permitted to authenticate from. An empty array means the key is not IP-restricted.

expires_atstring date-time nullable required

ISO 8601 UTC timestamp at which this key expires. null if the key has no expiry.

created_atstring date-time required

ISO 8601 UTC timestamp at which this key was created.

updated_atstring date-time nullable required

ISO 8601 UTC timestamp of the last update to this key (e.g. roll, IP allowlist change, revoke). null if the key has not been updated since creation.

api_versionstring required

Effective API version for the request (header value or merchant pin).