List accounts

get

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

Lists the accounts in your workspace, with filters, or returns the result of Create an account when you send request_id. To follow changes, use webhooks rather than polling this list. Page with offset and limit, or with after_id and before_id for stable paging, but do not combine them.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Matches account and establishment IDs, reference_id, business names, source, boarded_iso, sponsor_bank and searchable tags, as a case-insensitive partial match.

offset

integer

≥ 0

Defaults to 0

The number of items to skip, for paging.

limit

integer

≥ 1

Defaults to 10

The number of items to return per page.

after_id

uuid

The account ID, as a UUID, to start after, and not allowed with before_id or offset. Send sort_by=created&sort_order=desc on the first request too, or that page uses a different order.

before_id

uuid

The account ID, as a UUID, to end before, and not allowed with after_id or offset. Send sort_by=created&sort_order=desc on the first request too, or that page uses a different order.

sort_by

string

The field to sort by, or omit it to use the default. Valid fields depend on the endpoint.

sort_order

string

enum

Defaults to asc

The sort direction, or omit it to use the default, which depends on the endpoint.

asc: ascending, oldest first.
desc: descending, newest first.

Allowed:

before

integer

≥ 0

Returns items created before this time, in Unix epoch seconds.

after

integer

≥ 0

Returns items created after this time, in Unix epoch seconds.

return_pagination_metadata

string

Send any value, including false, to get {"data": [...], "pagination_metadata": {...}}. Leave it out to get a plain array.

request_id

uuid

The request_id from the POST that started the job, as a UUID. Omit it unless you are polling that job.

boarded_iso

string

Returns accounts boarded by this ISO. Example: Acme ISO.

sponsor_bank

string

Returns accounts with this sponsor bank. Example: Acme Sponsor Bank.

account_tag_filters

string

Filters by account tags, as a URL-encoded JSON object of tag names to allowed values, such as {"Risk":["High","Medium"],"Verified":["true"]} before encoding. A value in any listed tag's array matches, all tags must match, and Boolean tags take true, false or NULL.

source

array of strings

Returns accounts from this source, ignoring case. Repeat the parameter to match several sources.

source

monitored

boolean

Set to true to return only monitored accounts, or false to return only unmonitored accounts.

countries

array of strings

Only return accounts in these countries, as two-letter codes, where GB and UK match each other. Repeat the parameter to match several countries.

countries

response_level

string

enum

Set to lite to skip live lookups and return stored data only, for faster lists. Any other value has no effect.

Allowed:

tpv_450d_filter

string

Filters by total payment volume over the last 450 days, in USD cents, as URL-encoded JSON with gt, gte, lt or lte. Example, before encoding: {"gte":100000,"lt":1000000} for $1,000 up to $10,000.

Headers

X-Coris-Expand-Objects

string

Send this header with any string value if you want nested objects in full.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

The paging parameters conflict. For example, you sent before_id with after_id, a cursor with offset, or a cursor that is not in the filtered list. Fix the parameters and resend.

425

The account is not ready. This applies only with request_id. Wait, then poll again.

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 accounts. With request_id, this is the one created account. With return_pagination_metadata, it is an object with data and pagination_metadata.

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

404No item has this ID in your workspace. Check the ID and the environment.

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.

503The list query timed out. Wait for the Retry-After delay, then retry or narrow your filters.