Skip to main content
GET
Get Exclusions For Search

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

The unique identifier of the business to retrieve exclusions for.

Examples:

"412a49b5-7466-426b-bf1e-081b00b54576"

"9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5"

Query Parameters

limit
integer
default:10

Maximum number of exclusion records to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of exclusion records to skip

Required range: x >= 0

Response

Successful Response

id
string<uuid>
required

Unique identifier for the exclusion record.

Example:

"2d110c5b-665b-42fa-ba0c-c3f74f1c57ca"

name
string
required

Legal name of the business.

Example:

"Acme Corp"

address
string
required

Full business address.

Example:

"123 Main St, City, ST 12345"

tin
string | null
required

Tax identification number.

Example:

"123456789"

product_type
enum<string>
required

Type of financial product.

Available options:
BNK,
CC,
WC,
LOC,
EQF,
MCA,
PMT,
Other
application_date
string<date>
required

Date when application was submitted.

Example:

"2026-06-02"

opened_on
string<date>
required

Date when account was opened.

Example:

"2026-07-02"

closed_on
string<date>
required

Date when account was closed.

Example:

"2026-08-01"

closure_status
enum<string>
required

What happened to the money at closure.

Available options:
WO,
SD,
CL,
PIF
closure_reason
enum<string>
required

Specific cause of closure.

Available options:
WPF,
WIF,
WSF,
WFU,
WBC,
WUP,
WBK,
WCX,
CAE,
PIF
owner_first_name
string
required

Primary owner's first name.

Example:

"John"

owner_last_name
string
required

Primary owner's last name.

Example:

"Doe"

created_at
string<date-time>
required

Date and time when the exclusion record was created.

Example:

"2026-08-31T10:31:07.820990"

additional_notes
string | null

Additional notes about the exclusion.

Example:

"Customer filed for bankruptcy on 2023-05-15"