HIhifi
Kyc

List all KYC statuses

Changed on

List all KYC statuses based on the provided filters.

get/v2/kyc/status

Request

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

Query parameters

userIdstring

The user ID.

userNamestring
userEmailstring
rails'USD' | 'AFRICA_GENERAL' | 'AFRICA_NIGERIA' | 'GLOBAL_NETWORK'

The type of rail.

statusKycStatusEnum[]

The statuses of the KYC.

limitstring

default to 10, maximum to 100

createdBeforestring date

ISO format: YYYY-MM-DD

createdAfterstring date

ISO format: YYYY-MM-DD

Response

Success

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

The type of rail.

createdAtstring date-time
updatedAtstring date-time
status'INACTIVE' | 'CREATED' | 'PENDING' | 'INCOMPLETE' | 'RFI_PENDING' | 'ACTIVE' | 'REJECTED' | 'CONTACT_SUPPORT'

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.

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 USD_FIAT enum value from the / response property for the response status