Skip to main content
POST
Search Consortium

Authorizations

X-API-Key
string
header
required

Body

application/json

Strict JSON body for the standalone consortium check endpoint.

tin
string | null

The business's 9-digit EIN/tax id.

Example:

"12-3456789"

phones
string[]

Business or owner phone numbers.

Example:
emails
string[]

Business or owner email addresses.

Example:
website
string | null

The business's website.

Example:

"https://acme.com"

business_name
string | null

The business's legal or trade name.

Example:

"Acme Corp"

business_id
string<uuid> | null

An Osiris business id to match exclusions linked to it.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

officers
ConsortiumCheckOfficerName (v1) · object[]

Officer/owner names to match.

address
ConsortiumCheckAddress (v1) · object | null

The business's street address.

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.

total_matches
integer
required

The number of distinct exclusion records matched.

Examples:

0

1

2

matches
ConsortiumMatch (v1) · object[]

The matched consortium exclusion records, strongest first.