Authenticate a user

curl --request POST \
  --url https://api.example.com/auth/login/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "trader@example.com",
  "password": "StrongPassword123!",
  "fingerprint_event_id": "opaque-browser-event-id"
}
'

import requests

url = "https://api.example.com/auth/login/"

payload = {
    "email": "trader@example.com",
    "password": "StrongPassword123!",
    "fingerprint_event_id": "opaque-browser-event-id"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'trader@example.com',
    password: 'StrongPassword123!',
    fingerprint_event_id: 'opaque-browser-event-id'
  })
};

fetch('https://api.example.com/auth/login/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/auth/login/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'trader@example.com',
    'password' => 'StrongPassword123!',
    'fingerprint_event_id' => 'opaque-browser-event-id'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/auth/login/"

	payload := strings.NewReader("{\n  \"email\": \"trader@example.com\",\n  \"password\": \"StrongPassword123!\",\n  \"fingerprint_event_id\": \"opaque-browser-event-id\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/auth/login/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"trader@example.com\",\n  \"password\": \"StrongPassword123!\",\n  \"fingerprint_event_id\": \"opaque-browser-event-id\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/auth/login/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"trader@example.com\",\n  \"password\": \"StrongPassword123!\",\n  \"fingerprint_event_id\": \"opaque-browser-event-id\"\n}"

response = http.request(request)
puts response.read_body

{
  "key": "123abc456def789",
  "prop_firm": "demo-firm",
  "prop_firms": [
    "demo-firm",
    "partner-firm"
  ],
  "expires_at": "2026-02-04T12:00:00Z",
  "refresh_token": "refresh-token",
  "refresh_expires_at": "2026-03-06T12:00:00Z",
  "self_cert_status": {
    "pro": "pending",
    "non_pro": "pending",
    "cme_subscriber_addendum": "pending",
    "available_forms_to_sign": [
      {
        "declaration_type": "pro",
        "key": "self_cert_pro_status",
        "title": "Self Certification Pro Status",
        "current_status": "pending"
      },
      {
        "declaration_type": "non_pro",
        "key": "self_cert_non_pro_status",
        "title": "Self Certification Non-Pro Status",
        "current_status": "pending"
      },
      {
        "declaration_type": "cme_subscriber_addendum",
        "key": "cme_subscriber_addendum",
        "title": "CME Subscriber Addendum",
        "current_status": "pending"
      }
    ]
  }
}

POST

auth

Authenticate a user

curl --request POST \
  --url https://api.example.com/auth/login/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "trader@example.com",
  "password": "StrongPassword123!",
  "fingerprint_event_id": "opaque-browser-event-id"
}
'

import requests

url = "https://api.example.com/auth/login/"

payload = {
    "email": "trader@example.com",
    "password": "StrongPassword123!",
    "fingerprint_event_id": "opaque-browser-event-id"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'trader@example.com',
    password: 'StrongPassword123!',
    fingerprint_event_id: 'opaque-browser-event-id'
  })
};

fetch('https://api.example.com/auth/login/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/auth/login/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'trader@example.com',
    'password' => 'StrongPassword123!',
    'fingerprint_event_id' => 'opaque-browser-event-id'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/auth/login/"

	payload := strings.NewReader("{\n  \"email\": \"trader@example.com\",\n  \"password\": \"StrongPassword123!\",\n  \"fingerprint_event_id\": \"opaque-browser-event-id\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/auth/login/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"trader@example.com\",\n  \"password\": \"StrongPassword123!\",\n  \"fingerprint_event_id\": \"opaque-browser-event-id\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/auth/login/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"trader@example.com\",\n  \"password\": \"StrongPassword123!\",\n  \"fingerprint_event_id\": \"opaque-browser-event-id\"\n}"

response = http.request(request)
puts response.read_body

{
  "key": "123abc456def789",
  "prop_firm": "demo-firm",
  "prop_firms": [
    "demo-firm",
    "partner-firm"
  ],
  "expires_at": "2026-02-04T12:00:00Z",
  "refresh_token": "refresh-token",
  "refresh_expires_at": "2026-03-06T12:00:00Z",
  "self_cert_status": {
    "pro": "pending",
    "non_pro": "pending",
    "cme_subscriber_addendum": "pending",
    "available_forms_to_sign": [
      {
        "declaration_type": "pro",
        "key": "self_cert_pro_status",
        "title": "Self Certification Pro Status",
        "current_status": "pending"
      },
      {
        "declaration_type": "non_pro",
        "key": "self_cert_non_pro_status",
        "title": "Self Certification Non-Pro Status",
        "current_status": "pending"
      },
      {
        "declaration_type": "cme_subscriber_addendum",
        "key": "cme_subscriber_addendum",
        "title": "CME Subscriber Addendum",
        "current_status": "pending"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Body

string<email>

required

password

string

required

fingerprint_event_id

string

write-only

Optional opaque Fingerprint v4 event ID for non-blocking server verification.

Maximum string length: 255

Response

200 - application/json

Returns the issued session token and related login metadata.

key

string

required

Authentication token

prop_firm

string

Firm slug bound to the issued session token.

prop_firms

string[]

Firm slugs available to the authenticated user.

expires_at

string<date-time> | null

Key token expiration datetime

refresh_token

string

Refresh token for obtaining new access tokens

refresh_expires_at

string<date-time> | null

Refresh token expiration datetime

self_cert_status

object

Self certification statuses plus remaining forms that can still be signed.

Show child attributes

Accounts

Challenge

Entitlements

Status

Trade

Users

withdrawals

Auth

Authenticate a user

Authorizations

Body

Response