curl --request POST \
--url https://api.baselayer.com/consortium/searches \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"tin": "12-3456789",
"phones": [
"+14155551234"
],
"emails": [
"ap@acme.com"
],
"website": "https://acme.com",
"business_name": "Acme Corp",
"business_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"officers": [
{
"first_name": "Jane",
"last_name": "Doe",
"state": "CA"
}
],
"address": {
"street": "123 Main St",
"city": "Springfield",
"state": "IL",
"zip": "62704"
}
}
'import requests
url = "https://api.baselayer.com/consortium/searches"
payload = {
"tin": "12-3456789",
"phones": ["+14155551234"],
"emails": ["ap@acme.com"],
"website": "https://acme.com",
"business_name": "Acme Corp",
"business_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"officers": [
{
"first_name": "Jane",
"last_name": "Doe",
"state": "CA"
}
],
"address": {
"street": "123 Main St",
"city": "Springfield",
"state": "IL",
"zip": "62704"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tin: '12-3456789',
phones: ['+14155551234'],
emails: ['ap@acme.com'],
website: 'https://acme.com',
business_name: 'Acme Corp',
business_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
officers: [{first_name: 'Jane', last_name: 'Doe', state: 'CA'}],
address: {street: '123 Main St', city: 'Springfield', state: 'IL', zip: '62704'}
})
};
fetch('https://api.baselayer.com/consortium/searches', 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/consortium/searches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tin' => '12-3456789',
'phones' => [
'+14155551234'
],
'emails' => [
'ap@acme.com'
],
'website' => 'https://acme.com',
'business_name' => 'Acme Corp',
'business_id' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'officers' => [
[
'first_name' => 'Jane',
'last_name' => 'Doe',
'state' => 'CA'
]
],
'address' => [
'street' => '123 Main St',
'city' => 'Springfield',
'state' => 'IL',
'zip' => '62704'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.baselayer.com/consortium/searches"
payload := strings.NewReader("{\n \"tin\": \"12-3456789\",\n \"phones\": [\n \"+14155551234\"\n ],\n \"emails\": [\n \"ap@acme.com\"\n ],\n \"website\": \"https://acme.com\",\n \"business_name\": \"Acme Corp\",\n \"business_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"officers\": [\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"state\": \"CA\"\n }\n ],\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"Springfield\",\n \"state\": \"IL\",\n \"zip\": \"62704\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.baselayer.com/consortium/searches")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tin\": \"12-3456789\",\n \"phones\": [\n \"+14155551234\"\n ],\n \"emails\": [\n \"ap@acme.com\"\n ],\n \"website\": \"https://acme.com\",\n \"business_name\": \"Acme Corp\",\n \"business_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"officers\": [\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"state\": \"CA\"\n }\n ],\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"Springfield\",\n \"state\": \"IL\",\n \"zip\": \"62704\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/consortium/searches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tin\": \"12-3456789\",\n \"phones\": [\n \"+14155551234\"\n ],\n \"emails\": [\n \"ap@acme.com\"\n ],\n \"website\": \"https://acme.com\",\n \"business_name\": \"Acme Corp\",\n \"business_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"officers\": [\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"state\": \"CA\"\n }\n ],\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"Springfield\",\n \"state\": \"IL\",\n \"zip\": \"62704\"\n }\n}"
response = http.request(request)
puts response.read_body{
"total_matches": 0,
"matches": [
{
"exclusion_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"business_name": "Acme Corp",
"business_address": "500 Market St, San Francisco, CA 94105",
"primary_owner": {
"first_name": "Jane",
"last_name": "Doe",
"middle_name": "Q",
"phone_number": "+15551234567",
"address": "123 Main St, Springfield, IL 62704"
},
"product_type": "WC",
"application_date": "2023-01-15",
"opened_on": "2023-02-01",
"closed_on": "2023-07-30",
"closure_status": "WO",
"closure_reason": "WPF",
"score": 0.5,
"matched_on": [
{
"type": "TIN",
"value": "123456789"
}
],
"reported_on": "2023-08-01",
"doing_business_as": "Acme",
"entity_type": "LLC",
"tin": "123456789",
"email": "ap@acme.com",
"website": "https://acme.com",
"secondary_owner": {
"first_name": "Jane",
"last_name": "Doe",
"middle_name": "Q",
"phone_number": "+15551234567",
"address": "123 Main St, Springfield, IL 62704"
},
"application_channel": "BR",
"application_channel_name": "partner-referral",
"application_ip_address": "203.0.113.42",
"matures_on": "2026-02-01",
"first_payment_default": true,
"term_in_months": 36,
"amount": 50000,
"charge_off_amount": 42500,
"payment_frequency": "MY"
}
]
}{
"code": 605,
"message": "Your organization does not have an active fraud consortium membership. Submit exclusion data to gain access to consortium checks.",
"metadata": {}
}Search Consortium
curl --request POST \
--url https://api.baselayer.com/consortium/searches \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"tin": "12-3456789",
"phones": [
"+14155551234"
],
"emails": [
"ap@acme.com"
],
"website": "https://acme.com",
"business_name": "Acme Corp",
"business_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"officers": [
{
"first_name": "Jane",
"last_name": "Doe",
"state": "CA"
}
],
"address": {
"street": "123 Main St",
"city": "Springfield",
"state": "IL",
"zip": "62704"
}
}
'import requests
url = "https://api.baselayer.com/consortium/searches"
payload = {
"tin": "12-3456789",
"phones": ["+14155551234"],
"emails": ["ap@acme.com"],
"website": "https://acme.com",
"business_name": "Acme Corp",
"business_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"officers": [
{
"first_name": "Jane",
"last_name": "Doe",
"state": "CA"
}
],
"address": {
"street": "123 Main St",
"city": "Springfield",
"state": "IL",
"zip": "62704"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tin: '12-3456789',
phones: ['+14155551234'],
emails: ['ap@acme.com'],
website: 'https://acme.com',
business_name: 'Acme Corp',
business_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
officers: [{first_name: 'Jane', last_name: 'Doe', state: 'CA'}],
address: {street: '123 Main St', city: 'Springfield', state: 'IL', zip: '62704'}
})
};
fetch('https://api.baselayer.com/consortium/searches', 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/consortium/searches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tin' => '12-3456789',
'phones' => [
'+14155551234'
],
'emails' => [
'ap@acme.com'
],
'website' => 'https://acme.com',
'business_name' => 'Acme Corp',
'business_id' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'officers' => [
[
'first_name' => 'Jane',
'last_name' => 'Doe',
'state' => 'CA'
]
],
'address' => [
'street' => '123 Main St',
'city' => 'Springfield',
'state' => 'IL',
'zip' => '62704'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.baselayer.com/consortium/searches"
payload := strings.NewReader("{\n \"tin\": \"12-3456789\",\n \"phones\": [\n \"+14155551234\"\n ],\n \"emails\": [\n \"ap@acme.com\"\n ],\n \"website\": \"https://acme.com\",\n \"business_name\": \"Acme Corp\",\n \"business_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"officers\": [\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"state\": \"CA\"\n }\n ],\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"Springfield\",\n \"state\": \"IL\",\n \"zip\": \"62704\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.baselayer.com/consortium/searches")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tin\": \"12-3456789\",\n \"phones\": [\n \"+14155551234\"\n ],\n \"emails\": [\n \"ap@acme.com\"\n ],\n \"website\": \"https://acme.com\",\n \"business_name\": \"Acme Corp\",\n \"business_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"officers\": [\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"state\": \"CA\"\n }\n ],\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"Springfield\",\n \"state\": \"IL\",\n \"zip\": \"62704\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/consortium/searches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tin\": \"12-3456789\",\n \"phones\": [\n \"+14155551234\"\n ],\n \"emails\": [\n \"ap@acme.com\"\n ],\n \"website\": \"https://acme.com\",\n \"business_name\": \"Acme Corp\",\n \"business_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"officers\": [\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"state\": \"CA\"\n }\n ],\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"Springfield\",\n \"state\": \"IL\",\n \"zip\": \"62704\"\n }\n}"
response = http.request(request)
puts response.read_body{
"total_matches": 0,
"matches": [
{
"exclusion_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"business_name": "Acme Corp",
"business_address": "500 Market St, San Francisco, CA 94105",
"primary_owner": {
"first_name": "Jane",
"last_name": "Doe",
"middle_name": "Q",
"phone_number": "+15551234567",
"address": "123 Main St, Springfield, IL 62704"
},
"product_type": "WC",
"application_date": "2023-01-15",
"opened_on": "2023-02-01",
"closed_on": "2023-07-30",
"closure_status": "WO",
"closure_reason": "WPF",
"score": 0.5,
"matched_on": [
{
"type": "TIN",
"value": "123456789"
}
],
"reported_on": "2023-08-01",
"doing_business_as": "Acme",
"entity_type": "LLC",
"tin": "123456789",
"email": "ap@acme.com",
"website": "https://acme.com",
"secondary_owner": {
"first_name": "Jane",
"last_name": "Doe",
"middle_name": "Q",
"phone_number": "+15551234567",
"address": "123 Main St, Springfield, IL 62704"
},
"application_channel": "BR",
"application_channel_name": "partner-referral",
"application_ip_address": "203.0.113.42",
"matures_on": "2026-02-01",
"first_payment_default": true,
"term_in_months": 36,
"amount": 50000,
"charge_off_amount": 42500,
"payment_frequency": "MY"
}
]
}{
"code": 605,
"message": "Your organization does not have an active fraud consortium membership. Submit exclusion data to gain access to consortium checks.",
"metadata": {}
}Authorizations
Body
Strict JSON body for the standalone consortium check endpoint.
The business's 9-digit EIN/tax id.
"12-3456789"
Business or owner phone numbers.
["+14155551234"]
Business or owner email addresses.
["ap@acme.com"]
The business's website.
"https://acme.com"
The business's legal or trade name.
"Acme Corp"
An Osiris business id to match exclusions linked to it.
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Officer/owner names to match.
Show child attributes
Show child attributes
The business's street address.
Show child attributes
Show child attributes
Response
Successful Response
Response for a standalone consortium check.
Mirrors the OFAC / PEP adhoc search envelope (matches + total_matches);
only the per-match shape (ConsortiumMatch) is consortium-specific. A
no-match — including the unsupported name-only case — is simply an empty
matches with total_matches == 0.