Developer Portal
Admin APIsAccounts & FundingClient profiles

Create ProfilePOST

Create a new client profile. Create one profile per client. A client profile can hold multiple trading accounts.

View as Markdown
POST
/profiles

Authorization

Authorization<token>

Bearer access token issued by the admin login flow.

In: header

Request Body

application/jsonRequired

The client profile

idstring
emailstring
firstNamestring
lastNamestring
ipAddressstring
languagestring
addressstring
zipCodestring
citystring
statestring
countrystring
phonestring
companystring
metaDatastring
birthDatestring
Format: "int64"
timezoneIANA timezone, e.g. "Europe/London"; "" = UTC
passwordstring
curl -X POST "https://example.com/profiles" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "ipAddress": "string",
    "language": "string",
    "address": "string",
    "zipCode": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "phone": "string",
    "company": "string",
    "metaData": "string",
    "birthDate": "string",
    "timezone": "string",
    "password": "string"
  }'

A successful response.

{
  "id": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "ipAddress": "string",
  "language": "string",
  "address": "string",
  "zipCode": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "phone": "string",
  "company": "string",
  "metaData": "string",
  "birthDate": "string",
  "timezone": "string",
  "password": "string"
}

Change Password

Change the password used by a client profile to authenticate and access client-facing trading services.

Delete Profile

Delete a client profile by ID. Use this when the client profile should no longer be available through the Accounts & Funding API.