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

Retrieve KYC status

curl --request GET \
  --url https://production.hifibridge.com/v2/users/{userId}/kyc/status \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://production.hifibridge.com/v2/users/{userId}/kyc/status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://production.hifibridge.com/v2/users/{userId}/kyc/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://production.hifibridge.com/v2/users/{userId}/kyc/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://production.hifibridge.com/v2/users/{userId}/kyc/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://production.hifibridge.com/v2/users/{userId}/kyc/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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,

AFRICA_GENERAL,

AFRICA_NIGERIA,

GLOBAL_NETWORK

Response

Success

Kyc Status Object (USD - Individual)
Kyc Status Object (USD - Business)
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.
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.

Available options:

INACTIVE,

CREATED,

PENDING,

INCOMPLETE,

RFI_PENDING,

ACTIVE,

REJECTED,

CONTACT_SUPPORT

message

string

required

reviewResult

Review Result · object

required

Show child attributes

details

Review Details Individual · object

required

Show child attributes

⌘I

Retrieve KYC status

curl --request GET \
  --url https://production.hifibridge.com/v2/users/{userId}/kyc/status \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://production.hifibridge.com/v2/users/{userId}/kyc/status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://production.hifibridge.com/v2/users/{userId}/kyc/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://production.hifibridge.com/v2/users/{userId}/kyc/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://production.hifibridge.com/v2/users/{userId}/kyc/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://production.hifibridge.com/v2/users/{userId}/kyc/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "INACTIVE",
  "message": "The rail is not active."
}