Get overview
curl --request GET \
--url https://api.enterprise.sandbox.uphold.com/core/kyb \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.enterprise.sandbox.uphold.com/core/kyb"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.enterprise.sandbox.uphold.com/core/kyb', 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://api.enterprise.sandbox.uphold.com/core/kyb",
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://api.enterprise.sandbox.uphold.com/core/kyb"
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))
}HttpResponse<String> response = Unirest.get("https://api.enterprise.sandbox.uphold.com/core/kyb")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enterprise.sandbox.uphold.com/core/kyb")
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{
"summary": {
"reason": "none",
"status": "ok"
},
"processes": {
"profile": {
"code": "profile",
"status": "ok"
},
"associatedPersons": {
"code": "associated-persons",
"status": "ok"
},
"documents": {
"code": "documents",
"status": "ok"
},
"financialInstitution": {
"code": "financial-institution",
"status": "exempt"
},
"attestation": {
"code": "attestation",
"status": "ok"
}
}
}KYB
Get overview
Get the KYB overview of a business user.
GET
/
core
/
kyb
Get overview
curl --request GET \
--url https://api.enterprise.sandbox.uphold.com/core/kyb \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.enterprise.sandbox.uphold.com/core/kyb"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.enterprise.sandbox.uphold.com/core/kyb', 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://api.enterprise.sandbox.uphold.com/core/kyb",
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://api.enterprise.sandbox.uphold.com/core/kyb"
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))
}HttpResponse<String> response = Unirest.get("https://api.enterprise.sandbox.uphold.com/core/kyb")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enterprise.sandbox.uphold.com/core/kyb")
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{
"summary": {
"reason": "none",
"status": "ok"
},
"processes": {
"profile": {
"code": "profile",
"status": "ok"
},
"associatedPersons": {
"code": "associated-persons",
"status": "ok"
},
"documents": {
"code": "documents",
"status": "ok"
},
"financialInstitution": {
"code": "financial-institution",
"status": "exempt"
},
"attestation": {
"code": "attestation",
"status": "ok"
}
}
}This endpoint is currently available in Sandbox only. It is not yet available in Production.
code and status of each KYB process are included in the response.
If you need detailed information, you can use the detailed query parameter to specify the KYB processes you want more detail on, which will bring their input and output fields, as well as the full list of associated persons.
Getting the detailed KYB information is more expensive in terms of performance and should be used only when necessary.
Overall status
Thesummary object describes the business user’s overall standing, independently of the individual processes:
| Status | Meaning |
|---|---|
pending | The platform is still expecting information from the business. |
ok | The business has been verified. |
restricted | The business has been verified but the platform has limited certain capabilities. |
blocked | The business is not allowed to operate on the platform. |
reason field carries additional context for the current status, and is none when there is nothing further to report.Authorizations
OAuth 2.0 authentication.
Query Parameters
Include detailed information about the specified KYB processes. Use this sparingly as its more expensive to retrieve.
Maximum array length:
20Available options:
profile, documents, financialInstitution, associatedPersons, attestation Was this page helpful?