List every reason code
curl --request GET \
--url https://api.baselayer.com/reason_codes \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.baselayer.com/reason_codes"
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/reason_codes', 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/reason_codes",
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/reason_codes"
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/reason_codes")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/reason_codes")
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[
{
"code": "SEARCH_ADDRESS_CMRA",
"category": "address",
"recommended_severity": "high",
"description": "Submitted address is a known commercial mail receiving agency, a private mailbox service that can mask where a business actually operates.",
"deprecated": false,
"deprecated_at": "2023-12-25",
"successor_code": "ADDRESS_FAILED_TO_NORMALIZE"
}
]Reason Codes
List every reason code
Return the full catalog of reason codes, deprecated ones included.
GET
/
reason_codes
List every reason code
curl --request GET \
--url https://api.baselayer.com/reason_codes \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.baselayer.com/reason_codes"
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/reason_codes', 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/reason_codes",
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/reason_codes"
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/reason_codes")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/reason_codes")
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[
{
"code": "SEARCH_ADDRESS_CMRA",
"category": "address",
"recommended_severity": "high",
"description": "Submitted address is a known commercial mail receiving agency, a private mailbox service that can mask where a business actually operates.",
"deprecated": false,
"deprecated_at": "2023-12-25",
"successor_code": "ADDRESS_FAILED_TO_NORMALIZE"
}
]Authorizations
Response
Response
The reason code. This is a stable identifier that can be used to uniquely identify a condition.
Available options:
ADDRESS_FAILED_TO_NORMALIZE, ENTITY_NOT_FOUND, BUSINESS_NAME_NO_MATCH, NO_ACTIVE_REGISTRATIONS, DOMESTIC_REGISTRATION_INACTIVE, SOLE_REGISTRATION_STATUS_UNKNOWN, ENTITY_AGE_UNDER_7D, ENTITY_AGE_UNDER_30D, ENTITY_AGE_UNDER_90D, ENTITY_AGE_UNDER_6M, ENTITY_AGE_UNDER_12M, TIN_MISMATCH, TIN_IS_SSN, ADDRESS_NO_MATCH, ADDRESS_PARTIAL_MATCH, SEARCH_ADDRESS_UNDELIVERABLE, SEARCH_ADDRESS_PO_BOX, SEARCH_ADDRESS_CMRA, SEARCH_ADDRESS_RESIDENTIAL, PRIMARY_ADDRESS_UNDELIVERABLE, PRIMARY_ADDRESS_PO_BOX, PRIMARY_ADDRESS_CMRA, PRIMARY_ADDRESS_RESIDENTIAL, NO_OFFICER_MATCH, SUBMITTED_DOMAIN_UNDER_7D, DISCOVERED_DOMAIN_UNDER_7D, TAX_LIEN_ACTIVE, TAX_LIEN_PAST, UCC_LIEN_ACTIVE, BANKRUPTCY_ACTIVE, BANKRUPTCY_RECENT, LITIGATION_ACTIVE, LITIGATION_RECENT, NETWORK_HIGH_VELOCITY, NETWORK_HIGH_APPLICATION_COUNT, ADDRESS_MISMATCH, NETWORK_NO_HISTORY Example:
"SEARCH_ADDRESS_CMRA"
The domain the code belongs to.
Available options:
identity, address, officers, web_presence, industry, credit, network, adverse, reviews Example:
"address"
Baselayer's recommended response tier
Available options:
high, medium, low Example:
"high"
What the condition means, in a sentence or two.
Example:
"Submitted address is a known commercial mail receiving agency, a private mailbox service that can mask where a business actually operates."
Whether the code is deprecated: no longer issued, though it still appears on results that recorded it.
Example:
false
The UTC day the code is or will be deprecated, or null if none is scheduled.
The code that replaces this one, if it is deprecated and has a replacement.
Available options:
ADDRESS_FAILED_TO_NORMALIZE, ENTITY_NOT_FOUND, BUSINESS_NAME_NO_MATCH, NO_ACTIVE_REGISTRATIONS, DOMESTIC_REGISTRATION_INACTIVE, SOLE_REGISTRATION_STATUS_UNKNOWN, ENTITY_AGE_UNDER_7D, ENTITY_AGE_UNDER_30D, ENTITY_AGE_UNDER_90D, ENTITY_AGE_UNDER_6M, ENTITY_AGE_UNDER_12M, TIN_MISMATCH, TIN_IS_SSN, ADDRESS_NO_MATCH, ADDRESS_PARTIAL_MATCH, SEARCH_ADDRESS_UNDELIVERABLE, SEARCH_ADDRESS_PO_BOX, SEARCH_ADDRESS_CMRA, SEARCH_ADDRESS_RESIDENTIAL, PRIMARY_ADDRESS_UNDELIVERABLE, PRIMARY_ADDRESS_PO_BOX, PRIMARY_ADDRESS_CMRA, PRIMARY_ADDRESS_RESIDENTIAL, NO_OFFICER_MATCH, SUBMITTED_DOMAIN_UNDER_7D, DISCOVERED_DOMAIN_UNDER_7D, TAX_LIEN_ACTIVE, TAX_LIEN_PAST, UCC_LIEN_ACTIVE, BANKRUPTCY_ACTIVE, BANKRUPTCY_RECENT, LITIGATION_ACTIVE, LITIGATION_RECENT, NETWORK_HIGH_VELOCITY, NETWORK_HIGH_APPLICATION_COUNT, ADDRESS_MISMATCH, NETWORK_NO_HISTORY