v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Prefill

Business Prefill

Prefill businesses by searching officer names. Business name is optional and used only for matching comparison in the response.

get/prefill/businesses

Query parameters

officer_namestring required

Officer name to search

Officer name to search

business_namestring nullable

Business name to use for matching comparison (not used for searching)

Business name to use for matching comparison (not used for searching)

similarity_thresholdnumber

Similarity threshold for the search (0.0 to 1.0). Defaults to 0.9.

Similarity threshold for the search (0.0 to 1.0). Defaults to 0.9.

limitinteger

Maximum number of results to return

Maximum number of results to return

Response

Successful Response

namestring required

The name of the registration.

issue_datestring date nullable

The date the registration was issued.

state'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'PR' | 'VI' | 'AE' | 'AA' | 'AP' | 'GU' | 'AS' required
file_numberstring required

The filing number of the registration.

officersstring[]

The officers associated with the registration.

alternative_namesstring[]

The alternative names associated with the registration.

similarity_scorenumber required

The similarity score of the registration.

business_name_match'NO_MATCH' | 'SIMILAR' | 'EXACT'

Example response

[
  {
    "name": "Garcia, Hernandez and Woods",
    "issue_date": "2024-01-01",
    "file_number": "867124",
    "primary_address": {
      "street": "913 Hendrix Gardens Suite 492",
      "city": "Jasonfurt",
      "zip": "19773",
      "latitude": 38.03012,
      "longitude": 78.47665
    },
    "officers": [
      "Tyler Johnson",
      "John Doe"
    ]
  }
]