Skip to content
ApiqDevelopers
API v1.64.0Open console
API referenceidentity

Get certification

GET/v1/certification
Accepts X-Api-Key · oauthClientCredentials · bearer

Passive certification — the six integration checks observed from sandbox traffic

A check is passed only with the requestIds of the traffic that proved it; failed names the request that broke the rule (for example a blind retry after a price change).Show moreA check is passed only with the requestIds of the traffic that proved it; failed names the request that broke the rule (for example a blind retry after a price change). Rail step certification is done when every check is passed. Needs tenant:read, which the Owner and Admin role bundles carry; the users:manage fallback is retired; a human session or an API key. Check keys and states are x-extensible-enum.

Request body

This operation takes no request body.

Responses

  • 200Every check with its state and evidenceCertificationState
  • 401
    UNAUTHENTICATED — missing or expired token.Show moreUNAUTHENTICATED — missing or expired token. Declared on every operation because `security` is declared globally at the document root: every route is authenticated, so every route can answer 401.
    ApiErrorResponse
  • 403ApiErrorResponse
  • 405
    VALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge).Show moreVALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge). Not retryable as sent.
    ApiErrorResponse
  • 414
    VALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge).Show moreVALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge). Not retryable as sent: send long input in the body of a POST.
    ApiErrorResponse
  • 500INTERNAL — a bug, and traceId is the support handle.ApiErrorResponse

Errors you should handle

Branch on code and honour retryable — never on the HTTP status alone.

401UNAUTHENTICATED
The bearer token is expired. Re-authenticate and retry.
not retryable
403PERMISSION_DENIED
Reading wallets needs the finance:read permission.
not retryable
405VALIDATION
This method is not served.
not retryable
414VALIDATION
The request URI is longer than 8 KiB.
not retryable
500INTERNAL
An unexpected error occurred. Quote the traceId to support.
retryable