v56

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-03113163377.5 KB

Authentication

Onboarding

Onboarding verifies that the caller owns the StarkNet address and enters them into the database. This call is idempotent.

post/onboarding

Headers

PARADEX-ETHEREUM-ACCOUNTstring required

Ethereum account used to onboard

PARADEX-STARKNET-ACCOUNTstring required

Starknet address

PARADEX-STARKNET-SIGNATUREstring required

Starknet signature

Request body

marketing_codestring

Marketing code of the campaign the user is being onboarded via.

portfolio_marginboolean

When true, the new account is onboarded directly into Portfolio Margin mode. Only valid for main accounts and subaccounts.

public_keystring

Public key of the user being onboarded.

referral_codestring

Referral code of the user who referred the user being onboarded.

Example request

{
  "marketing_code": "abcd:code1",
  "public_key": "0x3d9f2b2e5f50c1aade60ca540368cd7490160f41270c192c05729fe35b656a9",
  "referral_code": "cryptofox8",
  "utm": {
    "campaign": "summer2024",
    "source": "google",
    "type": "clickthrough"
  }
}

Response

An empty response