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

# Getting Started

The Transak Whitelabel API enables partners to integrate Transak products directly into their own platforms using APIs, without displaying any third-party user interface (such as the Transak Widget). It covers the complete integration lifecycle — country and currency lookup, user authentication, KYC submission, FCA compliance for UK users, order creation and management, headless payment flows (Apple Pay, Google Pay, and Cards), and virtual account payments.

# End Points

| Environment | Base URL                                                                   |
| ----------- | -------------------------------------------------------------------------- |
| Staging     | [https://api-gateway-stg.transak.com](https://api-gateway-stg.transak.com) |
| Production  | [https://api-gateway.transak.com](https://api-gateway.transak.com)         |

## Quick Navigation

### On Ramp

* **LookUp** — Fetch supported countries, currencies, and quotes.
  * [Get Countries](/api/whitelabel/lookup/get-countries)
  * [Get Crypto Currencies](/api/whitelabel/lookup/get-crypto-currencies)
  * [Get Fiat Currencies](/api/whitelabel/lookup/get-fiat-currencies)
  * [Get Quote](/api/whitelabel/lookup/get-quote)
* **User** — OTP-based authentication, user details, and access token lifecycle.
  * [Send User OTP](/api/whitelabel/user/send-user-otp)
  * [Verify User OTP](/api/whitelabel/user/verify-user-otp)
  * [Get User Limits](/api/whitelabel/user/get-user-limits)
  * [Get User Details](/api/whitelabel/user/get-user-details)
  * [Refresh User Access Token](/api/whitelabel/user/refresh-user-access-token)
  * [Logout User](/api/whitelabel/user/logout-user)
* **KYC** — Submit and manage KYC data including identity, documents, and source of income.
  * [Get KYC Requirement](/api/whitelabel/kyc/get-kyc-requirement)
  * [Get Additional Requirements](/api/whitelabel/kyc/get-additional-requirements)
  * [Get KYC - IdProof Status](/api/whitelabel/kyc/get-kyc-idproof-status)
  * [Patch User Details](/api/whitelabel/kyc/patch-user-details)
  * [Update Purpose Of Usage](/api/whitelabel/kyc/update-purpose-of-usage)
  * [Submit SSN](/api/whitelabel/kyc/submit-ssn)
  * [Submit Source of Income](/api/whitelabel/kyc/submit-source-of-income)
  * [Upload Proof Document](/api/whitelabel/kyc/upload-proof-document)
* **KYC Reliance (Using Sumsub)** — Share existing Sumsub KYC approvals with Transak to skip re-verification.
  * [Get KYC Reliance Quote](/api/whitelabel/kyc-reliance/get-kyc-reliance-quote)
  * [Get KYC Reliance Status](/api/whitelabel/kyc-reliance/get-kyc-reliance-status)
* **KYC Reliance (Using API)** — Submit KYC data via API — identity, document, and biometrics details.
  * [Identity Details](/api/whitelabel/kyc-reliance-api/kyc-reliance-identity-details)
  * [Document Details](/api/whitelabel/kyc-reliance-api/kyc-reliance-document-details)
  * [Biometrics Details](/api/whitelabel/kyc-reliance-api/kyc-reliance-biometrics-details)
* **FCA** — Complete FCA compliance steps for UK users — categorization, agreement, and risk assessment.
  * [Get FCA Requirements](/api/whitelabel/fca/get-fca-requirements)
  * [Submit FCA Requirements](/api/whitelabel/fca/submit-fca-requirements)
  * [Get FCA Status](/api/whitelabel/fca/get-fca-status)
* **Orders** — Create, track, and cancel crypto purchase orders.
  * [Create Widget URL (Cards, Apple Pay)](/api/whitelabel/orders/create-widget-url-cards)
  * [Get Active Orders](/api/whitelabel/orders/get-active-orders)
  * [Get Orders](/api/whitelabel/orders/get-orders)
  * [Get Order By ID](/api/whitelabel/orders/get-order-by-id)
  * [Cancel Order](/api/whitelabel/orders/cancel-order)
  * [Request OTT (Deprecated)](/api/whitelabel/orders/request-ott)

### Payments

* **Headless Apple Pay** — Embed Apple Pay directly in your own UI without loading the Transak widget.
  * [Transaction Session API](/api/whitelabel/payments/headless-apple-pay/transaction-session-api)
  * [Create Order API](/api/whitelabel/payments/headless-apple-pay/create-order-for-apple-pay)
  * [Transaction Request Status API](/api/whitelabel/payments/headless-apple-pay/transaction-request-status-api)
* **Headless Google Pay** — Embed Google Pay directly in your own UI without loading the Transak widget.
  * [Transaction Session API](/api/whitelabel/payments/headless-google-pay/transaction-session-api)
  * [Create Order API](/api/whitelabel/payments/headless-google-pay/create-order-for-google-pay)
  * [Transaction Request Status API](/api/whitelabel/payments/headless-google-pay/transaction-request-status-api)
* **Headless Cards** — Embed a card payment form directly in your own UI without loading the Transak widget.
  * [Transaction Session API](/api/whitelabel/payments/headless-cards/transaction-session-api)
  * [Create Order (with New Card)](/api/whitelabel/payments/headless-cards/create-order-with-new-card)
  * [Transaction Request Status API](/api/whitelabel/payments/headless-cards/transaction-request-status-api)
  * [Get Saved Cards](/api/whitelabel/payments/headless-cards/get-saved-cards)
  * [Create Order (with Saved Card)](/api/whitelabel/payments/headless-cards/create-order-with-saved-card)
  * [Delete Saved Cards](/api/whitelabel/payments/headless-cards/delete-saved-cards)
* **Bank Transfer** — Create GBP bank transfer orders directly in your own UI.
  * [Create Virtual Account](/api/whitelabel/payments/bank-transfer/create-virtual-account)
  * [Get Virtual Account Status](/api/whitelabel/payments/bank-transfer/get-virtual-account-status)
  * [Get VASPs](/api/whitelabel/payments/bank-transfer/get-vasps)
  * [Create Order](/api/whitelabel/payments/bank-transfer/create-order)
  * [Confirm Payment](/api/whitelabel/payments/bank-transfer/confirm-payment)
* **Open Banking** — Create Open Banking orders with authorisation via bank redirect.
  * [Create Virtual Account](/api/whitelabel/payments/open-banking/create-virtual-account)
  * [Get Virtual Account Status](/api/whitelabel/payments/open-banking/get-virtual-account-status)
  * [Get VASPs](/api/whitelabel/payments/open-banking/get-vasps)
  * [Create Order](/api/whitelabel/payments/open-banking/create-order)

### Virtual Account Payments

* [Create VBA](/api/whitelabel/virtual-account-payments/create-virtual-bank-account) — Create a virtual bank account with payout details.
* [Get VBA List](/api/whitelabel/virtual-account-payments/get-virtual-bank-account-list) — Retrieve all virtual bank accounts.
* [Get VBA by ID](/api/whitelabel/virtual-account-payments/get-virtual-bank-account-by-id) — Retrieve a specific virtual bank account.
* [Update VBA](/api/whitelabel/virtual-account-payments/update-virtual-bank-account) — Update wallet or network configuration for a VBA.
* [Delete VBA](/api/whitelabel/virtual-account-payments/delete-virtual-bank-account) — Delete a virtual bank account.
* [Simulate VBA Transaction](/api/whitelabel/virtual-account-payments/simulate-virtual-bank-account-transaction) — Simulate an incoming bank transfer to a virtual bank account.