Register a fiat bank account for a customer.

curl --request POST \
  --url https://api.sandbox.iron.xyz/api/addresses/fiat \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'IDEMPOTENCY-KEY: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>' \
  --data '
{
  "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"
    }
  },
  "currency": {
    "code": "USD"
  },
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>"
}
'

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

POST

addresses

fiat

curl --request POST \
  --url https://api.sandbox.iron.xyz/api/addresses/fiat \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'IDEMPOTENCY-KEY: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>' \
  --data '
{
  "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"
    }
  },
  "currency": {
    "code": "USD"
  },
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>"
}
'

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

Authorizations

X-API-Key

string

header

required

API Key

Headers

IDEMPOTENCY-KEY

string

required

a UUID ensuring an address is only registered once

X-SUB-PARTNER-ID

string

required

Optional sub-partner UUID, if provided, the fiat address will be registered for the sub-partner

Body

application/json; charset=utf-8

The fiat address registration request

Request to register a fiat (bank) address

bank_details

RecipientBankAccount · object

required

RecipientBankAccount

A recipient fiat bank account

Show child attributes

bank_details.account_identifier

Iban · object

required

Iban
BankAccountACHIdentifier
BankAccountWireIdentifier
BankAccountRTPIdentifier
BankAccountSWIFTIdentifier
BankAccountCHAPSIdentifier
BankAccountFPSIdentifier

Show child attributes

bank_details.account_identifier.type

enum<string>

required

Available options:

SEPA

Example:

"SEPA"

bank_details.account_identifier.iban

string

required

Example:

{ "iban": "DE89370400440532013000" }

bank_details.address

RecipientPostalAddress · object

required

RecipientPostalAddress

The account holder's address.

Show child attributes

bank_details.address.city

string

required

The city

bank_details.address.country

Country · object

required

A country

Show child attributes

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

bank_details.address.postal_code

string

required

The postal code

bank_details.address.state

string

required

The state

bank_details.address.street

string

required

The street address

bank_details.is_third_party

boolean

required

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

bank_details.provider_country

Country · object

required

A country

Show child attributes

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

bank_details.provider_name

string

required

The name of the provider of the recipient's account

bank_details.recipient

IndividualName · object

required

IndividualName
BusinessName

Show child attributes

bank_details.recipient.type

enum<string>

required

Available options:

Individual

Example:

"Individual"

bank_details.recipient.family_name

string

required

bank_details.recipient.given_name

string

required

Example:

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

bank_details.email_address

EmailAddress · object

EmailAddress

An email address An email address

Show child attributes

bank_details.email_address.email

string

required

The email address

Example:

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

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

currency

Fiat · object

required

A fiat currency

Show child attributes

currency.code

string

required

The code of the currency e.g. 'USD'

Example:

{ "code": "USD" }

customer_id

string<uuid>

required

The customer ID

label

string

Optional label for the address

Response

Registration successful

Fiat Address

Response containing fiat address details

bank_account_identifier

Iban · object

required

Iban
BankAccountACHIdentifier
BankAccountWireIdentifier
BankAccountRTPIdentifier
BankAccountSWIFTIdentifier
BankAccountCHAPSIdentifier
BankAccountFPSIdentifier

Show child attributes

bank_account_identifier.type

enum<string>

required

Available options:

SEPA

Example:

"SEPA"

bank_account_identifier.iban

string

required

Example:

{ "iban": "DE89370400440532013000" }

bank_details

RecipientBankAccount · object

required

RecipientBankAccount

A recipient fiat bank account

Show child attributes

bank_details.account_identifier

Iban · object

required

Iban
BankAccountACHIdentifier
BankAccountWireIdentifier
BankAccountRTPIdentifier
BankAccountSWIFTIdentifier
BankAccountCHAPSIdentifier
BankAccountFPSIdentifier

Show child attributes

bank_details.account_identifier.type

enum<string>

required

Available options:

SEPA

Example:

"SEPA"

bank_details.account_identifier.iban

string

required

Example:

{ "iban": "DE89370400440532013000" }

bank_details.address

RecipientPostalAddress · object

required

RecipientPostalAddress

The account holder's address.

Show child attributes

bank_details.address.city

string

required

The city

bank_details.address.country

Country · object

required

A country

Show child attributes

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

bank_details.address.postal_code

string

required

The postal code

bank_details.address.state

string

required

The state

bank_details.address.street

string

required

The street address

bank_details.is_third_party

boolean

required

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

bank_details.provider_country

Country · object

required

A country

Show child attributes

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

bank_details.provider_name

string

required

The name of the provider of the recipient's account

bank_details.recipient

IndividualName · object

required

IndividualName
BusinessName

Show child attributes

bank_details.recipient.type

enum<string>

required

Available options:

Individual

Example:

"Individual"

bank_details.recipient.family_name

string

required

bank_details.recipient.given_name

string

required

Example:

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

bank_details.email_address

EmailAddress · object

EmailAddress

An email address An email address

Show child attributes

bank_details.email_address.email

string

required

The email address

Example:

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

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

bank_name

string

required

The bank name

country

string

required

The country code

created_at

string<date-time>

required

When the address was created

currency

string

required

The currency of the bank account

customer_id

string<uuid>

required

The customer ID

string<uuid>

required

The ID of the address

is_third_party

boolean

required

Is this a third party fiat address

ownership_verified

boolean

required

Has the customer verified their ownership of this account

status

enum<string>

required

Verification Status

The status of the verification of a fiat address

Available options:

AuthorizationRequired,

AuthorizationFailed,

RegistrationPending,

RegistrationFailed,

Registered

updated_at

string<date-time>

required

When the address was last updated

label

string

Optional label for the address

Get all fiat addresses with status

Get all fiat addresses / bank accounts

⌘I

Iron API - Sandbox

Authorizations

Headers

Body

Response