Get Customer Onboarding Progress Status
curl --request GET \
--url http://localhost:8080/api/v1/clients/{client_id}/onboarding/statusimport requests
url = "http://localhost:8080/api/v1/clients/{client_id}/onboarding/status"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8080/api/v1/clients/{client_id}/onboarding/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_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/clients/{client_id}/onboarding/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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 := "http://localhost:8080/api/v1/clients/{client_id}/onboarding/status"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/clients/{client_id}/onboarding/status")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/clients/{client_id}/onboarding/status")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"current_step": "DETAILS_PENDING",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kyc_status": "NOT_STARTED",
"overall_status": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"kyc_application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kyc_link": "<string>"
}Onboarding
Get Customer Onboarding Progress Status
Get a client’s onboarding progress: current step, overall completion, and KYC verification status.
GET
/
api
/
v1
/
clients
/
{client_id}
/
onboarding
/
status
Get Customer Onboarding Progress Status
curl --request GET \
--url http://localhost:8080/api/v1/clients/{client_id}/onboarding/statusimport requests
url = "http://localhost:8080/api/v1/clients/{client_id}/onboarding/status"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8080/api/v1/clients/{client_id}/onboarding/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_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/clients/{client_id}/onboarding/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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 := "http://localhost:8080/api/v1/clients/{client_id}/onboarding/status"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/clients/{client_id}/onboarding/status")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/clients/{client_id}/onboarding/status")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"current_step": "DETAILS_PENDING",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kyc_status": "NOT_STARTED",
"overall_status": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"kyc_application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kyc_link": "<string>"
}Path Parameters
Client UUID
Response
Onboarding status retrieved successfully
Onboarding Step - Current step in the onboarding process
Available options:
DETAILS_PENDING, KYC_PENDING, KYC_PROCESSING, KYC_UNDER_REVIEW, KYC_DECLINED, PENDING_APPROVAL, APPROVED Verification Status - Status of verifications
Available options:
NOT_STARTED, CREATED, PROCESSING, PENDING_REVIEW, VALIDATED, DECLINED, ABORTED