curl --request GET \
--url https://api.baselayer.com/identities/businesses/{business_ref} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.baselayer.com/identities/businesses/{business_ref}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.baselayer.com/identities/businesses/{business_ref}', 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.baselayer.com/identities/businesses/{business_ref}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <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.baselayer.com/identities/businesses/{business_ref}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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.baselayer.com/identities/businesses/{business_ref}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/identities/businesses/{business_ref}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"business_ref": "<string>",
"legal_name": "<string>",
"kyb_checks": {
"registry_verified": true,
"tax_id_match": true,
"registration_active_verified": true,
"officer_match": true,
"watchlist_clear": true
},
"incorporation": {
"state": "AL",
"filing_number": "<string>",
"incorporation_date": "2023-12-25",
"structure": "SOLE_PROPRIETORSHIP",
"sos_status": "GOOD_STANDING",
"dissolution_date": "2023-12-25"
},
"people": [
{
"principal_ref": "<string>",
"status": "VERIFIED",
"review_flagged_at": "2023-11-07T05:31:56Z"
}
],
"counterparty_credentials": [
{
"jti": "<string>",
"domain": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"status": "VALID",
"subject": "<string>"
}
],
"submissions": [
{
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "PENDING",
"created_at": "2023-11-07T05:31:56Z",
"verdict": "APPROVED",
"reference_id": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"terminal_reason": {
"state": "FAILED",
"message": "<string>"
}
}
]
}{
"code": 1,
"message": "Could not locate the resource for the given URI.",
"metadata": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Look up a verified business by pairwise reference
Returns what the latest onboarding session that covered the business attested to, the registry incorporation facts, the people you hold covered operator links for, outstanding counterparty credentials, and your submission history for a business_ref issued to your organization. References issued to other organizations and unknown references are indistinguishable 404s.
curl --request GET \
--url https://api.baselayer.com/identities/businesses/{business_ref} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.baselayer.com/identities/businesses/{business_ref}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.baselayer.com/identities/businesses/{business_ref}', 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.baselayer.com/identities/businesses/{business_ref}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <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.baselayer.com/identities/businesses/{business_ref}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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.baselayer.com/identities/businesses/{business_ref}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/identities/businesses/{business_ref}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"business_ref": "<string>",
"legal_name": "<string>",
"kyb_checks": {
"registry_verified": true,
"tax_id_match": true,
"registration_active_verified": true,
"officer_match": true,
"watchlist_clear": true
},
"incorporation": {
"state": "AL",
"filing_number": "<string>",
"incorporation_date": "2023-12-25",
"structure": "SOLE_PROPRIETORSHIP",
"sos_status": "GOOD_STANDING",
"dissolution_date": "2023-12-25"
},
"people": [
{
"principal_ref": "<string>",
"status": "VERIFIED",
"review_flagged_at": "2023-11-07T05:31:56Z"
}
],
"counterparty_credentials": [
{
"jti": "<string>",
"domain": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"status": "VALID",
"subject": "<string>"
}
],
"submissions": [
{
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "PENDING",
"created_at": "2023-11-07T05:31:56Z",
"verdict": "APPROVED",
"reference_id": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"terminal_reason": {
"state": "FAILED",
"message": "<string>"
}
}
]
}{
"code": 1,
"message": "Could not locate the resource for the given URI.",
"metadata": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Path Parameters
Response
Response
Body for GET /identities/businesses/{business_ref}.
Strictly scoped to the calling organization, like the person profile: the KYB checks read its own latest covering evaluation, the people are the operator links it covered, and the submission history is its own sessions. No global business id and no EIN are ever echoed.
The queried pairwise business reference.
The business's registered legal name.
What this organization's latest completed KYB evaluation attested to, check by check.
Show child attributes
Show child attributes
The registry facts of the incorporation.
Show child attributes
Show child attributes
People this organization holds covered operator links for, each with their pairwise ref and link status.
Show child attributes
Show child attributes
Outstanding counterparty credentials minted for the business, newest first.
Show child attributes
Show child attributes
This organization's sessions that covered the business, newest first.
Show child attributes
Show child attributes