Skip to main content
PUT
Submit an authentication code

Authorizations

X-API-Key
string
header
required

API Key

Headers

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the authentication code will be submitted under scope of the sub-partner

X-API-Version
string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01.

Path Parameters

id
string<uuid>
required

The ID of the authentication code to submit

Body

application/json; charset=utf-8

The authentication code to submit

Authentication Code Params

Parameters for submitting an authentication code

code
integer<int32>
required

The code to submit

Response

PUT Authentication Code Succeeded

An authentication code

used to confirm a 2FA action

attempts
integer<int32>
required

attempts to submit the authentication code

entity_id
string<uuid>
required

the ID of the entity the authentication is related to

expires_at
string<date-time>
required

the time of expiry for the authentication code

id
string<uuid>
required

The ID of the authentication code

status
enum<string>
required

The status of the Authentication Code

Available options:
Pending,
Expired,
Confirmed,
Rejected