ELelliptic
Customers

Paginate all customers

Paginate through all customers, with various sort/filter parameters.

get/customers

Request

  • Base URL
    https://aml-api.elliptic.co/v2
  • URL
    https://aml-api.elliptic.co/v2/customers
  • Auth
    • HTTP bearer
    • or API key in header x-access-key and API key in header x-access-sign and API key in header x-access-timestamp

Query parameters

pageinteger

requested page number

per_pageinteger

number of items per page

workflow_statusstring[]

workflow status filter

keywordstring

filter both label and reference (case insensitive). Whitespace implies AND.

labelstring

filter by label name

label_matchesstring

filter by exact label name (case sensitive)

investigator_idstring[]

filter by these ids of users assigned to investigate the customer (can be empty string to get unassigned)

customer_label_idstring[]

label filter (if empty string then customers with no labels are returned)

reference_containsstring

a string on which to match customer references

reference_matchesstring

Deprecated Use reference instead

referencestring

a customer reference to match (exactly)

expandstring[]

to get more detailed labels object

sort'last_queried' | '-last_queried' | 'reference' | '-reference' | 'first_tx_time' | '-first_tx_time' | 'last_tx_time' | '-last_tx_time' | 'max_score' | '-max_score' | 'avg_score' | '-avg_score' | 'total_volume' | '-total_volume' | 'total_volume_usd' | '-total_volume_usd' | 'workflow_status' | '-workflow_status'

sorting criterion

minimum_avg_scorenumber float

filter by avg_score >= the given value

maximum_avg_scorenumber float

filter by avg_score <= the given value

minimum_max_scorenumber float

filter by max_score >= the given value

maximum_max_scorenumber float

filter by max_score <= the given value

minimum_volnumber float

filter by volume >= the given value in USD

maximum_volnumber float

filter by volume <= the given value in USD

first_tx_beforestring date-time

filter the earliest transaction time of this customer (ISO8601 datetime) <= the given date

first_tx_afterstring date-time

filter the earliest transaction time of this customer (ISO8601 datetime) >= the given date

last_tx_beforestring date-time

filter the latest transaction time of this customer (ISO8601 datetime) <= the given date

last_tx_afterstring date-time

filter the latest transaction time of this customer (ISO8601 datetime) >= the given date

last_queried_beforestring date-time

filter last_queried time of customer (ISO8601 datetime) <= the given date

last_queried_afterstring date-time

filter last_queried time of customer (ISO8601 datetime) >= the given date

statusstring[]

allowed statuses

include_no_riskboolean

Deprecated No longer supported

isMcboolean

Deprecated This will always evaluate to true. Legacy mode no longer supported

Response

Customers successfully retrieved

pagenumber
per_pagenumber
total_pagesnumber
total_itemsinteger

total number of items on all pages

Example response

{
  "page": 5,
  "per_page": 5,
  "total_pages": 5,
  "total_items": 1,
  "items": [
    {
      "id": "b7535048-76f8-4f60-bdd3-9d659298f9e7",
      "updated_at": "2015-05-13T10:36:21.000Z",
      "created_at": "2015-05-13T10:36:21.000Z",
      "team_id": "e333694b-c7c7-4a36-bf35-ed2615865242",
      "investigator_id": "b68704ce-7aaa-45b1-996d-8d760657baf2",
      "reference": "Investigator",
      "labels": [
        {
          "id": "2118a3ca-a1c0-4f81-92b1-a1069d6a8fb9",
          "team_id": "15f2b16d-f825-4d40-8db3-f4e080f90759",
          "name": "Parent Label",
          "parent_customer_label_id": null
        }
      ],
      "status": "complete",
      "has_errors": true,
      "last_queried": "2015-05-13T10:36:21.000Z",
      "statistics": {
        "first_tx_time": "2015-05-13T10:36:21.000Z",
        "last_tx_time": "2015-05-13T10:36:21.000Z",
        "avg_score": 3.3,
        "max_score": 9,
        "min_score": 9,
        "total_volume": 993842398342,
        "total_fees": 993842398342,
        "customer_tx_count": 900800,
        "deposits": {
          "total_volume": 993842398342,
          "customer_tx_count": 3341,
          "total_fees": 993842398342
        },
        "withdrawals": {
          "total_volume": 993842398342,
          "customer_tx_count": 3341,
          "total_fees": 993842398342
        },
        "min_output_satoshis": 993842398342,
        "max_output_satoshis": 993842398342,
        "avg_output_satoshis": 993842398342
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.