Skip to main content
GET
/
authentication-codes
/
entity
/
{id}
Get the pending authentication code for an entity
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/authentication-codes/entity/{id} \
  --header 'X-API-Key: <api-key>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>'
{
  "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 filtered for the sub-partner

Path Parameters

​
id
string<uuid>
required

The ID of the entity to get the pending authentication code for

Response

GET 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