Authentication

Onboarding

Changed on

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

post/onboarding

Request

  • Base URL
    https://api.testnet.paradex.trade/v1
  • URL
    https://api.testnet.paradex.trade/v1/onboarding
  • Auth
    none declared. Required headers: PARADEX-ETHEREUM-ACCOUNT, PARADEX-STARKNET-ACCOUNT, PARADEX-STARKNET-SIGNATURE

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.

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

  • e0dd7ef9404fRevision changes
    • breaking

      added required request body

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status