Skip to main content
POST
/
v2
/
users
/
{userId}
/
accounts
Create an account
curl --request POST \
  --url https://production.hifibridge.com/v2/users/{userId}/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rail": "onramp",
  "type": "us",
  "accountHolder": {
    "type": "individual",
    "name": "<string>",
    "email": "[email protected]",
    "phone": "<string>",
    "address": {
      "addressLine1": "<string>",
      "city": "<string>",
      "stateProvinceRegion": "<string>",
      "postalCode": "<string>",
      "country": "<string>",
      "addressLine2": "<string>"
    },
    "idType": "CC",
    "idNumber": "<string>"
  },
  "us": {
    "transferType": "ach",
    "accountType": "Checking",
    "bankName": "<string>",
    "currency": "usd",
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>",
    "bankAddress": {
      "addressLine1": "<string>",
      "city": "<string>",
      "stateProvinceRegion": "<string>",
      "postalCode": "<string>",
      "country": "<string>",
      "addressLine2": "<string>"
    }
  },
  "africa": {
    "financialInstitute": "<string>",
    "accountType": "momo",
    "currency": "<string>",
    "country": "<string>",
    "accountNumber": "<string>"
  },
  "fiat": {
    "transferType": "ach",
    "accountType": "Checking",
    "bankName": "<string>",
    "currency": "usd",
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>",
    "bankAddress": {
      "addressLine1": "<string>",
      "city": "<string>",
      "stateProvinceRegion": "<string>",
      "postalCode": "<string>",
      "country": "<string>",
      "addressLine2": "<string>"
    }
  },
  "recipient": {
    "transferType": "ach",
    "accountType": "Checking",
    "bankName": "<string>",
    "currency": "usd",
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>",
    "bankAddress": {
      "addressLine1": "<string>",
      "city": "<string>",
      "stateProvinceRegion": "<string>",
      "postalCode": "<string>",
      "country": "<string>",
      "addressLine2": "<string>"
    }
  },
  "brazilGlobalNetwork": {
    "currency": "brl",
    "transferType": "pix",
    "email": "[email protected]",
    "phone": "<string>",
    "pix": "<string>"
  },
  "nigeriaGlobalNetwork": {
    "transferType": "bank",
    "bankName": "<string>",
    "accountNumber": "<string>",
    "currency": "ngn",
    "swiftCode": "<string>"
  },
  "mexicoGlobalNetwork": {
    "transferType": "spei",
    "currency": "mxn",
    "speiClabe": "<string>"
  },
  "hongKongGlobalNetwork": {
    "bankName": "<string>",
    "accountNumber": "<string>",
    "swiftCode": "<string>",
    "currency": "hkd",
    "bankCode": "<string>",
    "transferType": "chats"
  },
  "singaporeGlobalNetwork": {
    "transferType": "bank",
    "currency": "usd",
    "bankName": "<string>",
    "accountNumber": "<string>",
    "swiftCode": "<string>"
  },
  "italyGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "spainGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "germanyGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "franceGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "greatBritainGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "lithuaniaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "netherlandsGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "hungaryGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "greeceGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "austriaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "irelandGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "portugalGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "denmarkGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "norwayGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "croatiaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "slovakiaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "swedenGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "polandGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "sloveniaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "romaniaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "finlandGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "latviaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "czechRepublicGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "serbiaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "estoniaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "cyprusGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "japanGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "southAfricaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "chileGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "belgiumGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "thailandGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "indonesiaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "bulgariaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "icelandGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "luxembourgGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "maltaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "liechtensteinGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "southKoreaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "taiwanGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "colombiaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "argentinaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "kenyaGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  },
  "unitedArabEmiratesGlobalNetwork": {
    "transferType": "swift",
    "currency": "usd",
    "bankName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>"
  }
}
'
{
  "status": "ACTIVE",
  "message": "Account created successfully",
  "id": "583eb259-e78b-4f0c-a4b5-a8957876fa6f"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
userId
string
required

ID of the user

Body

application/json

Create an onramp or offramp account for different account types.

Note for fiat accounts: When type is fiat and rail is offramp, this adds an offramp beneficiary account to an existing fiat account. The user must have an active fiat account before adding a beneficiary.

​
rail
enum<string>
required
Available options:
onramp,
offramp
​
type
enum<string>
required

The type of account.

Available options:
us,
africa,
fiat,
recipient,
brazilGlobalNetwork,
nigeriaGlobalNetwork,
mexicoGlobalNetwork,
hongKongGlobalNetwork,
chinaGlobalNetwork,
singaporeGlobalNetwork,
italyGlobalNetwork,
spainGlobalNetwork,
germanyGlobalNetwork,
unitedArabEmiratesGlobalNetwork,
franceGlobalNetwork,
greatBritainGlobalNetwork,
lithuaniaGlobalNetwork,
netherlandsGlobalNetwork,
hungaryGlobalNetwork,
greeceGlobalNetwork,
austriaGlobalNetwork,
irelandGlobalNetwork,
portugalGlobalNetwork,
denmarkGlobalNetwork,
norwayGlobalNetwork,
croatiaGlobalNetwork,
slovakiaGlobalNetwork,
swedenGlobalNetwork,
polandGlobalNetwork,
sloveniaGlobalNetwork,
romaniaGlobalNetwork,
finlandGlobalNetwork,
latviaGlobalNetwork,
czechRepublicGlobalNetwork,
serbiaGlobalNetwork,
estoniaGlobalNetwork,
cyprusGlobalNetwork,
japanGlobalNetwork,
southAfricaGlobalNetwork,
chileGlobalNetwork,
belgiumGlobalNetwork,
thailandGlobalNetwork,
indonesiaGlobalNetwork,
bulgariaGlobalNetwork,
icelandGlobalNetwork,
luxembourgGlobalNetwork,
maltaGlobalNetwork,
liechtensteinGlobalNetwork,
southKoreaGlobalNetwork,
taiwanGlobalNetwork,
colombiaGlobalNetwork,
argentinaGlobalNetwork,
kenyaGlobalNetwork
​
accountHolder
Account Holder · object

account holder information.

​
us
Account Info · object

US account.

​
africa
Account Info · object

Africa account.

​
fiat
Account Info · object

Fiat account (uses us account schema).

​
recipient
Account Info · object

Recipient account (uses us account schema).

​
brazilGlobalNetwork
Brazil Global Network Account · object

Brazil Global Network account.

​
nigeriaGlobalNetwork
Nigeria Global Network Account · object

Nigeria Global Network account.

​
mexicoGlobalNetwork
Mexico Global Network Account · object

Mexico Global Network account.

​
hongKongGlobalNetwork
Hong Kong Global Network Account · object

Hong Kong Global Network account.

​
singaporeGlobalNetwork
Singapore Global Network Account · object

Singapore Global Network account.

​
italyGlobalNetwork
Italy Global Network Account · object

Italy Global Network account.

​
spainGlobalNetwork
Spain Global Network Account · object

Spain Global Network account.

​
germanyGlobalNetwork
Germany Global Network Account · object

Germany Global Network account.

​
franceGlobalNetwork
France Global Network Account · object

France Global Network account.

​
greatBritainGlobalNetwork
Great Britain Global Network Account · object

Great Britain Global Network account.

​
lithuaniaGlobalNetwork
Lithuania Global Network Account · object

Lithuania Global Network account.

​
netherlandsGlobalNetwork
Netherlands Global Network Account · object

Netherlands Global Network account.

​
hungaryGlobalNetwork
Hungary Global Network Account · object

Hungary Global Network account.

​
greeceGlobalNetwork
Greece Global Network Account · object

Greece Global Network account.

​
austriaGlobalNetwork
Austria Global Network Account · object

Austria Global Network account.

​
irelandGlobalNetwork
Ireland Global Network Account · object

Ireland Global Network account.

​
portugalGlobalNetwork
Portugal Global Network Account · object

Portugal Global Network account.

​
denmarkGlobalNetwork
Denmark Global Network Account · object

Denmark Global Network account.

​
norwayGlobalNetwork
Norway Global Network Account · object

Norway Global Network account.

​
croatiaGlobalNetwork
Croatia Global Network Account · object

Croatia Global Network account.

​
slovakiaGlobalNetwork
Slovakia Global Network Account · object

Slovakia Global Network account.

​
swedenGlobalNetwork
Sweden Global Network Account · object

Sweden Global Network account.

​
polandGlobalNetwork
Poland Global Network Account · object

Poland Global Network account.

​
sloveniaGlobalNetwork
Slovenia Global Network Account · object

Slovenia Global Network account.

​
romaniaGlobalNetwork
Romania Global Network Account · object

Romania Global Network account.

​
finlandGlobalNetwork
Finland Global Network Account · object

Finland Global Network account.

​
latviaGlobalNetwork
Latvia Global Network Account · object

Latvia Global Network account.

​
czechRepublicGlobalNetwork
Czech Republic Global Network Account · object

Czech Republic Global Network account.

​
serbiaGlobalNetwork
Serbia Global Network Account · object

Serbia Global Network account.

​
estoniaGlobalNetwork
Estonia Global Network Account · object

Estonia Global Network account.

​
cyprusGlobalNetwork
Cyprus Global Network Account · object

Cyprus Global Network account.

​
japanGlobalNetwork
Japan Global Network Account · object

Japan Global Network account.

​
southAfricaGlobalNetwork
South Africa Global Network Account · object

South Africa Global Network account.

​
chileGlobalNetwork
Chile Global Network Account · object

Chile Global Network account.

​
belgiumGlobalNetwork
Belgium Global Network Account · object

Belgium Global Network account.

​
thailandGlobalNetwork
Thailand Global Network Account · object

Thailand Global Network account.

​
indonesiaGlobalNetwork
Indonesia Global Network Account · object

Indonesia Global Network account.

​
bulgariaGlobalNetwork
Bulgaria Global Network Account · object

Bulgaria Global Network account.

​
icelandGlobalNetwork
Iceland Global Network Account · object

Iceland Global Network account.

​
luxembourgGlobalNetwork
Luxembourg Global Network Account · object

Luxembourg Global Network account.

​
maltaGlobalNetwork
Malta Global Network Account · object

Malta Global Network account.

​
liechtensteinGlobalNetwork
Liechtenstein Global Network Account · object

Liechtenstein Global Network account.

​
southKoreaGlobalNetwork
South Korea Global Network Account · object

South Korea Global Network account.

​
taiwanGlobalNetwork
Taiwan Global Network Account · object

Taiwan Global Network account.

​
colombiaGlobalNetwork
Colombia Global Network Account · object

Colombia Global Network account.

​
argentinaGlobalNetwork
Argentina Global Network Account · object

Argentina Global Network account.

​
kenyaGlobalNetwork
Kenya Global Network Account · object

Kenya Global Network account.

​
unitedArabEmiratesGlobalNetwork
United Arab Emirates Global Network Account · object

United Arab Emirates Global Network account.

Response

Success

​
status
string
​
message
string
​
id
string