API Reference
  1. Business data
  2. Business Search

Search businesses

post
https://sandbox-api.coris.ai/api/v0_2/business/search/

Starts a search for businesses that match the details you send, so you can review the matches and pick the right establishment.id and legal_entity.id. To let Coris pick the match and return a full profile, use Create a Merchant Profiler request. Send one of these:

  • business_name with a Registration address
  • dba_name with an Establishment address
  • first_name and last_name with an address
  • website with online set to true

Lifecycle: POST returns 201 and a request_id. Poll Get business search results: 425 means not ready, and 200 means complete. If you send callback_url, Coris posts the results when they are done, as Handle async requests explains.

sequenceDiagram
  accTitle: Search businesses sequence diagram
  accDescr: Search businesses. You send POST /business/search/. Coris replies 201 request_id. You send GET ?request_id=... Coris replies 425 no data yet. You send GET ?request_id=... Coris replies 200 complete. Coris sends POST callback_url, if sent.
  participant You
  participant Coris
  You->>Coris: POST /business/search/
  Coris-->>You: 201 request_id
  You->>Coris: GET ?request_id=...
  Coris-->>You: 425 no data yet
  You->>Coris: GET ?request_id=...
  Coris-->>You: 200 complete
  Coris->>You: POST callback_url, if sent
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Business search request

string

The legal name of the business, sent with a Registration address. Required unless you send dba_name, first_name and last_name, or website with online.

string

The doing business as (DBA) name, sent with an Establishment address. Required unless you send business_name, first_name and last_name, or website with online.

string

The owner's first name. Send it with last_name and an address for a sole proprietor with no DBA.

string

The owner's last name. Send it with first_name and an address for a sole proprietor with no DBA.

address
object

The primary address, with city and state or a postal code. Set address_type to Registration with business_name, or to Establishment with dba_name.

other_addresses
array of objects

Additional addresses of the business. Use it when the business has more than one location.

other_addresses
string

The business phone number. It helps Coris pick the right match.

string

The business website, as a full URL. Required, with online set to true, when you send no address.

string

The Employer Identification Number (EIN), recommended for more accurate matches. Never send a Social Security Number.

boolean
Defaults to false

Set to true for an online business with no physical address. You then need website, and no address.

string

A free-text description of the business.

boolean
Defaults to false

When true, returns one row: the highest score. If rows tie, the one returned can vary.

integer
Defaults to 80

The lowest match score to return, from 0 to 100.

string
enum

How to match the business. Default: complete.

  • complete: use all available data.
  • sos_only: match on registration data only.
  • no_sos: match on web search only.
Allowed:
uri

A public HTTPS URL where Coris posts the result, if you want to skip polling.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Coris rejected callback_url. Use a public HTTPS URL. The body is a plain-text message.

422

The details do not form a valid search. The name and address_type may not match, the address may lack city and state or a postal code, or zip_code and postal_code may differ. Read the plain-text body, fix it and resend.

Callback

Updated about 23 hours ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html

Updated about 23 hours ago

Did this page help you?