Skip to main content
GET
/
v2
/
users
/
{userId}
/
kyc
/
status
Retrieve KYC status
curl --request GET \
  --url https://production.hifibridge.com/v2/users/{userId}/kyc/status \
  --header 'Authorization: Bearer <token>'
{
  "status": "INACTIVE",
  "message": "The rail is not active."
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
userId
string
required

ID of the user

Query Parameters

​
rails
enum<string>

The type of rail.

Available options:
USD,
SOUTH_AMERICA_STANDARD,
AFRICA_GENERAL,
AFRICA_NIGERIA,
GLOBAL_NETWORK

Response

Success

  • Kyc Status Object (USD - Individual)
  • Kyc Status Object (USD - Business)
  • KYC Status Object (SOUTH_AMERICA_STANDARD)
  • Kyc Status Object (AFRICA_GENERAL)
  • Kyc Status Object (AFRICA_NIGERIA)
  • Kyc Status Object (GLOBAL_NETWORK)
​
status
enum<string>
required

Kyc Status

  • INACTIVE: No KYC submission has been made.
  • CREATED: KYC application has been submitted.
  • PENDING: Review in progress.
  • INCOMPLETE: RFI or resubmission required.
  • ACTIVE: User approved and onboarded.
  • REJECTED: KYC application rejected.
  • CONTACT_SUPPORT: Unexpected issue encountered during KYC review.
Available options:
INACTIVE,
CREATED,
PENDING,
INCOMPLETE,
ACTIVE,
REJECTED,
CONTACT_SUPPORT
​
message
string
required
​
reviewResult
object
required
​
details
object
required
⌘I