customers

Get Customer

Returns the full customer resource, including name, addresses, suitability profile, and personal or entity details. For simplicity and security the customer's internal identifier is not exposed: pass me as the customer_id to fetch the customer linked to the current access token. Set allow-missing=true to avoid a 404 when the customer does not exist.

get/customers/{customer_id}

Request

Base URL
https://api.cert.tastyworks.com
Auth
none declared

Path parameters

customer_idstring int32 required

Only a value of me is allowed. The API does not expose customers' internal identifiers.

Query parameters

allow-missingboolean

Does not raise a 404 if customer is missing

Response

The full customer resource for the requested customer.

contextstring required

Example response

{
  "data": {
    "id": "me",
    "first-name": "John",
    "last-name": "Doe",
    "usa-citizenship-type": "Citizen",
    "mobile-phone-number": "+11231234567",
    "birth-date": "2000-01-01",
    "email": "johndoe@nowhere.com",
    "external-id": "C0000037211",
    "tax-number": "*****1234",
    "tax-number-type": "SSN",
    "citizenship-country": "USA",
    "agreed-to-margining": true,
    "agreed-to-terms": true,
    "identifiable-type": "Person"
  },
  "context": "/customers/{customer_id}"
}

Changes

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