Endpoints
- GETList all KYC statuses
- GETRetrieve KYC information
- GETRetrieve KYC status
- GETRetrieve KYC requirements
- GETList all documents
- GETRetrieve a document
- GETList all UBOs
- GETRetrieve a UBO
- POSTGenerate a KYC link
- POSTUpdate KYC information
- POSTSubmit KYC
- POSTAdd documents
- POSTUpdate a document
- POSTAdd a UBO
- POSTUpdate a UBO
- GET
curl --request POST \
--url https://production.hifibridge.com/v2/users/{userId}/kyc/submissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"rails": "USD"
}'{
"USD": {
"status": "CREATED",
"message": "Your KYC application has been successfully created. We will review it shortly."
}
}Submit KYC
Submit the user’s current KYC data to unlock a specific rail. Any updates to the user’s KYC data prior to submission should be made using the Update KYC endpoint.)
The KYC data will only be submitted if all the required KYC fields for the rail are provided. If any required fields are missing, no submission will occur, and the user must supply the missing information using the Update KYC endpoint.
A successful submission is confirmed when the response includes a KYC status object. If no such object is returned, the submission did not occur.
For more details on required and optional KYC fields for unlocking each rail, visit our KYC Rails Requirement page. To learn more about KYC, our KYC endpoints, and an example flow for unlocking a rail, see our KYC Overview page.
curl --request POST \
--url https://production.hifibridge.com/v2/users/{userId}/kyc/submissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"rails": "USD"
}'{
"USD": {
"status": "CREATED",
"message": "Your KYC application has been successfully created. We will review it shortly."
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the user
Body
The type of rail.
USD, SOUTH_AMERICA_STANDARD, AFRICA_GENERAL, AFRICA_NIGERIA, GLOBAL_NETWORK Response
Success
- Kyc Submission Object (USD)
- Kyc Submission Object (SOUTH_AMERICA_STANDARD)
- Kyc Submission Object (AFRICA_GENERAL)
- Kyc Submission Object (AFRICA_NIGERIA)
- Kyc Submission Object (GLOBAL_NETWORK)
Show child attributes
Show child attributes
Kyc Status
INACTIVE: No KYC submission has been made.CREATED: KYC application has been submitted.PENDING: Review in progress.RFI_PENDING: An RFI (Request for Information) email has been sent and is pending user response.INCOMPLETE: RFI or resubmission required.ACTIVE: User approved and onboarded.REJECTED: KYC application rejected.CONTACT_SUPPORT: Unexpected issue encountered during KYC review.
INACTIVE, CREATED, PENDING, INCOMPLETE, RFI_PENDING, ACTIVE, REJECTED, CONTACT_SUPPORT