Get all fiat addresses / bank accounts

curl --request GET \
  --url https://api.sandbox.iron.xyz/api/addresses/fiat/{customer_id} \
  --header 'X-API-Key: <api-key>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>'

{
  "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"
        },
        "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
}

GET

addresses

fiat

{customer_id}

Get all fiat addresses / bank accounts

curl --request GET \
  --url https://api.sandbox.iron.xyz/api/addresses/fiat/{customer_id} \
  --header 'X-API-Key: <api-key>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>'

{
  "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"
        },
        "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

required

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

Path Parameters

customer_id

string

required

the ID of the customer

Query Parameters

cursor

string<uuid>

Paging: the cursor field from previous page

page_size

integer<uint32>

default:10

Paging: the requested page size (max 100)

search_term

string

A search term to filter the addresses

Maximum string length: 256

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

Show child attributes

items.bank_account_identifier

Iban · object

required

Iban
BankAccountACHIdentifier
BankAccountWireIdentifier
BankAccountRTPIdentifier
BankAccountSWIFTIdentifier
BankAccountCHAPSIdentifier
BankAccountFPSIdentifier

Show child attributes

items.bank_account_identifier.type

enum<string>

required

Available options:

SEPA

Example:

"SEPA"

items.bank_account_identifier.iban

string

required

Example:

{ "iban": "DE89370400440532013000" }

items.bank_details

RecipientBankAccount · object

required

RecipientBankAccount

A recipient fiat bank account

Show child attributes

items.bank_details.account_identifier

Iban · object

required

Iban
BankAccountACHIdentifier
BankAccountWireIdentifier
BankAccountRTPIdentifier
BankAccountSWIFTIdentifier
BankAccountCHAPSIdentifier
BankAccountFPSIdentifier

Show child attributes

items.bank_details.account_identifier.type

enum<string>

required

Available options:

SEPA

Example:

"SEPA"

items.bank_details.account_identifier.iban

string

required

Example:

{ "iban": "DE89370400440532013000" }

items.bank_details.address

RecipientPostalAddress · object

required

RecipientPostalAddress

The account holder's address.

Show child attributes

items.bank_details.address.city

string

required

The city

items.bank_details.address.country

Country · object

required

A country

Show child attributes

items.bank_details.address.country.code

string

required

The ISO_3166-1 Alpha-2 country code, e.g. "DE"

Required string length: 2

Example:

{ "code": "DE" }

items.bank_details.address.postal_code

string

required

The postal code

items.bank_details.address.state

string

required

The state

items.bank_details.address.street

string

required

The street address

items.bank_details.is_third_party

boolean

required

Is this a users fiat bank account or a third party fiat bank account

items.bank_details.provider_country

Country · object

required

A country

Show child attributes

items.bank_details.provider_country.code

string

required

The ISO_3166-1 Alpha-2 country code, e.g. "DE"

Required string length: 2

Example:

{ "code": "DE" }

items.bank_details.provider_name

string

required

The name of the provider of the recipient's account

items.bank_details.recipient

IndividualName · object

required

IndividualName
BusinessName

Show child attributes

items.bank_details.recipient.type

enum<string>

required

Available options:

Individual

Example:

"Individual"

items.bank_details.recipient.family_name

string

required

items.bank_details.recipient.given_name

string

required

Example:

{
  "family_name": "Turing",
  "given_name": "Alan"
}

items.bank_details.email_address

EmailAddress · object

EmailAddress

An email address An email address

Show child attributes

items.bank_details.email_address.email

string

required

The email address

Example:

{ "email": "john.doe@example.com" }

items.bank_details.phone_number

string

The recipient's phone number. Required for USD accounts.

Example:

{
  "account_identifier": {
    "iban": "DE89370400440532013000",
    "type": "SEPA"
  },
  "address": {
    "city": "London",
    "country": { "code": "GB" },
    "postal_code": "SW1A 2AA",
    "state": "England",
    "street": "10 Downing Street"
  },
  "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"
  }
}

items.bank_name

string

required

The bank name

items.country

string

required

The country code

items.created_at

string<date-time>

required

When the address was created

items.currency

string

required

The currency of the bank account

items.customer_id

string<uuid>

required

The customer ID

items.id

string<uuid>

required

The ID of the address

items.is_third_party

boolean

required

Is this a third party fiat address

items.ownership_verified

boolean

required

Has the customer verified their ownership of this account

items.status

enum<string>

required

Verification Status

The status of the verification of a fiat address

Available options:

AuthorizationRequired,

AuthorizationFailed,

RegistrationPending,

RegistrationFailed,

Registered

items.updated_at

string<date-time>

required

When the address was last updated

items.label

string

Optional label for the address

cursor

string<uuid>

The cursor used to fetch the next page

prev_cursor

string<uuid>

The cursor used to fetch the previous page

Get a specific fiat address

⌘I

Iron API - Sandbox

Authorizations

Headers

Path Parameters

Query Parameters

Response