HIhifi
Kyc

Retrieve KYC status

Changed on

Get the user's latest KYC status for a specific rail after a KYC submission. If no KYC submission has been made for the rail, it will have an INACTIVE status.

The Get KYC Status endpoint provides the current KYC status of a rail, including details on any invalid or incomplete fields that may require updates. To address any invalid or incomplete fields, use the Update KYC endpoint, and then resubmit the data using the Submit KYC endpoint.

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

Request

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

Path parameters

userIdstring required

ID of the user

Query parameters

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

The type of rail.

Response

Success

OR
OR
OR
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 from the response body oneOf list for the response status