Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hifi Account API

Account endpoints

Hifi Account API is one of 15 APIs that Hifi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 2 paths, and defines 47 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against 2 base URLs: https://production.hifibridge.com, https://sandbox.hifibridge.com.

4 operations 2 paths 47 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://production.hifibridge.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Hifi Account API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Account 4

Account endpoints

POST
/v2/users/{userId}/accounts
Create an account
1 param body → 200401404500
GET
/v2/users/{userId}/accounts
List all accounts
7 params → 200401404500
GET
/v2/users/{userId}/accounts/{accountId}
Retrieve an account
2 params → 200401404500
DELETE
/v2/users/{userId}/accounts/{accountId}
Delete an account
2 params → 200401404500

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are CreateAccount (14 properties), AccountObject (10 properties), UsAccountObject (9 properties), UsAccount (9 properties). Each schema is shown below with its type and property counts.

UsAccountObject
object
9 properties
CreateArgentinaAccount
object
4 properties 4 required
CreateChinaGlobalNetworkAccountIndividual
object
4 properties 4 required
CreateAccount
object
14 properties 2 required
UsAccountHolder
object
3 properties 3 required
CreateChinaGlobalNetworkAccountBusiness
object
4 properties 4 required
GlobalNetworkIndividualAccountHolder
object
account holder information.
6 properties 6 required
AccountHolder
object
7 properties 2 required
NigeriaGlobalNetworkAccount
object
3 properties 1 required
CreateUsAccount
object
4 properties 4 required
CreateNigeriaGlobalNetworkAccountIndividual
object
4 properties 4 required
AfricaAccountHolder
object
7 properties 3 required
UsAccount
object
9 properties 4 required
CreateMexicoGlobalNetworkAccountBusiness
object
4 properties 4 required
ArgentinaAccount
object
3 properties 3 required
CreateSingaporeGlobalNetworkAccountBusiness
object
4 properties 4 required
MexicoAccount
object
4 properties 3 required
CreateBrazilGlobalNetworkAccountBusiness
object
4 properties 4 required
InternalServerError
object
1 property
CreateBrazilGlobalNetworkAccountIndividual
object
4 properties 4 required
CreateAfricaOnrampAccount
object
3 properties 3 required
CreateAccountObject
object
3 properties
CreateMexicoAccount
object
4 properties 4 required
Address
object
6 properties 5 required
BrazilAccount
object
2 properties 2 required
CreateBrazilAccount
object
3 properties 3 required
SingaporeGlobalNetworkAccount
object
4 properties 1 required
AccountTypeEnum
string
The type of account.
ColombiaAccountHolder
object
7 properties 5 required
CreateAfricaOfframpAccount
object
4 properties 4 required
AfricaAccount
object
5 properties 4 required
HongKongGlobalNetworkAccount
object
6 properties 4 required
Unauthorized
object
1 property
ColombiaAccount
object
5 properties 3 required
MexicoGlobalNetworkAccount
object
2 properties 1 required
CreateSingaporeGlobalNetworkAccountIndividual
object
4 properties 4 required
DeleteAccountObject
object
2 properties
CreateHongKongGlobalNetworkAccountIndividual
object
4 properties 4 required
CreateHongKongGlobalNetworkAccountBusiness
object
4 properties 4 required
CreateMexicoGlobalNetworkAccountIndividual
object
4 properties 4 required
CreateColombiaAccount
object
4 properties 4 required
ChinaGlobalNetworkAccount
object
4 properties 1 required
AccountObject
object
10 properties
AllAccountObjects
object
3 properties
CreateNigeriaGlobalNetworkAccountBusiness
object
4 properties 4 required
GlobalNetworkBusinessAccountHolder
object
5 properties 5 required
BrazilGlobalNetworkAccount
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hifi-account-api-openapi.yml Raw ↑

Other APIs Hifi publishes across the network.

Hifi Common API
Hifi Cross-Chain Bridge API
Hifi Crypto Transfer API
Hifi File API
Hifi Kyc API
Hifi Offramp API
Hifi Onramp API
Hifi Reporting API
Hifi Settlement Rules API
Hifi Token Swap API
Hifi Transfer Approvals API
Hifi User API