Retry authentication

Retry the authentication process on a failed autoramp

POST /autoramps/{autoramp_id}/retry-auth

Retry authentication

cURL

curl --request POST \
  --url https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/retry-auth \
  --header 'IDEMPOTENCY-KEY: <idempotency-key>'

import requests

url = "https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/retry-auth"

headers = {"IDEMPOTENCY-KEY": "<idempotency-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'IDEMPOTENCY-KEY': '<idempotency-key>'}};

fetch('https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/retry-auth', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/retry-auth",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "IDEMPOTENCY-KEY: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/retry-auth"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("IDEMPOTENCY-KEY", "<idempotency-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/retry-auth")
  .header("IDEMPOTENCY-KEY", "<idempotency-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/retry-auth")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["IDEMPOTENCY-KEY"] = '<idempotency-key>'

response = http.request(request)
puts response.read_body

201

{
  "attempts": 123,
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

"<string>"

"<string>"

{
  "message": "<string>",
  "trace_id": "<string>"
}

Headers

IDEMPOTENCY-KEY · string · required

a UUID ensuring an Autoramp operation is only processed once

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

autoramp_id · string<uuid> · required

the autoramp ID

Response

201

application/json; charset=utf-8

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