Start fresh authentication

POST

https://api.liftx.io

integrations

reauth

start

Start purpose-bound five-minute reauthentication

curl --request POST \
  --url https://api.liftx.io/integrations/reauth/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "request": {
    "name": "<string>",
    "scopes": [],
    "exchange_link_ids": [
      4503599627370496
    ],
    "expires_at": 123,
    "instrument_ids": [
      "<string>"
    ],
    "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

import requests

url = "https://api.liftx.io/integrations/reauth/start"

payload = {
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "request": {
        "name": "<string>",
        "scopes": [],
        "exchange_link_ids": [4503599627370496],
        "expires_at": 123,
        "instrument_ids": ["<string>"],
        "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    operation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    request: {
      name: '<string>',
      scopes: [],
      exchange_link_ids: [4503599627370496],
      expires_at: 123,
      instrument_ids: ['<string>'],
      integration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    }
  })
};

fetch('https://api.liftx.io/integrations/reauth/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "operation_id": "66666666-6666-4666-8666-666666666666",
  "methods": [
    "password"
  ],
  "mfa_required": true,
  "expires_at": 1893456300
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Preview contract. Production availability remains subject to activation and release qualification. Examples are synthetic; the documentation cannot submit requests.

Authorization

Authenticated Liftx Settings session.

Behavior

Bind a canonical operation UUID, purpose and exact request to a five-minute approval attempt. Returned methods, MFA requirement and optional Apple nonce describe the allowed proof. This does not link a different account. This is a session-owned application contract, not an ordinary API-key endpoint. Use Settings → Integrations. The public API base URL does not grant session access.

JSON body example

The following shows the request shape, not live credentials or executable market defaults. Replace timestamps only when creating a new reviewed intent; never mutate them on a command retry.

{
  "operation_id": "66666666-6666-4666-8666-666666666666",
  "purpose": "credential",
  "request": {
    "name": "Demo controller",
    "kind": "api",
    "scopes": [
      "read",
      "positions:open",
      "positions:modify",
      "positions:terminate"
    ],
    "exchange_link_ids": [
      17
    ],
    "instrument_ids": [
      "COPY_EXACT_CATALOG_ID"
    ],
    "expires_at": 1893542400
  }
}

Response and errors

The generated response schema below is the wire contract. Preserve fixed-point strings, nullable fields and endpoint-specific envelopes. Inspect HTTP status and Content-Type before decoding failures; reused trading routes may return JSON or plain text. Authentication, entitlement and exact link/instrument restrictions apply in addition to endpoint validation. See errors and recovery. Do not automatically repeat a mutation after transport ambiguity. Trading commands reuse the exact immutable identity; credential issuance and template writes require their documented metadata/read reconciliation. Read the related guide for lifecycle, units and recovery semantics.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

operation_id

string<uuid>

required

purpose

enum<string>

required

Available options:

credential,

binding

request

object

required

Option 1
Option 2

Show child attributes

Response

Success

operation_id

string<uuid>

required

methods

enum<string>[]

required

Available options:

password,

apple

mfa_required

boolean

required

expires_at

integer<int64>

required

apple_nonce

string

Start purpose-bound five-minute reauthentication

curl --request POST \
  --url https://api.liftx.io/integrations/reauth/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "request": {
    "name": "<string>",
    "scopes": [],
    "exchange_link_ids": [
      4503599627370496
    ],
    "expires_at": 123,
    "instrument_ids": [
      "<string>"
    ],
    "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

import requests

url = "https://api.liftx.io/integrations/reauth/start"

payload = {
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "request": {
        "name": "<string>",
        "scopes": [],
        "exchange_link_ids": [4503599627370496],
        "expires_at": 123,
        "instrument_ids": ["<string>"],
        "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    operation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    request: {
      name: '<string>',
      scopes: [],
      exchange_link_ids: [4503599627370496],
      expires_at: 123,
      instrument_ids: ['<string>'],
      integration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    }
  })
};

fetch('https://api.liftx.io/integrations/reauth/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "operation_id": "66666666-6666-4666-8666-666666666666",
  "methods": [
    "password"
  ],
  "mfa_required": true,
  "expires_at": 1893456300
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Discovery and account data

Positions and history

Templates

Commands and streams

TradingView webhook

Session-only Settings

Start fresh authentication

Authorization

Behavior

JSON body example

Response and errors

Authorizations

Body

Response

​Authorization

​Behavior

​JSON body example

​Response and errors

Authorizations

Body

Response

Authorization

Behavior

JSON body example

Response and errors