KYB - Global
Retrieve Business Details
Endpoint to retrieve company verification information.
GET
/
v2
/
api
/
verifications
/
ng
/
company-details
/
{verificationId}
Retrieve Business Details
curl --request GET \
--url https://api.youverify.co/v2/api/verifications/ng/company-details/{verificationId} \
--header 'token: <api-key>'import requests
url = "https://api.youverify.co/v2/api/verifications/ng/company-details/{verificationId}"
headers = {"token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {token: '<api-key>'}};
fetch('https://api.youverify.co/v2/api/verifications/ng/company-details/{verificationId}', 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.youverify.co/v2/api/verifications/ng/company-details/{verificationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"token: <api-key>"
],
]);
$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.youverify.co/v2/api/verifications/ng/company-details/{verificationId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("token", "<api-key>")
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.youverify.co/v2/api/verifications/ng/company-details/{verificationId}")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/verifications/ng/company-details/{verificationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Company details retrieved successfully!",
"data": {
"id": "6266b83130b6f4cba3a5a2dc",
"status": "found",
"businessId": "61d880f1e8e15aaf24558f1a",
"parentId": null,
"isConsent": true,
"type": "company_lookup",
"name": "JOHN DOE LTD",
"registrationNumber": "RC00000000",
"tin": "00000000-0000",
"jtbTin": "0000000000",
"taxOffice": "MSTO ILUPEJU I",
"email": "johndoe@gmail.co",
"phone": "08000000000",
"requestedAt": "2022-04-25T15:03:14.741Z",
"createdAt": "2022-04-25T15:03:14.910Z",
"lastModifiedAt": "2022-04-25T15:03:14.910Z",
"typeOfEntity": "Private Unlimited Company",
"activity": "Information service activities",
"registrationDate": "1971-12-18",
"address": "13B, Fake street, Yaba, LAGOS",
"state": "LAGOS",
"lga": "Lagos Mainland",
"city": "LAGOS",
"websiteEmail": "johndoe@gmail.coom",
"keyPersonnel": [
{
"name": "Michael Doe",
"designation": "Shareholder"
},
{
"name": "Sarah Doe",
"designation": "Director"
},
{
"name": "John Doe",
"designation": "Director"
}
],
"branchAddress": "",
"headOfficeAddress": "13B Fake street, Yaba, Lagos",
"objectives": "",
"requestedBy": {
"firstName": "Famous",
"lastName": "Ehichioya",
"middleName": "Prior",
"id": "61d880f2e8e15aaf24558f9b"
}
},
"links": []
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 404,
"message": "Not found",
"name": "ResourceNotFoundError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Internal Server Error",
"name": "Error",
"data": {}
}⌘I
Retrieve Business Details
curl --request GET \
--url https://api.youverify.co/v2/api/verifications/ng/company-details/{verificationId} \
--header 'token: <api-key>'import requests
url = "https://api.youverify.co/v2/api/verifications/ng/company-details/{verificationId}"
headers = {"token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {token: '<api-key>'}};
fetch('https://api.youverify.co/v2/api/verifications/ng/company-details/{verificationId}', 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.youverify.co/v2/api/verifications/ng/company-details/{verificationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"token: <api-key>"
],
]);
$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.youverify.co/v2/api/verifications/ng/company-details/{verificationId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("token", "<api-key>")
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.youverify.co/v2/api/verifications/ng/company-details/{verificationId}")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/verifications/ng/company-details/{verificationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Company details retrieved successfully!",
"data": {
"id": "6266b83130b6f4cba3a5a2dc",
"status": "found",
"businessId": "61d880f1e8e15aaf24558f1a",
"parentId": null,
"isConsent": true,
"type": "company_lookup",
"name": "JOHN DOE LTD",
"registrationNumber": "RC00000000",
"tin": "00000000-0000",
"jtbTin": "0000000000",
"taxOffice": "MSTO ILUPEJU I",
"email": "johndoe@gmail.co",
"phone": "08000000000",
"requestedAt": "2022-04-25T15:03:14.741Z",
"createdAt": "2022-04-25T15:03:14.910Z",
"lastModifiedAt": "2022-04-25T15:03:14.910Z",
"typeOfEntity": "Private Unlimited Company",
"activity": "Information service activities",
"registrationDate": "1971-12-18",
"address": "13B, Fake street, Yaba, LAGOS",
"state": "LAGOS",
"lga": "Lagos Mainland",
"city": "LAGOS",
"websiteEmail": "johndoe@gmail.coom",
"keyPersonnel": [
{
"name": "Michael Doe",
"designation": "Shareholder"
},
{
"name": "Sarah Doe",
"designation": "Director"
},
{
"name": "John Doe",
"designation": "Director"
}
],
"branchAddress": "",
"headOfficeAddress": "13B Fake street, Yaba, Lagos",
"objectives": "",
"requestedBy": {
"firstName": "Famous",
"lastName": "Ehichioya",
"middleName": "Prior",
"id": "61d880f2e8e15aaf24558f9b"
}
},
"links": []
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 404,
"message": "Not found",
"name": "ResourceNotFoundError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Internal Server Error",
"name": "Error",
"data": {}
}