Kyc

Retrieve KYC status

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
Auth
HTTP bearer
TypeScript
https://skmtc.dev/hifibridge/apis/hifi-api/docs/v2/users/:userId/kyc/status/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userIdstring required

ID of the user

Query parameters

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

The type of rail.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.