Create a Merchant Profiler request

post

https://sandbox-api.coris.ai/api/v0_2/merchant_profiler/

Starts a job that matches a business from your details and collects its profile: registration, people, website, reviews, ratings and risk checks. To choose the match yourself, use Search businesses.

Lifecycle: POST returns 201 and a request_id, and you poll Get a Merchant Profiler result until 200, or send callback_url as Handle async requests explains.

sequenceDiagram
  accTitle: Create a Merchant Profiler request sequence diagram
  accDescr: Create a Merchant Profiler request. You send POST /merchant_profiler/. Coris replies 201 request_id. You send GET ?request_id=... Coris replies 425 no data yet, or 206 partial data. You send GET ?request_id=... Coris replies 200 complete. Coris sends POST callback_url, if sent.
  participant You
  participant Coris
  You->>Coris: POST /merchant_profiler/
  Coris-->>You: 201 request_id
  You->>Coris: GET ?request_id=...
  Coris-->>You: 425 no data yet, or 206 partial data
  You->>Coris: GET ?request_id=...
  Coris-->>You: 200 complete
  Coris->>You: POST callback_url, if sent

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Business search request

A request to collect data about a business. Send business_name, dba_name, or first_name and last_name with an address, or send website with online set to true. Without business_search in data_types, Coris looks up reference_id, then creates a new business from your details if it finds none.

reference_id

string

Your ID for this business, required with create_account. Without business_search in data_types, Coris uses it to find the business on your account or earlier search.

create_account

boolean

Defaults to false

When true and you send reference_id, Coris creates an account, if none exists, and starts onboarding monitoring. Without reference_id, it creates none and still returns 201, and you can call Create an account later with the returned establishment.id.

account_id

uuid

The Coris ID of an account, used only with business_fraud_check to fill in missing application details. It does not select the business, and an unknown ID returns 400.

data_types

array of strings

The sections to collect, or omit it to use the default set for your workspace. An unknown value returns 400.

business_search: match the business from the details you send. Without it, Coris uses the account or earlier search for reference_id, and otherwise creates a new establishment and legal entity from your details.
legal_entity_registrations: registrations with Secretary of State or similar authorities.
legal_entity_licenses: licenses held by the legal entity.
personnel: people linked to the business.
establishment_phones: phone numbers found for the business.
establishment_industry: NAICS and MCC classification.
establishment_website: attributes of the business website.
establishment_reviews: review summaries by source.
establishment_ratings: Coris rating of the business.
establishment_merchant_vision: analysis of imagery of the business location.
establishment_adverse_media: negative news about the business.
establishment_social_media_summary: social media profiles found for the business.
establishment_social_media_rating: rating based on social media presence.
establishment_litigation_presence_checker: whether litigation records exist.
establishment_litigation_checker: details of litigation records.
business_fraud_check: a CorShield evaluation, returned under corshield.

data_types

match_threshold

integer

Defaults to 80

The lowest match score to accept, from 0 to 100. Applies when data_types includes business_search.

search_strategy

string

enum

Defaults to complete

How widely to search when data_types includes business_search.

complete: use every search source.
sos_only: skip the additional search source.

Allowed:

first_party

boolean

Defaults to true

Run the first-party model, which must be enabled for your workspace. Applies when data_types includes business_fraud_check.

third_party

boolean

Defaults to true

Run the third-party model, which must be enabled for your workspace. Applies when data_types includes business_fraud_check.

business_name

string

The legal name of the business, with an address whose address_type is Registration. Required with business_fraud_check.

dba_name

string

The doing business as (DBA) name, if any, with an address whose address_type is Establishment.

first_name

string

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

last_name

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 of the Business.

other_addresses

array of objects

Additional addresses, when the business has more than one location.

other_addresses

phone_number

string

The business phone number. Use international format if the number is not in the country of the business.

website

uri

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

online

boolean

Defaults to false

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

business_description

string

A free-text description of the business.

string

The business email address. Used with business_fraud_check.

ein

string

The Employer Identification Number (EIN) or other national business ID. Never send a Social Security Number.

bank_account_routing_number

string

The bank routing number, used with business_fraud_check. Never send the bank account number.

device_information

object

The device used to submit the application. Used with business_fraud_check.

principal

object

The owner or controller of the business. Used with business_fraud_check.

applicant

object

The person applying for services, if not the owner. Used with business_fraud_check.

callback_url

uri

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

requested_spend

object

Reserved for future use.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

The body is not valid JSON, data_types holds an unknown value, or a business_fraud_check field failed validation. Invalid JSON returns a JSON detail message. The others return plain text. Fix the field and resend.

422

The name and address do not fit together, or zip_code and postal_code differ. Match address_type to the name you send: Registration for business_name, Establishment for dba_name.

Callback

201The job started. Use request_id to get the result.

401The key is missing, or it is wrong for this host. Send Authorization: Token YOUR_API_KEY with a key issued for this environment.

403A scoped key cannot use this route, and gets JSON with detail. Use a key without account limits.

429You passed a rate limit. If Retry-After is present, wait that many seconds, then retry. If it is absent, you hit the concurrency limit, so back off for a few seconds and reduce parallel calls.

500Coris could not complete the request. Retry with backoff. If it continues, contact support.