How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.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.2.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
postV2UsersByUserIdKyc 1 param body → 200401404500
GET
/v2/users/{userId}/kyc
Retrieve KYC information
getV2UsersByUserIdKyc 1 param → 200401404500
GET
/v2/users/{userId}/kyc/requirements
Retrieve KYC requirements
getV2UsersByUserIdKycRequirements 2 params → 200401404500
POST
/v2/users/{userId}/kyc/submissions
Submit KYC
postV2UsersByUserIdKycSubmissions 1 param body → 200401404500
GET
/v2/users/{userId}/kyc/status
Retrieve KYC status
getV2UsersByUserIdKycStatus 2 params → 200401404500
GET
/v2/kyc/status
List all KYC statuses
getV2KycStatus 8 params → 200401404500
POST
/v2/kyc-link
Generate a KYC link
postV2KycLink body → 200401404500
POST
/v2/users/{userId}/kyc/ubos
Add a UBO
postV2UsersByUserIdKycUbos 1 param body → 200401404500
GET
/v2/users/{userId}/kyc/ubos
List all UBOs
getV2UsersByUserIdKycUbos 1 param → 200401404500
POST
/v2/users/{userId}/kyc/ubos/{uboId}
Update a UBO
postV2UsersByUserIdKycUbosByUboId 2 params body → 200401404500
GET
/v2/users/{userId}/kyc/ubos/{uboId}
Retrieve a UBO
getV2UsersByUserIdKycUbosByUboId 2 params → 200401404500
POST
/v2/users/{userId}/kyc/documents
Add documents
postV2UsersByUserIdKycDocuments 1 param body → 200401404500
GET
/v2/users/{userId}/kyc/documents
List all documents
getV2UsersByUserIdKycDocuments 1 param → 200401404500
POST
/v2/users/{userId}/kyc/documents/{documentId}
Update a document
postV2UsersByUserIdKycDocumentsByDocumentId 2 params body → 200401404500
GET
/v2/users/{userId}/kyc/documents/{documentId}
Retrieve a document
getV2UsersByUserIdKycDocumentsByDocumentId 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.

Address
object
6 properties 5 required
UltimateBeneficialOwner
object
38 properties
AfricaGeneralRailKycStatusObject
object
5 properties 5 required
GlobalNetworkRailKycStatusObject
object
5 properties 5 required
SofEuKycQuestionnaire
object
7 properties
SofEuKybQuestionnaire
object
12 properties
BusinessKycUpdate
object
56 properties
SouthAmericaRailKycSubmissionObject
object
1 property 1 required
Rails
object
1 property 1 required
UsdRailKycSubmissionObject
object
1 property 1 required
DocumentVerificationStatusObject
object
2 properties
AddressReqOptObject
object
2 properties
KycBusinessObject
object
2 properties
IndividualKycUpdate
object
39 properties
AfricaNigeriaRailKycStatusObject
object
5 properties 5 required
KycLinkObject
object
1 property
UboObjectList
object
2 properties
USDRailIndividualKYCReqOptObject
object
6 properties
BusinessDocumentUpdate
object
7 properties
AfricaGeneralRailKycSubmissionObject
object
1 property 1 required
AllKycStatusesObject
array
IndividualDocumentUpdate
object
7 properties
UboObject
object
GlobalNetworkRailKycSubmissionObject
object
1 property 1 required
USDRailBusinessKYCReqOptObject
object
6 properties
AfricaNigeriaRailKycSubmissionObject
object
1 property 1 required
UsdRailBusinessKycStatusObject
object
4 properties 4 required
ReviewDetailsIndividualObject
object
4 properties
KycRailStatusObject
object
3 properties
VerificationStatusObject
object
1 property
KycLinkForUnlockingRails
object
5 properties 2 required
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
KycIndividualObject
object
2 properties
UboAdd
object
3 required
SouthAmericaRailKycStatusObject
object
6 properties
USDRailBusinessDocReqOptObject
object
4 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…
ReviewResultObject
object
4 properties
KycLinkForUserCreation
object
5 properties 1 required
UsdRailIndividualKycStatusObject
object
4 properties 4 required
USDRailIndividualDocReqOptObject
object
2 properties
Unauthorized
object
1 property
IndividualDocumentAdd
array
An array of documents to be added.
DocumentObjectList
object
2 properties
SofEuQaKybReqOptObject
object
2 properties
RailsEnum
string
The type of rail.
SofEuQaKycReqOptObject
object
2 properties
ReviewDetailsBusinessObject
object
4 properties
DocumentObject
object
10 properties
BusinessDocumentAdd
array
An array of documents to be added.
InternalServerError
object
1 property
UboUpdate
object

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
Where this information came from

This is an independent, third-party profile of Hifi Kyc API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.