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",
    "currency": "ngn",
    "bankName": "<string>",
    "accountNumber": "<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>"
  },
  "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
​
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.

​
unitedArabEmiratesGlobalNetwork
United Arab Emirates Global Network Account · object

United Arab Emirates Global Network account.

Response

Success

​
status
string
​
message
string
​
id
string