> For a complete page index, fetch https://docs.transak.com/llms.txt

# Quickstart

This page takes you from a Transak API key to your first successful Whitelabel API call. It then lists the calls you make to place your first order.

## Before you start

You need:

* A partner account on the [Transak Partner Dashboard](https://dashboard.transak.com). See [How To Create a Partner Dashboard Account](/guides/how-to-create-partner-dashboard-account).
* Your **API Key**, from the **Developers** tab of the dashboard. Use the staging API key on staging and the production API key on production.
* A backend server. Whitelabel API calls must come from your backend, never from a browser or mobile app.

## Step 1: Get access

#### Ask Transak to enable the Whitelabel API for your API key

Your API key must be enabled for the Whitelabel API before the calls work. See [What does it take to get access to the Whitelabel API?](/guides/partner-faqs#what-does-it-take-to-get-access-to-the-whitelabel-api) for the commercial terms, and [Need help in Integration](/getting-started/help-and-support#need-help-in-integration) for how to reach the team.

#### Send your backend IP addresses for allowlisting

Transak only accepts Whitelabel API calls from allowlisted IP addresses. Share your backend's static egress IP addresses for both staging and production. See [Mandatory Security Changes](/guides/mandatory-security-changes).

## Step 2: Pick the base URL

| Environment | Base URL                              |
| ----------- | ------------------------------------- |
| Staging     | `https://api-gateway-stg.transak.com` |
| Production  | `https://api-gateway.transak.com`     |

Build and test on staging first. Staging KYC checks are dummy checks and always approve the user. See [How to Test Using Sandbox Credentials](/guides/sandbox-credentials) for test users and payment details.

## Step 3: Send the required headers

Send these headers on every call:

| Header      | Value                                                                                                                                        |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `x-api-key` | Your partner API key.                                                                                                                        |
| `x-user-ip` | The IP address of the end user you are calling for. See [User IP Header in APIs](/guides/mandatory-security-changes#user-ip-header-in-apis). |

Calls made for a logged-in user also need one of these two ways to authenticate the user. Use one or the other, never both:

| Method                           | Headers                                  | Token                                                                                                                                                                                                                                                                 |
| -------------------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Transak Auth**                 | `authorization`                          | The user's `accessToken` from [Verify User OTP](/api/whitelabel/user/verify-user-otp), sent on its own with no `Bearer` prefix. It is valid for 30 days. Renew it with [Refresh User Access Token](/api/whitelabel/user/refresh-user-access-token) before it expires. |
| **Partner Auth (Auth Reliance)** | `x-access-token` and `x-user-identifier` | Your Partner Access Token, valid for 7 days. See [How to Create a Partner Access Token](/guides/how-to-create-partner-access-token). `x-user-identifier` is the email address of the user you authenticated. See [Auth Reliance](/features/auth-reliance).            |

Lookup calls, such as Get Quote for a user who isn't logged in, need only `x-api-key` and `x-user-ip`. Each endpoint page in the API reference lists the headers it takes.

## Step 4: Make your first call

Get a price quote on staging for 50 GBP of USDC on Ethereum, paid by bank transfer. Get Quote also takes your API key as the `apiKey` query parameter.

**`Get Quote`**

```bash title="Get Quote"
curl -G https://api-gateway-stg.transak.com/api/v2/lookup/quotes \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'x-user-ip: USER_IP_ADDRESS' \
  -d apiKey=YOUR_API_KEY \
  -d fiatCurrency=GBP \
  -d cryptoCurrency=USDC \
  -d isBuyOrSell=BUY \
  -d network=ethereum \
  -d paymentMethod=gbp_bank_transfer \
  -d fiatAmount=50
```

A successful call returns `200` with a quote:

**`Response`**

```json title="Response"
{
  "data": {
    "feeBreakdown": [
      { "name": "Transak fee", "value": 1, "id": "transak_fee" },
      { "name": "Network/Exchange fee", "value": 0, "id": "network_fee" }
    ],
    "termsIds": [],
    "quoteId": "ea57d316-098a-4ead-8300-266a6d5bed5e",
    "conversionPrice": 1.1272686386059025,
    "slippage": 0.53,
    "fiatCurrency": "GBP",
    "cryptoCurrency": "USDC",
    "paymentMethod": "gbp_bank_transfer",
    "fiatAmount": 50,
    "cryptoAmount": 55.24,
    "isBuyOrSell": "BUY",
    "network": "ethereum",
    "networkId": "",
    "feeDecimal": 0.02,
    "totalFee": 1,
    "nonce": 1747890325
  }
}
```

If the call fails, check the `errorCode` in the response against [Error Codes](/api/whitelabel/error-codes). The API allows 40 requests per IP address every 10 seconds. See [What are the rate limits on the Whitelabel APIs?](/guides/partner-faqs#what-are-the-rate-limits-on-the-whitelabel-apis)

## Step 5: Place your first order

These are the calls for a first bank transfer order. The [Whitelabel API overview](/integration/api) has the full flow for each payment method.

#### Look up what the user can buy

[Get Countries](/api/whitelabel/lookup/get-countries), [Get Fiat Currencies](/api/whitelabel/lookup/get-fiat-currencies) and [Get Crypto Currencies](/api/whitelabel/lookup/get-crypto-currencies) return the supported countries, payment methods, cryptocurrencies and networks.

#### Get a quote

Call [Get Quote](/api/whitelabel/lookup/get-quote) and keep the `quoteId`. For US, EEA and UK users, show the disclaimers in `termsIds`. See [How to Display Disclaimers in Your API Integration](/guides/how-to-display-disclaimers-in-your-api-integration).

#### Log the user in

With Transak Auth, call [Send User OTP](/api/whitelabel/user/send-user-otp) and [Verify User OTP](/api/whitelabel/user/verify-user-otp) to get the user's `accessToken`. With Partner Auth (Auth Reliance), call [Onboard User](/api/whitelabel/user/onboard-user-auth-reliance) for a new user.

#### Complete KYC

Call [Get KYC Requirement](/api/whitelabel/kyc/get-kyc-requirement) with the `quoteId`, then submit what it asks for, starting with [Patch User Details](/api/whitelabel/kyc/patch-user-details).

#### Create the order

Check for an existing order with [Get Active Orders](/api/whitelabel/orders/get-active-orders), then call [Create Order](/api/whitelabel/payments/bank-transfer/create-order) with the `quoteId` and the user's wallet address.

#### Track the order

Call [Get Order By ID](/api/whitelabel/orders/get-order-by-id), or receive [order webhooks](/features/webhooks#order-webhooks). See [How to Track Order Status](/guides/track-order-status).

## Before you go live

* Your production API key is enabled for the Whitelabel API, and your production IP addresses are allowlisted.
* Your terms show [Transak's Terms of Service](https://transak.com/terms-of-service), and your app shows the disclaimers in `termsIds`.
* You have completed the [Mandatory Security Changes](/guides/mandatory-security-changes).
* Webhook URLs are registered for production. See [Add or Update Webhook](/features/webhooks#add-or-update-webhook).