HIhifi
Kyc

Submit KYC

Changed on

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.

post/v2/users/{userId}/kyc/submissions

Request

  • Base URL
    https://production.hifibridge.com
  • URL
    https://production.hifibridge.com/v2/users/{userId}/kyc/submissions
  • Auth
    HTTP bearer

Path parameters

userIdstring required

ID of the user

Request body

rails'USD' | 'AFRICA_GENERAL' | 'AFRICA_NIGERIA' | 'GLOBAL_NETWORK' required

The type of rail.

Response

Success

OR
OR
OR

Changes

  • 319fa6bd5bc6Revision changes
    • breaking

      removed the enum value SOUTH_AMERICA_STANDARD of the request property

    • breaking

      removed the enum value USD_FIAT of the request property

    • info

      removed from the response body oneOf list for the response status