ELelliptic
Customers

Get customer summary

Returns a summary for a customer by ID. The shape of the response depends on the request query parameter.

get/copilot/customers/summary/{customerId}

Request

  • Base URL
    https://ai-api.elliptic.co
  • URL
    https://ai-api.elliptic.co/copilot/customers/summary/{customerId}
  • 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

customerIdstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

Customer ID (UUID)

Query parameters

request'overview' | 'wallet' | 'transaction' | 'wallet_ids' | 'transaction_ids'
Example:overview

Type of summary to return. Omit for a full structured summary with analysis IDs. overview, wallet, or transaction return an LLM narrative. wallet_ids or transaction_ids return the highest-risk items with their hash and analysis ID.

Response

Customer summary. Shape depends on request query param: SummaryResult when omitted, LLM narrative string for overview/wallet/transaction, or MaxRiskTrigger[] for wallet_ids/transaction_ids.

OR

Changes

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