Run a CorShield evaluation

post

https://sandbox-api.coris.ai/api/v0_2/corshield/fraud_model/

Starts a CorShield evaluation of a business application and returns a request_id. Use it to get a risk score at onboarding, on its own. To get the score and a full profile from one request, add business_fraud_check to data_types on Create a Merchant Profiler request.

Lifecycle: POST returns 201 and a request_id. Poll Get a CorShield evaluation result: 425 means not ready, and 200 means complete. If you send callback_url, Coris posts the result when it is done, as Handle async requests explains.

sequenceDiagram
  accTitle: Run a CorShield evaluation sequence diagram
  accDescr: Run a CorShield evaluation. You send POST /corshield/fraud_model/. Coris replies 201 request_id. You send GET ?request_id=... Coris replies 425 not ready. You send GET ?request_id=... Coris replies 200 complete. Coris sends POST callback_url, if sent.
  participant You
  participant Coris
  You->>Coris: POST /corshield/fraud_model/
  Coris-->>You: 201 request_id
  You->>Coris: GET ?request_id=...
  Coris-->>You: 425 not ready
  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

A business application to evaluate. Only business_name is required. More detail gives a better evaluation.

business_name

string

required

The legal name of the business to evaluate.

dba_name

string

The Doing Business As (DBA) name of the business, if available.

reference_id

string

Your ID for this business. If an account has this reference_id, Coris fills missing details from it.

account_id

uuid

The Coris ID of an account, as a UUID. Coris fills missing details from it, and an unknown ID returns 400.

establishment_id

uuid

The Coris ID of the establishment to evaluate, as a UUID. An unknown ID returns 400.

first_party

boolean

Defaults to true

Run the first-party model. It must be enabled for your workspace, and at least one model must run.

third_party

boolean

Defaults to true

Run the third-party model. It must be enabled for your workspace, and at least one model must run.

ein

string

Employer Identification Number (EIN) or other country-level identifier. Do not send a Social Security Number (SSN).

string

The email of the business.

phone_number

string

The phone number of the business.

website

string

The website of the business.

address

object

The primary address of the business, with zip_code and not postal_code. country or country_code defaults to US.

addresses

array of objects

Additional addresses of the business.

addresses

first_name

string

The first name of the owner, used when principal.first_name is not sent.

last_name

string

The last name of the owner, used when principal.last_name is not sent.

principal

object

The owner or controller of the business.

applicant

object

The person applying for services.

bank_account_routing_number

string

The bank routing number only. Do not send a bank account number.

device_information

object

The device used to submit the application.

user_ip_address

string

Top-level alternative to device_information.user_ip_address.

user_headers

object

Top-level alternative to device_information.user_headers.

requested_spend

object

Reserved for future use.

callback_url

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

Callback

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

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

400The request failed validation. business_name is missing, an ID is unknown, Coris rejected callback_url, or no model is enabled for your workspace. Read the plain-text body and fix that field. Use a public HTTPS URL for callback_url. If no model is enabled, ask Coris to turn one on.

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.