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 Kyc API is one of 15 APIs that Hifi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 15 operations across 10 paths, and defines 52 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.

15 operations 10 paths 52 schemas 8 GET7 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 Kyc API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 15

Across 10 paths, the API surfaces 15 operations — 8 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Kyc 15

Kyc endpoints

POST
/v2/users/{userId}/kyc
Update KYC information
1 param body → 200401404500
GET
/v2/users/{userId}/kyc
Retrieve KYC information
1 param → 200401404500
GET
/v2/users/{userId}/kyc/requirements
Retrieve KYC requirements
2 params → 200401404500
POST
/v2/users/{userId}/kyc/submissions
Submit KYC
1 param body → 200401404500
GET
/v2/users/{userId}/kyc/status
Retrieve KYC status
2 params → 200401404500
GET
/v2/kyc/status
List all KYC statuses
8 params → 200401404500
POST
/v2/kyc-link
Generate a KYC link
body → 200401404500
POST
/v2/users/{userId}/kyc/ubos
Add a UBO
1 param body → 200401404500
GET
/v2/users/{userId}/kyc/ubos
List all UBOs
1 param → 200401404500
POST
/v2/users/{userId}/kyc/ubos/{uboId}
Update a UBO
2 params body → 200401404500
GET
/v2/users/{userId}/kyc/ubos/{uboId}
Retrieve a UBO
2 params → 200401404500
POST
/v2/users/{userId}/kyc/documents
Add documents
1 param body → 200401404500
GET
/v2/users/{userId}/kyc/documents
List all documents
1 param → 200401404500
POST
/v2/users/{userId}/kyc/documents/{documentId}
Update a document
2 params body → 200401404500
GET
/v2/users/{userId}/kyc/documents/{documentId}
Retrieve a document
2 params → 200401404500

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are BusinessKycUpdate (56 properties), IndividualKycUpdate (39 properties), UltimateBeneficialOwner (38 properties), SofEuKybQuestionnaire (12 properties). Each schema is shown below with its type and property counts.

SofEuQaKycReqOptObject
object
2 properties
USDRailIndividualKYCReqOptObject
object
6 properties
KycBusinessObject
object
2 properties
IndividualKycUpdate
object
39 properties
DocumentObject
object
10 properties
ReviewResultObject
object
4 properties
KycLinkForUnlockingRails
object
5 properties 2 required
GlobalNetworkRailKycSubmissionObject
object
1 property 1 required
Rails
object
1 property 1 required
InternalServerError
object
1 property
UboObject
object
VerificationStatusObject
object
1 property
UsdRailBusinessKycStatusObject
object
4 properties 4 required
RailsEnum
string
The type of rail.
ReviewDetailsIndividualObject
object
4 properties
Address
object
6 properties 5 required
SouthAmericaRailKycSubmissionObject
object
1 property 1 required
KycLinkForUserCreation
object
5 properties 1 required
ReviewDetailsBusinessObject
object
4 properties
GlobalNetworkRailKycStatusObject
object
5 properties 5 required
AfricaNigeriaRailKycStatusObject
object
5 properties 5 required
UsdRailIndividualKycStatusObject
object
4 properties 4 required
UboAdd
object
3 required
UboUpdate
object
BusinessDocumentAdd
array
An array of documents to be added.
AfricaNigeriaRailKycSubmissionObject
object
1 property 1 required
USDRailBusinessDocReqOptObject
object
4 properties
Unauthorized
object
1 property
SofEuKybQuestionnaire
object
12 properties
BusinessKycUpdate
object
56 properties
UsdRailKycSubmissionObject
object
1 property 1 required
SouthAmericaRailKycStatusObject
object
6 properties
KycRailStatusObject
object
3 properties
UltimateBeneficialOwner
object
38 properties
AfricaGeneralRailKycStatusObject
object
5 properties 5 required
KycLinkObject
object
1 property
AllKycStatusesObject
array
DocGroupRequirementObject
object
Represents minimum document requirements for a specific rail. Each group specifies the minimum number of documents required from a list of accepted document ty…
2 properties
IndividualDocumentAdd
array
An array of documents to be added.
AfricaGeneralRailKycSubmissionObject
object
1 property 1 required
USDRailIndividualDocReqOptObject
object
2 properties
IndividualDocumentUpdate
object
7 properties
SofEuQaKybReqOptObject
object
2 properties
UboObjectList
object
2 properties
KycIndividualObject
object
2 properties
KycStatusEnum
string
Kyc Status - INACTIVE: No KYC submission has been made. - CREATED: KYC application has been submitted. - PENDING: Review in progress. - RFIPENDING: An RFI (Req…
DocumentObjectList
object
2 properties
USDRailBusinessKYCReqOptObject
object
6 properties
SofEuKycQuestionnaire
object
7 properties
BusinessDocumentUpdate
object
7 properties
AddressReqOptObject
object
2 properties
DocumentVerificationStatusObject
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hifi-kyc-api-openapi.yml Raw ↑

Other APIs Hifi publishes across the network.

Hifi Account API
Hifi Common API
Hifi Cross-Chain Bridge API
Hifi Crypto Transfer API
Hifi File 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