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

Mfa webauthn options

POST/v1/auth/mfa/webauthn/registration-options
Idempotency-Key requiredAccepts bearer

WebAuthn registration options

Send {}. Idempotency-Key required.

Headers

  • Idempotency-KeystringRequired
    Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 IDEMPOTENCY_CONFLICT; in-flight duplicate…Show moreMandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 IDEMPOTENCY_CONFLICT; in-flight duplicate is 409 IDEMPOTENCY_IN_PROGRESS.

Request body

    Responses

    • 200OptionsMfaWebauthnOptions
    • 400VALIDATION or UNKNOWN_DOMAINApiErrorResponse
    • 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
    • 403
      AGENT_TIER_INSUFFICIENT, also 403, is a request whose agent tier does not allow the tool class; it carries nextAction verify_agent and details.tier, details.required, details.toolClass and…Show moreAGENT_TIER_INSUFFICIENT, also 403, is a request whose agent tier does not allow the tool class; it carries nextAction verify_agent and details.tier, details.required, details.toolClass and details.operationId. A ceiling only narrows an unverified caller and never widens a scope.
      ApiErrorResponse
    • 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
    • 413
      VALIDATION — the request body is larger than the surface's limit.Show moreVALIDATION — the request body is larger than the surface's limit. Not retryable as sent: shrink the body. Declared on every operation that takes a request body. details carries exactly one key, maxBodyBytes (integer): the limit that applies to this surface, in bytes.
      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
    • 415
      VALIDATION — a request body that is not JSON (application/json or application/*+json; a form body only on the OAuth token routes).Show moreVALIDATION — a request body that is not JSON (application/json or application/*+json; a form body only on the OAuth token routes). The public edge refuses it before the platform sees it (details.reason UNSUPPORTED_MEDIA_TYPE, details.source edge). Not retryable as sent: send Content-Type application/json. Declared on every operation that takes a JSON request body.
      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.

    400VALIDATION
    message.intent.checkOut must be after message.intent.checkIn
    not retryable
    400UNKNOWN_DOMAIN
    Unknown domain 'HOTELS'. Did you mean HTL?
    not retryable
    401UNAUTHENTICATED
    The bearer token is expired. Re-authenticate and retry.
    not retryable
    403PERMISSION_DENIED
    Role lacks the required scope: booking:write
    not retryable
    403TAB_DISABLED
    Tenant acme-travel is not entitled to sell CRU
    not retryable
    403OUT_OF_SCOPE
    The token's scope ladder does not reach this customer subtree
    not retryable
    403TENANT_MISMATCH
    orderRef MO-8KD-2FQ-9XT does not belong to tenant acme-travel
    not retryable
    405VALIDATION
    This method is not served.
    not retryable
    413VALIDATION
    The request body is larger than this API accepts (262144 bytes).
    not retryable
    414VALIDATION
    The request URI is longer than 8 KiB.
    not retryable
    415VALIDATION
    Send application/json.
    not retryable
    500INTERNAL
    An unexpected error occurred. Quote the traceId to support.
    retryable