v1

latestOpenAPI 3.1.02026-07-241695611.0 MB

Exclusions

Get Exclusions For Search

Retrieve exclusion records related to a specific business search.

This endpoint returns exclusion records that match the business information from the specified search, such as business name, tax ID, or other identifiers. Results are only available if the caller's organization has an active consortium membership (granted by submitting exclusion data).

Results are paginated and ordered by creation date (newest first).

get/businesses/{id}/exclusions

Path parameters

idstring uuid required

The unique identifier of the business to retrieve exclusions for.

Example:412a49b5-7466-426b-bf1e-081b00b54576

The unique identifier of the business to retrieve exclusions for.

Query parameters

limitinteger

Maximum number of exclusion records to return

offsetinteger

Number of exclusion records to skip

Response

Successful Response

idstring uuid required

Unique identifier for the exclusion record.

namestring required

Legal name of the business.

addressstring required

Full business address.

tinstring nullable required

Tax identification number.

product_type'BNK' | 'CC' | 'WC' | 'LOC' | 'EQF' | 'MCA' | 'PMT' | 'Other' required

application_datestring date required

Date when application was submitted.

opened_onstring date required

Date when account was opened.

closed_onstring date required

Date when account was closed.

closure_status'PIF' | 'WO' | 'SD' required

closure_reason'PIF' | 'WBC' | 'WUP' | 'WPF' | 'WIF' | 'WSF' required

owner_first_namestring required

Primary owner's first name.

owner_last_namestring required

Primary owner's last name.

additional_notesstring nullable

Additional notes about the exclusion.

created_atstring date-time required

Date and time when the exclusion record was created.

Example response

[
  {
    "id": "0aac5a02-0c75-4d22-bc10-c609bf97b04f",
    "name": "Acme Corp",
    "address": "123 Main St, City, ST 12345",
    "tin": "123456789",
    "application_date": "2026-04-17",
    "opened_on": "2026-05-17",
    "closed_on": "2026-06-16",
    "owner_first_name": "John",
    "owner_last_name": "Doe",
    "additional_notes": "Customer filed for bankruptcy on 2023-05-15",
    "created_at": "2026-07-16T19:24:27.792769"
  }
]