Skip to main content
GET
/
addresses
/
fiat
Get all fiat addresses with status
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/addresses/fiat \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "bank_account_identifier": {
        "iban": "DE89370400440532013000",
        "type": "SEPA"
      },
      "bank_details": {
        "account_identifier": {
          "iban": "DE89370400440532013000",
          "type": "SEPA"
        },
        "address": {
          "city": "London",
          "country": {
            "code": "GB"
          },
          "postal_code": "SW1A 2AA",
          "state": "England",
          "street": "10 Downing Street"
        },
        "bank_address": null,
        "email_address": {
          "email": "john.doe@example.com"
        },
        "is_third_party": false,
        "phone_number": "+49-30-12345678",
        "provider_country": {
          "code": "DE"
        },
        "provider_name": "Iron Bank",
        "recipient": {
          "name": "Aperture Science",
          "type": "Business"
        }
      },
      "bank_name": "Iron Bank",
      "country": "DE",
      "created_at": "2024-01-15T10:30:00.000Z",
      "currency": "EUR",
      "customer_id": "123e4567-e89b-12d3-a456-426614174000",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "is_third_party": false,
      "label": "Primary Business Account",
      "ownership_verified": true,
      "status": "Registered",
      "updated_at": "1970-01-01T00:00:00.000Z"
    }
  ],
  "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prev_cursor": null
}

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the fiat addresses will be filtered for the sub-partner

Query Parameters

​
status
enum<string>

The Status to filter by. If not provided, defaults to Registered Verification Status

The status of the verification of a fiat address

Available options:
AuthorizationRequired,
AuthorizationFailed,
RegistrationPending,
RegistrationFailed,
Registered
​
cursor
string<uuid>

Paging: the cursor field from previous page

​
page_size
integer<uint32>
default:10

Paging: the requested page size (max 100)

Response

GET Addresses Succeeded

PagedList

A list of items with cursors used to fetch the next or previous page

​
items
FiatAddress · object[]
required

The list of items

​
cursor
string<uuid>

The cursor used to fetch the next page

​
prev_cursor
string<uuid>

The cursor used to fetch the previous page