Authentication

EVM Onboarding

Changed on

Onboard a new EVM account using SIWE signature

post/v2/onboarding

Request

  • Base URL
    https://api.prod.paradex.trade/v1
  • URL
    https://api.prod.paradex.trade/v1/v2/onboarding
  • Auth
    none declared. Required headers: PARADEX-STARKNET-ACCOUNT, PARADEX-EVM-SIGNATURE, PARADEX-SIWE-MESSAGE

Headers

PARADEX-STARKNET-ACCOUNTstring required

Starknet account

PARADEX-EVM-SIGNATUREstring required

EVM personal_sign signature

PARADEX-SIWE-MESSAGEstring required

Base64-encoded SIWE message

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

  • f33feb7333eaRevision changes
    • warning

      added the new ADDRESS_BOOK_NOT_PARADEX_ACCOUNT enum value to the //// response property for the response status

    • warning

      added the new ADDRESS_BOOK_NOT_PARADEX_ACCOUNT enum value to the //// response property for the response status

    • warning

      added the new ADDRESS_BOOK_REPEATED_IN_IMPORT enum value to the //// response property for the response status

    • warning

      added the new ADDRESS_BOOK_REPEATED_IN_IMPORT enum value to the //// response property for the response status

    • warning

      added the new STARKNET_PARENT_ONBOARDING_DISABLED enum value to the //// response property for the response status

    • warning

      added the new STARKNET_PARENT_ONBOARDING_DISABLED enum value to the //// response property for the response status

  • 72c125c93c2bRevision changes
    • warning

      added the new SESSION_EXPIRED enum value to the //// response property for the response status

    • warning

      added the new SESSION_EXPIRED enum value to the //// response property for the response status

    • warning

      added the new SESSION_REVOKED enum value to the //// response property for the response status

    • warning

      added the new SESSION_REVOKED enum value to the //// response property for the response status