Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Consortium

Search Consortium

post/consortium/searches

Request body

tinstring nullable

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

phonesstring[]

Business or owner phone numbers.

emailsstring[]

Business or owner email addresses.

websitestring nullable

The business's website.

business_namestring nullable

The business's legal or trade name.

business_idstring uuid nullable

An Osiris business id to match exclusions linked to it.

Example request

{
  "tin": "12-3456789",
  "phones": [
    "+14155551234"
  ],
  "emails": [
    "ap@acme.com"
  ],
  "website": "https://acme.com",
  "business_name": "Acme Corp",
  "business_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "officers": [
    {
      "first_name": "Jane",
      "last_name": "Doe"
    }
  ],
  "address": {
    "street": "123 Main St",
    "city": "Springfield",
    "zip": "62704"
  }
}

Response

Successful Response

total_matchesinteger required

The number of distinct exclusion records matched.

Example response

{
  "matches": [
    {
      "exclusion_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reported_on": "2023-08-01",
      "business_name": "Acme Corp",
      "doing_business_as": "Acme",
      "business_address": "500 Market St, San Francisco, CA 94105",
      "tin": "123456789",
      "email": "ap@acme.com",
      "website": "https://acme.com",
      "primary_owner": {
        "first_name": "Jane",
        "middle_name": "Q",
        "last_name": "Doe",
        "phone_number": "+15551234567",
        "address": "123 Main St, Springfield, IL 62704"
      },
      "secondary_owner": {
        "first_name": "Jane",
        "middle_name": "Q",
        "last_name": "Doe",
        "phone_number": "+15551234567",
        "address": "123 Main St, Springfield, IL 62704"
      },
      "application_channel_name": "partner-referral",
      "application_ip_address": "203.0.113.42",
      "application_date": "2023-01-15",
      "opened_on": "2023-02-01",
      "closed_on": "2023-07-30",
      "matures_on": "2026-02-01",
      "first_payment_default": true,
      "term_in_months": 36,
      "amount": 50000,
      "charge_off_amount": 42500,
      "matched_on": [
        {
          "value": "123456789"
        }
      ]
    }
  ]
}