Skip to content

GetCustomerSelf

Endpoint

GET /customer/me

Description

Returns the authenticated customer profile and linked trading accounts.

Authorization

Requires SESSION_CUSTOMER token.

Response

{
  "customer": {
    "customer_id": 1,
    "external_id": "",
    "type": 0,
    "status": 0,
    "lifecycle_flags": 0,
    "customer_kind": 0,
    "conversion_flags": 0,
    "enable": 1,
    "enable_otp": 0,
    "deposit_allowed": 1,
    "withdrawal_allowed": 1,
    "first_name": "John",
    "last_name": "Smith",
    "middle_name": "",
    "full_name": "John Smith",
    "birth_date": 0,
    "citizenship": "",
    "country_of_residence": "",
    "address_of_residence": "",
    "avatar": "8e68414e-0e3f-48dd-b7b8-f5be9e26d4f7.svg",
    "email": "[email protected]",
    "phone": "+35700000000",
    "preferred_language": "en",
    "timezone": "Asia/Nicosia",
    "brand": "default",
    "desk": "",
    "manager_id": 0,
    "lead_source": "",
    "campaign": "",
    "affiliate_id": "",
    "introducer_id": "",
    "source_type": 1,
    "landing_url": "",
    "referrer_url": "",
    "utm_source": "",
    "utm_medium": "",
    "utm_campaign": "",
    "utm_content": "",
    "utm_term": "",
    "import_batch_id": "",
    "old_id": "",
    "created_by_import": 0,
    "assigned_manager_id": 0,
    "crm_stage": "",
    "segment": "",
    "tags_json": "",
    "email_verified": 0,
    "phone_verified": 0,
    "marketing_allowed": 0,
    "tax_id": "",
    "national_id": "",
    "pep_status": 0,
    "sanctions_status": 0,
    "risk_level": 0,
    "aml_status": 0,
    "kyc_status": 0,
    "kyc_current_level": 0,
    "kyc_required_level": 0,
    "kyc_risk_level": 0,
    "sales_status": 0,
    "risk_status": 0,
    "finance_status": 0,
    "kyc_updated_time": 0,
    "aml_updated_time": 0,
    "last_contact_time": 0,
    "first_contact_time": 0,
    "next_contact_time": 0,
    "conversion_time": 0,
    "last_login_time": 0,
    "last_online_time": 1777599000,
    "archive_time": 0,
    "created_time": 1777600000,
    "updated_time": 1777600100,
    "created_by": 0,
    "updated_by": 0,
    "registration_ip": "",
    "meta_json": ""
  },
  "accounts": [
    {
      "login": 100001,
      "customer_id": 1,
      "enable": 1,
      "leverage": 100,
      "group": "standard",
      "name": "John Smith",
      "email": "[email protected]",
      "phone": "+35700000000"
    }
  ],
  "accounts_count": 1
}

Lifecycle Fields

Field Type Description
lifecycle_flags int64 Milestone bit mask. 1 Registered, 2 KYC pending, 4 KYC approved, 8 First deposit, 16 Active trader, 32 Dormant. Flags are independent and any combination is valid
customer_kind int 0 lead, 1 client
conversion_flags int64 Mask captured when the customer became a client. 0 for a lead

lifecycle_stage is no longer part of the customer object.

Customer Cashier Flags

Field Type Description
deposit_allowed int Global customer deposit gate. 0 means deposits are disabled for this customer before Cashier method eligibility is checked
withdrawal_allowed int Global customer withdrawal gate. 0 means withdrawals are disabled for this customer

avatar is the customer's public avatar reference. Existing customers may return an empty string until they set one. Use UpdateCustomerSelf to change it; arbitrary URLs and private file references are rejected.

last_online_time is the read-only Unix time (seconds) when any trading account of the customer last went offline in the trading terminal; 0 means never. An account goes offline about 60 seconds after its terminal connection drops. While the customer is online, the field keeps the previous offline time. Only the platform sets it.

Errors

HTTP Error Description
400 INVALID_DATA Invalid session payload
401 INVALID_CUSTOMER_SESSION Customer id is missing in session
404 NOT_FOUND Customer was not found