Skip to main content
POST
/
autoramps
/
{autoramp_id}
/
retry-auth
Retry authentication
curl --request POST \
  --url https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/retry-auth \
  --header 'IDEMPOTENCY-KEY: <idempotency-key>' \
  --header 'X-API-Key: <api-key>'
{
  "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

​
IDEMPOTENCY-KEY
string
required

a UUID ensuring an Autoramp operation is only processed once

Path Parameters

​
autoramp_id
string<uuid>
required

the autoramp ID

Response

Authorization of autoramp 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