Get customers

get

httsp://example.com/v1/customers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

array of strings

filter customers by customer identifier

name

array of strings

filter customers by customer name

name

is_active

array of booleans

filter customers by if status is activated

is_active

risk_score_provider

array

filter customers by risk score provider

risk_score_provider

max_risk_score

array of strings

A URL parameter that specifies the range of max risk score. This format should be {provider:from,to} (ie.Elliptic:0,10 or Chainalysis V1:low,high).

max_risk_score

avg_risk_score

array of strings

A URL parameter that specifies the range of average risk score. This format should be {provider:from,to} (ie.Elliptic:0,10 or Chainalysis V1:low,high).

avg_risk_score

label

array of strings

filter customers by labels from KYT service searched

label

last_screened

array of strings

filter customers by a range of last screened date(ie. '2021-01-01T00:00:00.000Z,2021-01-02T23:59:59.999Z' means an range between 2021-01-01T00:00:00.000Z and 2021-01-02T23:59:59.999Z inclusive)

last_screened

created_at

array of strings

filter data by a range of created data(ie. '2021-01-01T00:00:00.000Z,2021-01-02T23:59:59.999Z' means an range between 2021-01-01T00:00:00.000Z and 2021-01-02T23:59:59.999Z inclusive)

created_at

limit

integer

A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 20.

offset

integer

Specifies an offset that allows you to retrieve the next batch of records.Any positive integer.If not specified, the default is 0.

orderby

array of strings

Specifies sequences to sort data (ie.orderby=id:desc)

orderby

updated_at

array of strings

filter data by a range of updated data(ie. '2021-01-01T00:00:00.000Z,2021-01-02T23:59:59.999Z' means an range between 2021-01-01T00:00:00.000Z and 2021-01-02T23:59:59.999Z inclusive)

updated_at

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error