Skip to main content
GET
Get endorsement status

Authorizations

DPoP
string
header
required

Per-request RFC 9449 DPoP proof signed with ES256. Protected requests use Authorization: DPoP your_access_token_here. Create a new proof for the exact method and normalized target URI, and include the server nonce when challenged.

Authorization
string
header
required

OAuth 2.0 with RFC 9700 security practices. Discover exact environment endpoints from /.well-known/openid-configuration and /.well-known/oauth-authorization-server, and discover the resource from /.well-known/oauth-protected-resource. Authorization-code clients use PKCE S256, the exact environment resource, nonce with openid, and DPoP binding. Confidential clients also require PAR and private_key_jwt. Access and refresh tokens are sender-constrained with DPoP. purchases:execute is unavailable and omitted from this scope registry.

Headers

X-Request-Id
string

Optional caller request identifier. Unsafe values are replaced with a generated UUID.

Pattern: ^[A-Za-z0-9._~-]{8,128}$

Query Parameters

currency
string
required

The gated currency to inspect.

Pattern: ^[A-Z]{3}$

Response

The normalized endorsement status for the requested currency.

The gated-currency endorsement status without provider identifiers, session material, or hosted verification URLs.

currency
string
required

The gated currency the endorsement covers.

Pattern: ^[A-Z]{3}$
in_progress
boolean
required

Whether a provider endorsement is currently in progress.

phase
string | null
required

Normalized provider endorsement phase, or null when none was stated.

Required string length: 1 - 128
Pattern: ^[a-z0-9]+(?:[._-][a-z0-9]+)*$