---
title: "Onboarding"
method: POST
path: "/onboarding"
tags: ["Authentication"]
---

# Onboarding

`POST /onboarding`

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

## Headers

- `PARADEX-ETHEREUM-ACCOUNT` string, required
- `PARADEX-STARKNET-ACCOUNT` string, required
- `PARADEX-STARKNET-SIGNATURE` string, required

## Request body

- RequestsOnboarding
  - `marketing_code` string — Marketing code of the campaign the user is being onboarded via.
  - `portfolio_margin` boolean — When true, the new account is onboarded directly into Portfolio Margin mode. Only valid for main accounts and subaccounts.
  - `public_key` string — Public key of the user being onboarded.
  - `referral_code` string — Referral code of the user who referred the user being onboarded.
  - `utm` RequestsUtm
    - `campaign` string — UTM campaign parameter
    - `source` string — UTM source parameter
    - `type` string — UTM type parameter

## Response `200`

An empty response

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/tradeparadex/apis/paradex-rest-api-2.md) · [All operations](https://skmtc.net/tradeparadex/apis/paradex-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tradeparadex/paradex-rest-api-2/versions/6a76453d754c/schema)