HIhifi
Kyc

Retrieve KYC requirements

Changed on

Get the required and optional KYC fields for a specific rail, along with any invalid KYC fields currently held by the user for unlocking the rail.

The Get KYC Requirements endpoint provides a comprehensive list of required and optional KYC fields needed to initiate a KYC submission (the same set of info available in our Compliance Guide). Additionally, it identifies any invalid fields in the user's current KYC data that need to be updated before submission. This is particularly useful for pre-filling KYC forms and addressing issues proactively.

This endpoint is intended only for use before KYC submission. After submitting KYC data, use the Retrieve KYC status endpoint to check the submission status and further identify any fields that may still require updates.

get/v2/users/{userId}/kyc/requirements

Request

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

Path parameters

userIdstring required

ID of the user

Query parameters

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

The type of rail.

Response

Success

OR

Changes

  • 319fa6bd5bc6Revision changes
    • breaking

      removed the enum value SOUTH_AMERICA_STANDARD from the query request parameter rails

    • breaking

      removed the enum value USD_FIAT from the query request parameter rails

    • info

      removed the SOUTH_AMERICA_STANDARD enum value from the / response property for the response status

    • info

      removed the SOUTH_AMERICA_STANDARD enum value from the / response property for the response status

    • info

      removed the USD_FIAT enum value from the / response property for the response status

    • info

      removed the USD_FIAT enum value from the / response property for the response status