Create an account

post

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

Creates an account, your record of a merchant in your portfolio, so that you can push persons and transactions and turn on monitoring. To collect data without creating an account, use Create a Merchant Profiler request.

Lifecycle: with establishment_id, the 201 holds the account, and otherwise it holds a request_id to poll with List accounts (see Handle async requests).

sequenceDiagram
  accTitle: Create an account sequence diagram
  accDescr: Create an account. You send POST /accounts/. 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 /accounts/
  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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Account Creation Request

The account to create. reference_id is required. An address needs address_type, and city and state or a postal code.

reference_id

string

required

Your ID for this account, unique in your workspace, including deleted accounts.

establishment_id

string

The Coris ID of an establishment to link, as a UUID. If you send it, Coris skips business matching and creates the account right away, and an unknown ID returns 404.

business_name

string

The legal name of the business. If you send it, the address needs address_type set to Registration.

dba_name

string

The doing business as (DBA) name. If you send it, the address needs address_type set to 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. 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

phone_number

string

The business phone number.

website

string

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

websites

array of strings

Additional websites of the business, as full URLs.

websites

string

The business email address.

entity_type

string

The legal form of the business.

online

boolean

Defaults to false

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

match_threshold

integer

Defaults to 80

The lowest match score to accept when linking a business, from 0 to 100.

mcc_code

string

length between 1 and 256

The Merchant Category Code, 1 to 256 characters.

mcc_description

string

length between 1 and 256

The description of the Merchant Category Code, 1 to 256 characters.

boarded_iso

string

The ISO that boarded this merchant. Required for a key limited to more than one ISO.

sponsor_bank

string

The sponsor bank for this merchant. Not stored on create, so set it with Update an account.

average_ticket

integer

≥ 0

The average transaction amount, in cents, as a whole number of 0 or more.

high_ticket

integer

≥ 0

The highest expected transaction amount, in cents, as a whole number of 0 or more.

average_monthly_volume

integer

≥ 0

The average monthly volume, in cents, as a whole number of 0 or more.

card_present_percentage

number

0 to 100

The percentage of transactions with the card present, from 0 to 100. It need not total 100 with card_not_present_percentage.

card_not_present_percentage

number

0 to 100

The percentage of transactions without the card present, from 0 to 100. It need not total 100 with card_present_percentage.

card_descriptor

string

length between 1 and 256

The text on cardholder statements, 1 to 256 characters.

merchant_id

string

length between 1 and 256

Your merchant ID, 1 to 256 characters.

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

200The account was created right away. This applies to workspaces with automatic account creation.

201With establishment_id, the body is the new account. Otherwise, the body holds a request_id to poll.

400reference_id is missing, boarded_iso is not a string or not allowed for your key, or callback_url is invalid. Fix the field and resend.

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

404The establishment_id does not match an establishment. Check the ID, or create from business details.

409An account already has this reference_id, and that includes deleted accounts. Read that account, or send a different ID if it was deleted.

422The name and address do not fit together, or a merchant profile field is invalid. Fix the field and resend.

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.