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

Changes

Changed in 8 of the 65 revisions of this API.46417

Jul 17, 2026f1370c46e9e86See the full diff
- ●
  added the new BLOCK_TRADE_REPLAYED_SIGNATURE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_REPLAYED_SIGNATURE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new EVM_VAULT_OPERATORS_DISABLED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new EVM_VAULT_OPERATORS_DISABLED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new VAULT_DATA_PRIVATE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new VAULT_DATA_PRIVATE enum value to the //// response property for the response status
  response-property-enum-value-added
Jun 9, 202643b81de9b0796See the full diff
- ○
  removed the INVALID_RHINOFI_QUOTE enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the INVALID_RHINOFI_QUOTE enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the INVALID_RHINOFI_QUOTE_COMMIT enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the INVALID_RHINOFI_QUOTE_COMMIT enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the INVALID_RHINOFI_REQUEST enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the INVALID_RHINOFI_REQUEST enum value from the //// response property for the response status
  response-property-enum-value-removed
May 21, 20267861dbd35cf54See the full diff
- ●
  added the new IP_NOT_ALLOWED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new IP_NOT_ALLOWED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new MARKET_NOT_SETTLED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new MARKET_NOT_SETTLED enum value to the //// response property for the response status
  response-property-enum-value-added
May 7, 2026d24c9b025e4b4See the full diff
- ●
  added the new BLOCK_TRADE_INVALID_SIGNATURE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_INVALID_SIGNATURE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_SIGNER_KEY_UNAUTHORIZED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_SIGNER_KEY_UNAUTHORIZED enum value to the //// response property for the response status
  response-property-enum-value-added
May 4, 20266540e7a44a8381See the full diff
- ●
  added the new EVM_ADDRESS_ALREADY_ONBOARDED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new EVM_ADDRESS_ALREADY_ONBOARDED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new INSUFFICIENT_EVM_BALANCE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new INSUFFICIENT_EVM_BALANCE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new PORTFOLIO_MARGIN_INVALID_ACCOUNT_KIND enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new PORTFOLIO_MARGIN_INVALID_ACCOUNT_KIND enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new PORTFOLIO_MARGIN_ONBOARDING_DISABLED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new PORTFOLIO_MARGIN_ONBOARDING_DISABLED enum value to the //// response property for the response status
  response-property-enum-value-added
- ○
  added the new optional request property
  new-optional-request-property
Apr 29, 2026b83876e772af6See the full diff
- ○
  removed the BAD_STARKNET_REQUEST enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the BAD_STARKNET_REQUEST enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the INVALID_PRICE_PRECISION enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the INVALID_PRICE_PRECISION enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the TRANSACTION_NOT_FOUND enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the TRANSACTION_NOT_FOUND enum value from the //// response property for the response status
  response-property-enum-value-removed
Apr 22, 202646a57608a7903422See the full diff
- ▲
  the request property type changed from object to no type
  request-property-type-changed
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ●
  added the new BLOCK_TRADE_ACCOUNT_MISMATCH enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_ACCOUNT_MISMATCH enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_ALREADY_CANCELLED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_ALREADY_CANCELLED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_EXPIRED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_EXPIRED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_INVALID_STATUS enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_INVALID_STATUS enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_MISSING_SIGNATURE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_MISSING_SIGNATURE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_MISSING_SIGNERS enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_MISSING_SIGNERS enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_MISSING_TRADES enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_MISSING_TRADES enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_NOT_ENABLED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_NOT_ENABLED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_NOT_FOUND enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_NOT_FOUND enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_UNAUTHORIZED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new BLOCK_TRADE_UNAUTHORIZED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new EVM_SIGNATURE_VERIFICATION_FAILED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new EVM_SIGNATURE_VERIFICATION_FAILED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new INVALID_EVM_SIGNATURE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new INVALID_EVM_SIGNATURE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new MEDIA_NOT_FOUND enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new MEDIA_NOT_FOUND enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new OFFER_ALREADY_CANCELLED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new OFFER_ALREADY_CANCELLED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new OFFER_INVALID_STATUS enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new OFFER_INVALID_STATUS enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new OFFER_PARENT_MISMATCH enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new OFFER_PARENT_MISMATCH enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new OFFER_PARENT_NOT_ACCEPTING enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new OFFER_PARENT_NOT_ACCEPTING enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new OFFER_UNAUTHORIZED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new OFFER_UNAUTHORIZED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new PORTFOLIO_MARGIN_CONFIG_NOT_FOUND enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new PORTFOLIO_MARGIN_CONFIG_NOT_FOUND enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new SUBKEY_NOT_ACTIVATABLE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new SUBKEY_NOT_ACTIVATABLE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new XP_TRANSFERS_DISABLED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new XP_TRANSFERS_DISABLED enum value to the //// response property for the response status
  response-property-enum-value-added
- ○
  removed the INVALID_JOIN_WAITLIST_REQUEST enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the INVALID_JOIN_WAITLIST_REQUEST enum value from the //// response property for the response status
  response-property-enum-value-removed
Dec 24, 2025846a2e2b455b12See the full diff
- ▲
  added required request body
  request-body-added-required
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history