Skip to main content
GET
List every reason code

Authorizations

X-API-Key
string
header
required

Response

Response

code
enum<string>
required

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"

category
enum<string>
required

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"

description
string
required

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."

deprecated
boolean
required

Whether the code is deprecated: no longer issued, though it still appears on results that recorded it.

Example:

false

deprecated_at
string<date> | null
required

The UTC day the code is or will be deprecated, or null if none is scheduled.

successor_code
enum<string> | null
required

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