GET /widget/users/{id}/kyc-status
curl --request GET \
--url https://domain/widget/users/{partner_user_id}/kyc-status \
--header 'Authorization: <authorization>'import requests
url = "https://domain/widget/users/{partner_user_id}/kyc-status"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://domain/widget/users/{partner_user_id}/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://domain/widget/users/{partner_user_id}/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: <authorization>"
],
]);
$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://domain/widget/users/{partner_user_id}/kyc-status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://domain/widget/users/{partner_user_id}/kyc-status")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://domain/widget/users/{partner_user_id}/kyc-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"partner_user_id": "<string>",
"status": "<string>"
}API Reference
GET /widget/users/{id}/kyc-status
Check the identity-verification status of a user
GET
/
widget
/
users
/
{partner_user_id}
/
kyc-status
GET /widget/users/{id}/kyc-status
curl --request GET \
--url https://domain/widget/users/{partner_user_id}/kyc-status \
--header 'Authorization: <authorization>'import requests
url = "https://domain/widget/users/{partner_user_id}/kyc-status"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://domain/widget/users/{partner_user_id}/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://domain/widget/users/{partner_user_id}/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: <authorization>"
],
]);
$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://domain/widget/users/{partner_user_id}/kyc-status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://domain/widget/users/{partner_user_id}/kyc-status")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://domain/widget/users/{partner_user_id}/kyc-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"partner_user_id": "<string>",
"status": "<string>"
}Returns the identity-verification status for one of your users.
Path parameters
string
required
Your internal user identifier.
Headers
string
required
Bearer token. Format:
Bearer <client_token>.Response
string
Your internal user identifier (echo of the request).
Statuses
| Status | Meaning |
|---|---|
not_started | The user has never opened the widget or has not submitted documents |
pending | Documents submitted; under review |
verified | Verification passed; the user can transact |
failed | Verification failed; the user must retry inside the widget |
Examples
curl https://DOMAIN/widget/users/user-123/kyc-status \
-H "Authorization: Bearer <client_token>"
const kyc = await fetch(
"https://DOMAIN/widget/users/user-123/kyc-status",
{ headers: { "Authorization": "Bearer <client_token>" } }
).then(r => r.json());
if (kyc.status === "verified") {
showWidget();
} else {
showMessage("Please complete identity verification");
}
Response
{
"partner_user_id": "user-123",
"status": "verified"
}
Errors
| HTTP | error | code | Cause |
|---|---|---|---|
| 401 | unauthorised | invalid_token | Missing or inactive client_token |
| 404 | not_found | not_found | The partner_user_id is unknown for your partner |
| 502 | upstream_error | provider_error | Verification service failed; retry |