Customers

Get customer by ID

Get a single customer by ID

get/customers/{customer_id}

Request

Base URL
https://aml-api.elliptic.co/v2
URL
https://aml-api.elliptic.co/v2/customers/{customer_id}
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

Path parameters

customer_idstring UUIDv4 required

uuid identifier of a customer

Query parameters

expandstring[]

to expand customer labels and/or statistics

isMcboolean

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

Response

Customer successfully retrieved

idstring UUIDv4 required

UUIDv4 identifier of the customer

updated_atstring date-time

ISO date time with time zone (UTC) of when the customer was last updated

created_atstring date-time

Customer's creation's ISO date time with time zone (UTC)

team_idstring UUIDv4 required

UUIDv4 identifier of the team the user belongs to

investigator_idstring NullableUUIDv4

UUIDv4 identifier of the user assigned to investigate customer

referencestring required

used by our client to refer to this customer

status'processing' | 'error' | 'complete'

customer's status

is_processingboolean

true if a query on this customer currently processing

has_errorsboolean

true if a query on this customer has errored

last_queriedstring date-time required

ISO date time with time zone (UTC) of when the last query was run

workflow_status'active' | 'archived' required

the workflow status

Example response

{
  "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.