Skip to main content
PUT
/
authentication-codes
/
{id}
Submit an authentication code
curl --request PUT \
  --url https://api.sandbox.iron.xyz/api/authentication-codes/{id} \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>' \
  --data '{
  "code": 123
}'
{
  "attempts": 123,
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "Pending"
}

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
X-SUB-PARTNER-ID
string
required

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

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