***

title: Whitelabel API
slug: integration/api
subtitle: A complete API solution for building custom on/off ramp experiences.
max-toc-depth: 2
----------------

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).

Partners maintain complete control over the **user interface and end-to-end user journey**, while Transak manages the backend complexities through APIs, including KYC, compliance, liquidity, payment processing, and fraud management.

## Who Should Use This?

This solution is ideal for partners who want to fully own and control the **E2E user journey**, **including the user interface, experience, and flow**.

<table>
  <tbody>
    <tr>
      <td>
        <div>
          <Icon icon="fa-light fa-wallet" size="6" color="#1461db" />

          <strong>
            Wallets
          </strong>
        </div>

        Integrate fiat on/off-ramps directly into wallet interfaces for seamless user experience.
      </td>
    </tr>

    <tr>
      <td>
        <div>
          <Icon icon="fa-light fa-arrows-rotate" size="6" color="#1461db" />

          <strong>
            DEXs or CEXs
          </strong>
        </div>

        Enable users to buy and sell crypto within your exchange platform using fiat.
      </td>
    </tr>

    <tr>
      <td>
        <div>
          <Icon icon="fa-light fa-cube" size="6" color="#1461db" />

          <strong>
            DApps
          </strong>
        </div>

        Add fiat payment options to decentralized applications for broader user accessibility.
      </td>
    </tr>

    <tr>
      <td>
        <div>
          <Icon icon="fa-light fa-building" size="6" color="#1461db" />

          <strong>
            Fintech Apps
          </strong>
        </div>

        Power remittances, neobanks, and cross-border payment solutions with crypto rails.
      </td>
    </tr>
  </tbody>
</table>

## Key Capabilities

Build and control the complete user journey, from authentication and KYC to order creation and tracking, without any third-party UI.

<CardGroup cols={2}>
  <Card title="Multi-Asset & Multi-Chain Support" icon="fa-light fa-coins" iconPosition="left" href="https://transak.com/crypto-coverage">
    Access 36+ cryptocurrencies across 45+ blockchains in 64+ countries with transparent pricing via Lookup APIs.
  </Card>

  <Card title="Automated Order Management" icon="fa-light fa-gears" iconPosition="left" href="/features/webhooks">
    Create and track orders programmatically using REST APIs, Webhooks, and WebSockets.
  </Card>

  <Card title="Compliance & Risk Management" icon="fa-light fa-shield-halved" iconPosition="left" href="https://transak.com/compliance">
    Transak handles KYC, AML, transaction monitoring, and regulatory compliance.
  </Card>

  <Card title="KYC Reliance Via Sumsub" icon="fa-light fa-user-check" iconPosition="left" href="/features/kyc-reliance-sumsub">
    Reuse your existing KYC data with Transak through Sumsub for faster onboarding.
  </Card>
</CardGroup>

## Partner Integration Prerequisites

<Steps>
  <Step title="Contact & Request Whitelabel APIs access">
    Follow the steps in the [Need help in Integration](/getting-started/help-and-support#need-help-in-integration) section to reach us. Then raise the request to enable **Whitelabel APIs** for your API key and share your public IP addresses with Transak for whitelisting to use our APIs in your backend.
  </Step>

  <Step title="Start Whitelabel API Integration">
    Start by designing and implementing the complete user flow, including error handling. See the [Lookup API reference](/api/whitelabel/lookup/get-countries) to begin.
  </Step>

  <Step title="Include Transak's Terms & Conditions">
    You must include [Transak's Terms of Service](https://transak.com/terms-of-service) within their own Terms & Conditions. End users must be able to review and acknowledge Transak's T\&C as part of the user journey.
  </Step>
</Steps>

## Current Limitations & Known Constraints

<table>
  <thead>
    <tr>
      <th>
        Product
      </th>

      <th>
        Supported
      </th>

      <th>
        Limitations
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <strong>
          On Ramp
        </strong>
      </td>

      <td>
        <Badge intent="success" minimal>
          Yes
        </Badge>
      </td>

      <td>
        <strong>Card / Apple Pay:</strong> Semi-widget flow required. Navigate to Transak's Widget to add cards and place orders.<br /><br />
        <strong>Google Pay:</strong> Not supported.<br /><br />
        <strong>Bank Transfers:</strong> Fully supported through APIs.<br /><br />
        <strong>Lite KYC:</strong> Fully supported through APIs (Personal & Address details).<br /><br />
        <strong>Standard KYC:</strong> Navigate to Transak's provider widget to upload Document ID Proof and conduct Liveness checks.
      </td>
    </tr>

    <tr>
      <td>
        <strong>
          Off Ramp
        </strong>
      </td>

      <td>
        <Badge intent="error" minimal>
          No
        </Badge>
      </td>

      <td>
        NA
      </td>
    </tr>

    <tr>
      <td>
        <strong>
          NFT Checkout
        </strong>
      </td>

      <td>
        <Badge intent="error" minimal>
          No
        </Badge>
      </td>

      <td>
        NA
      </td>
    </tr>

    <tr>
      <td>
        <strong>
          KYC Reliance Via Sumsub
        </strong>
      </td>

      <td>
        <Badge intent="success" minimal>
          Yes
        </Badge>
      </td>

      <td>
        Not supported for US KYC users
      </td>
    </tr>

    <tr>
      <td>
        <strong>
          Transak Stream - Off Ramp
        </strong>
      </td>

      <td>
        <Badge intent="error" minimal>
          No
        </Badge>
      </td>

      <td>
        NA
      </td>
    </tr>

    <tr>
      <td>
        <strong>
          Transak Stream - On Ramp
        </strong>
      </td>

      <td>
        <Badge intent="error" minimal>
          No
        </Badge>
      </td>

      <td>
        NA
      </td>
    </tr>
  </tbody>
</table>

<div>
  <div>
    Whitelabel APIs are to be called only from the partner backend and subjected to the whitelisting of partner IP addresses. Direct API calls from the frontend apps are not supported.
  </div>
</div>

## API Overview

<Frame>
  <iframe src="https://embed.figma.com/board/ew7PoPDNks3NvJGde9cQn6/Whitelabel-V2-Flow?node-id=0-1&embed-host=share" allowFullScreen width={800} height={450} />
</Frame>

<AccordionGroup>
  <Accordion title="Lookup">
    Lookup APIs provide public reference data that you can use before initiating a session. Use them to populate currency selectors, validate supported regions, and fetch real-time quotes — no authentication required.

    <Cards cols={2}>
      <Card title="Get Crypto Currencies" icon="fa-light fa-coins" iconPosition="left" href="/api/whitelabel/lookup/get-crypto-currencies" external>
        Returns a list of supported crypto assets with network and symbol details.
      </Card>

      <Card title="Get Fiat Currencies" icon="fa-light fa-money-bill" iconPosition="left" href="/api/whitelabel/lookup/get-fiat-currencies" external>
        Returns all supported fiat currencies along with their default locale mappings.
      </Card>

      <Card title="Get Countries" icon="fa-light fa-globe" iconPosition="left" href="/api/whitelabel/lookup/get-countries" external>
        Returns supported countries and any applicable regional restrictions.
      </Card>

      <Card title="Get Quote" icon="fa-light fa-file-invoice-dollar" iconPosition="left" href="/api/whitelabel/lookup/get-quote" external>
        Returns a real-time quote with the expected amount and fee breakdown.
      </Card>
    </Cards>
  </Accordion>

  <Accordion title="User">
    <Tabs>
      <Tab title="Login Flow">
        <Frame>
          <img src="https://files.buildwithfern.com/visual-editor-images/transak-labs.docs.buildwithfern.com/2026-03-15T15:02:12.472Z/integration/headless/user/ZXhpc3Rpbmd1c2VyLnBuZw==.png" alt="Logged In User Flow Chart" title="Logged In User Flow Chart" noZoom={false} />
        </Frame>

        <Steps>
          <Step title="Lookup">
            Fetch all required data before presenting the order form.

            <Cards cols={2}>
              <Card title="Get Fiat Currencies" icon="fa-light fa-money-bill" iconPosition="left" href="/api/whitelabel/lookup/get-fiat-currencies" external>
                Fetch supported fiat currencies and payment methods.
              </Card>

              <Card title="Get Crypto Currencies" icon="fa-light fa-coins" iconPosition="left" href="/api/whitelabel/lookup/get-crypto-currencies" external>
                Fetch available crypto assets and networks.
              </Card>
            </Cards>

            <Cards cols={2}>
              <Card title="Get Quote" icon="fa-light fa-file-invoice-dollar" iconPosition="left" href="/api/whitelabel/lookup/get-quote" external>
                Pass values from the steps above to get a real-time quote.
              </Card>
            </Cards>
          </Step>

          <Step title="Get User Details">
            Pass the existing **User Access Token** to <a href="/api/whitelabel/user/get-user-details" target="_blank">Get User Details</a> to fetch the user's KYC status. Route the user as follows:

            <table>
              <thead>
                <tr>
                  <th>
                    Condition
                  </th>

                  <th>
                    Next step
                  </th>
                </tr>
              </thead>

              <tbody>
                <tr>
                  <td>
                    <code>response = 200</code> and <code>data.kyc.status === "APPROVED"</code>
                  </td>

                  <td>
                    Proceed to <strong>Create Order — Bank Transfer</strong> or <strong>Create Order — Cards, Apple Pay</strong> flow
                  </td>
                </tr>

                <tr>
                  <td>
                    <code>response = 200</code> and <code>data.kyc.status === "NOT\_SUBMITTED"</code>
                  </td>

                  <td>
                    Proceed to <strong>KYC Flow</strong>
                  </td>
                </tr>

                <tr>
                  <td>
                    <code>response = 200</code> and <code>data.kyc.status === "ADDITIONAL\_FORMS\_REQUIRED"</code>
                  </td>

                  <td>
                    Proceed to <strong>Additional KYC Flow</strong>
                  </td>
                </tr>

                <tr>
                  <td>
                    <code>
                      response = 401
                    </code>
                  </td>

                  <td>
                    Proceed to <strong>Not Logged In Flow</strong> — the User Access Token is missing, expired, or invalid. Re-authenticate using the <strong>Not Logged In Flow</strong> tab (Send User OTP → Verify User OTP).
                  </td>
                </tr>
              </tbody>
            </table>
          </Step>
        </Steps>
      </Tab>

      <Tab title="Not Logged In Flow">
        <Frame>
          <img src="https://files.buildwithfern.com/visual-editor-images/transak-labs.docs.buildwithfern.com/2026-03-15T15:05:08.639Z/integration/headless/user/a2b7527c210224c0e52f69dc21984a9accf823389cc6e03e1b897632b58d9f67-CleanShot_2026-01-23_at_15.05.302x_(1).png" alt="Not Logged In Flow" title="Not Logged In Flow" noZoom={false} />
        </Frame>

        <Steps>
          <Step title="Lookup">
            Fetch all required data before presenting the order form.

            <Cards cols={2}>
              <Card title="Get Fiat Currencies" icon="fa-light fa-money-bill" iconPosition="left" href="/api/whitelabel/lookup/get-fiat-currencies" external>
                Fetch supported fiat currencies and payment methods.
              </Card>

              <Card title="Get Crypto Currencies" icon="fa-light fa-coins" iconPosition="left" href="/api/whitelabel/lookup/get-crypto-currencies" external>
                Fetch available crypto assets and networks.
              </Card>
            </Cards>

            <Cards cols={2}>
              <Card title="Get Quote" icon="fa-light fa-file-invoice-dollar" iconPosition="left" href="/api/whitelabel/lookup/get-quote" external>
                Pass values from the steps above to get a real-time quote.
              </Card>
            </Cards>
          </Step>

          <Step title="Send User OTP">
            Call <a href="/api/whitelabel/user/send-user-otp" target="_blank">Send User OTP</a> with the user's **email address**.

            Transak sends a one-time password to the user's inbox.
          </Step>

          <Step title="Verify User OTP">
            Call <a href="/api/whitelabel/user/verify-user-otp" target="_blank">Verify User OTP</a> with the following parameters:

            <table>
              <tbody>
                <tr>
                  <td>
                    <ParamField path="email" type="string" required={true}>
                      The user's email address
                    </ParamField>

                    <ParamField path="otp" type="string" required={true}>
                      The one-time password from the user's inbox
                    </ParamField>

                    <ParamField path="stateToken" type="string" required={true}>
                      Returned in the Send User OTP response
                    </ParamField>
                  </td>
                </tr>
              </tbody>
            </table>

            <Callout intent="important" title="Save the Access Token">
              On success, store `data.accessToken` — this is the **User Access Token** required for all subsequent authenticated API calls.
            </Callout>
          </Step>

          <Step title="Get User Details">
            Pass the **User Access Token** to <a href="/api/whitelabel/user/get-user-details" target="_blank">Get User Details</a> → fetch the user's KYC status.

            <table>
              <thead>
                <tr>
                  <th>
                    Condition
                  </th>

                  <th>
                    Next step
                  </th>
                </tr>
              </thead>

              <tbody>
                <tr>
                  <td>
                    <code>
                      data.kyc.status === "APPROVED"
                    </code>
                  </td>

                  <td>
                    Proceed to <strong>Create Order</strong> (Bank Transfer / Cards / Apple Pay Flow)
                  </td>
                </tr>

                <tr>
                  <td>
                    <code>
                      data.kyc.status === "NOT_SUBMITTED"
                    </code>
                  </td>

                  <td>
                    Proceed to <strong>KYC Flow</strong>
                  </td>
                </tr>

                <tr>
                  <td>
                    <code>
                      data.kyc.status === "ADDITIONAL_FORMS_REQUIRED"
                    </code>
                  </td>

                  <td>
                    Proceed to <strong>Additional KYC Flow</strong>
                  </td>
                </tr>
              </tbody>
            </table>
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Accordion>

  <Accordion title="KYC">
    This document provides a detailed explanation of KYC flows, covering Simple KYC, Standard KYC and Enhanced KYC, along with the required API interactions and processes. KYC is a mandatory step in compliance with regulatory requirements before users can place orders on Transak.

    ### KYC FlowChart

    <Frame>
      <img src="https://files.buildwithfern.com/visual-editor-images/transak-labs.docs.buildwithfern.com/2026-03-15T15:07:30.115Z/integration/headless/kyc/666a6268ff759790e1faf1accc8ae02914cb3509a607843ef186764255dfbdde-VW50aXRsZWQgRGlhZ3JhbS5wbmc.png" alt="KYC Flow Diagram&#x22;" title="KYC Flow Diagram&#x22;" noZoom={false} />
    </Frame>

    | **KYC Type**     | **Requirements**                                                                                                                              |
    | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
    | **Simple KYC**   | Personal Details, Address Details, SSN (for US users only)                                                                                    |
    | **Standard KYC** | Personal Details, Address Details, SSN (for US users only), ID Proof Upload, Liveness Check (Selfie)                                          |
    | **Enhanced KYC** | Personal Details, Address Details, SSN (for US users only), Source of Income, Proof Document Upload, ID Proof Upload, Liveness Check (Selfie) |

    ### Fetch KYC Requirement Based on Quote ID

    The **KYC requirements** are determined dynamically using the quote ID. Transak supports multi-level KYC, meaning different users may have different requirements based on country, regulations, and transaction limits.

    When fetching **KYC Requirement, there can be three status** -

    | **KYC Status**                                                    | **Description**                                                                                        |
    | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
    | <Badge intent="success" minimal>APPROVED</Badge>                  | KYC is done and approved by Transak. User can proceed with the order creation flow.                    |
    | <Badge intent="success" minimal>SUBMITTED</Badge>                 | KYC personal and address details or additional forms are submitted.                                    |
    | <Badge intent="warning" minimal>NOT\_SUBMITTED</Badge>            | KYC personal and address details are not submitted.                                                    |
    | <Badge intent="error" minimal>ADDITIONAL\_FORMS\_REQUIRED</Badge> | All details are submitted but some more additional requirements need to be fulfilled for KYC approval. |

    * **Personal Details** → First name, last name, email, and mobile number.
    * **Address Details** → User's residential details (address, city, state, zip code).
    * **Purpose of Usage** → Used for compliance with regulations.
    * **ID Proof** → Required only if **Standard or Enhanced KYC** is needed.
    * **SSN** → Required only for **US KYC** users.
    * **Source of Income** → Required only if **Enhanced KYC** is needed.
    * **Proof Document** → Required only if **Enhanced KYC** is needed.

    <Frame>
      <div>
        All forms must be submitted in the sequence provided in the **Get Additional Requirements** API.
      </div>
    </Frame>

    ### KYC Flow - Step-by-Step Guide

    <Steps>
      <Step title="Fetch KYC Status">
        Use this step to fetch the current status of the user's KYC, based on the `quoteId`.

        Call <a href="/api/whitelabel/kyc/get-kyc-requirement" target="_blank">Get KYC Requirement</a> with the `quoteId` (and the **User Access Token** as required by the API).

        <table>
          <thead>
            <tr>
              <th>
                Condition
              </th>

              <th>
                Next step
              </th>
            </tr>
          </thead>

          <tbody>
            <tr>
              <td>
                <code>data.kyc.status</code> = <strong>APPROVED</strong>
              </td>

              <td>
                Move forward with the <strong>Create Order Flow</strong>
              </td>
            </tr>

            <tr>
              <td>
                <code>data.kyc.status</code> = <strong>NOT\_SUBMITTED</strong>
              </td>

              <td>
                Follow <strong>Step 2</strong>
              </td>
            </tr>

            <tr>
              <td>
                <code>data.kyc.status</code> = <strong>ADDITIONAL\_FORMS\_REQUIRED</strong>
              </td>

              <td>
                Follow <strong>Step 3</strong>
              </td>
            </tr>
          </tbody>
        </table>
      </Step>

      <Step title="Patch User Details">
        Call <a href="/api/whitelabel/kyc/patch-user-details" target="_blank">Patch User Details</a> to collect and submit the user's profile and address information.

        **Personal Information**

        <table>
          <tbody>
            <tr>
              <td>
                <ParamField path="firstName" type="string" required={true}>
                  User's first name
                </ParamField>

                <ParamField path="lastName" type="string" required={true}>
                  User's last name
                </ParamField>

                <ParamField path="mobileNumber" type="string" required={true}>
                  Mobile number with country code
                </ParamField>

                <ParamField path="dateOfBirth" type="string" required={true}>
                  Date of birth (ISO 8601)
                </ParamField>
              </td>
            </tr>
          </tbody>
        </table>

        **Address Information**

        <table>
          <tbody>
            <tr>
              <td>
                <ParamField path="addressLine1" type="string" required={true}>
                  Street address
                </ParamField>

                <ParamField path="city" type="string" required={true}>
                  City
                </ParamField>

                <ParamField path="state" type="string" required={true}>
                  State or province
                </ParamField>

                <ParamField path="postCode" type="string" required={true}>
                  Postal or zip code
                </ParamField>

                <ParamField path="country" type="string" required={true}>
                  Country code (ISO 3166-1 alpha-2)
                </ParamField>
              </td>
            </tr>
          </tbody>
        </table>

        Once submitted, return to **Step 1** to re-fetch the updated KYC status.
      </Step>

      <Step title="Get Additional Requirements">
        Call <a href="/api/whitelabel/kyc/get-additional-requirements" target="_blank">Get Additional Requirements</a> to check which forms still need to be completed.

        Check if additional information must be provided for KYC Approval. Multiple forms may appear and must be submitted **in the sequence provided** in the API response:

        1. If `type = PURPOSE_OF_USAGE` → Follow **Step 4**
        2. If `type = IDPROOF` → Follow **Step 5**
        3. If `type = US_SSN` → Follow **Step 6**
        4. If `type = SOURCE_OF_INCOME` → Follow **Step 7**
        5. If `type = DOCUMENT_PROOF` → Follow **Step 8**
      </Step>

      <Step title="Post Purpose of Usage">
        Call <a href="/api/whitelabel/kyc/update-purpose-of-usage" target="_blank">Update Purpose of Usage</a> to record the user's reason for buying crypto.

        Ask user for their reason to buy crypto (e.g., investing, remittance).
      </Step>

      <Step title="Complete ID Proof & Liveness Check">
        <Badge intent="neutral" minimal>
          Standard KYC only
        </Badge>

        Redirect the user to the Transak-hosted KYC widget using the `kycUrl` returned in the Additional Requirements response.

        <table>
          <tbody>
            <tr>
              <td>
                <ParamField path="ID Proof Upload" type="action">
                  Upload a photo ID — Passport, Driver's License, or National ID
                </ParamField>

                <ParamField path="Liveness Check" type="action">
                  Submit a selfie for real-time identity validation
                </ParamField>
              </td>
            </tr>
          </tbody>
        </table>

        <Callout intent="info" title="Widget-based step">
          This step is handled by the Transak KYC widget. Use the `kycUrl` from the previous API response to redirect the user.
        </Callout>
      </Step>

      <Step title="Submit SSN">
        <Badge intent="warning" minimal>
          US users only
        </Badge>

        Call <a href="/api/whitelabel/kyc/submit-ssn" target="_blank">Submit SSN</a> to validate the user's identity using their Social Security Number.

        <table>
          <tbody>
            <tr>
              <td>
                <ParamField path="ssn" type="string" required={true}>
                  9-digit Social Security Number
                </ParamField>
              </td>
            </tr>
          </tbody>
        </table>

        <Callout intent="warning" title="Required before virtual bank creation">
          SSN must be submitted before a virtual bank account can be created for the user.
        </Callout>
      </Step>

      <Step title="Submit Source of Income">
        <Badge intent="neutral" minimal>
          Enhanced KYC only
        </Badge>

        Call <a href="/api/whitelabel/kyc/submit-source-of-income" target="_blank">Submit Source of Income</a> to capture the user's primary income source. Required for higher transaction limits.

        <table>
          <tbody>
            <tr>
              <td>
                <ParamField path="sourceOfIncome" type="string" required={true}>
                  Accepted values: `SALARY`, `BUSINESS`, `INVESTMENTS`, `SAVINGS`
                </ParamField>
              </td>
            </tr>
          </tbody>
        </table>
      </Step>

      <Step title="Upload Proof Document">
        <Badge intent="neutral" minimal>
          Enhanced KYC only
        </Badge>

        Call <a href="/api/whitelabel/kyc/upload-proof-document" target="_blank">Upload Proof Document</a> to submit supporting documentation for the income source selected in the previous step.

        <Callout intent="info" title="Document type depends on income source">
          The required document type is determined by the source of income submitted in Step 7.
        </Callout>
      </Step>
    </Steps>

    ### Different KYC Levels Guide

    | KYC Type   | KYC Status                                             | User Status                                      | Action                                                                                                                                                                     |
    | ---------- | ------------------------------------------------------ | ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | `null`     | <Badge intent="warning" minimal>NOT\_SUBMITTED</Badge> | <Badge intent="success" minimal>ACTIVE</Badge>   | Call **GET KYC Requirement API** → Complete KYC Forms                                                                                                                      |
    | `SIMPLE`   | <Badge intent="info" minimal>SUBMITTED</Badge>         | <Badge intent="success" minimal>ACTIVE</Badge>   | Poll **GET User Details API**                                                                                                                                              |
    | `SIMPLE`   | <Badge intent="success" minimal>APPROVED</Badge>       | <Badge intent="success" minimal>ACTIVE</Badge>   | Call **GET KYC Requirement API** → If `APPROVED` place order → If `ADDITIONAL_FORMS_REQUIRED` call Get Additional Requirements API → If `NOT_SUBMITTED` patch user details |
    | `SIMPLE`   | <Badge intent="danger" minimal>REJECTED</Badge>        | <Badge intent="success" minimal>ACTIVE</Badge>   | Call **GET KYC Requirement API** → If `ADDITIONAL_FORMS_REQUIRED` call Get Additional Requirements API → If `NOT_SUBMITTED` patch user details                             |
    | `STANDARD` | <Badge intent="info" minimal>SUBMITTED</Badge>         | <Badge intent="success" minimal>ACTIVE</Badge>   | Poll **GET User Details API**                                                                                                                                              |
    | `STANDARD` | <Badge intent="success" minimal>APPROVED</Badge>       | <Badge intent="success" minimal>ACTIVE</Badge>   | Call **GET KYC Requirement API** → If `APPROVED` place order → If `ADDITIONAL_FORMS_REQUIRED` call Get Additional Requirements API                                         |
    | `STANDARD` | <Badge intent="danger" minimal>REJECTED</Badge>        | <Badge intent="success" minimal>ACTIVE</Badge>   | Call **GET KYC Requirement API** → If `APPROVED` place order → If `ADDITIONAL_FORMS_REQUIRED` call Get Additional Requirements API → If `NOT_SUBMITTED` patch user details |
    | `STANDARD` | <Badge intent="danger" minimal>REJECTED</Badge>        | <Badge intent="neutral" minimal>DISABLED</Badge> | Show static screen — Contact Support                                                                                                                                       |
    | `ENHANCED` | <Badge intent="info" minimal>SUBMITTED</Badge>         | <Badge intent="success" minimal>ACTIVE</Badge>   | Poll **GET User Details API**                                                                                                                                              |
    | `ENHANCED` | <Badge intent="success" minimal>APPROVED</Badge>       | <Badge intent="success" minimal>ACTIVE</Badge>   | Call **GET KYC Requirement API** → If `APPROVED` place order                                                                                                               |
    | `ENHANCED` | <Badge intent="danger" minimal>REJECTED</Badge>        | <Badge intent="success" minimal>ACTIVE</Badge>   | Call **GET KYC Requirement API** → If `APPROVED` place order → If `ADDITIONAL_FORMS_REQUIRED` call Get Additional Requirements API → If `NOT_SUBMITTED` patch user details |
    | `ENHANCED` | <Badge intent="danger" minimal>REJECTED</Badge>        | <Badge intent="neutral" minimal>DISABLED</Badge> | Show static screen — Contact Support                                                                                                                                       |
  </Accordion>

  <Accordion title="KYC Reliance" icon="duotone handshake">
    <Frame>
      <img src="https://files.buildwithfern.com/visual-editor-images/transak-labs.docs.buildwithfern.com/2026-03-15T15:10:01.074Z/integration/headless/kyc-reliance/a3ljX3JlbGlhbmNlLnBuZw==.png" alt="KYC Reliance Flow Chart" title="KYC Reliance Flow Chart" noZoom={false} />
    </Frame>

    ### API Sequence

    <Steps>
      <Step title="Get KYC Reliance Quote">
        Call <a href="/api/whitelabel/kyc-reliance/get-kyc-reliance-quote" target="_blank">Get KYC Reliance Quote</a> with `kycShareTokenProvider` and `kycShareToken` alongside the common fields used in the standard Get Quote API.

        On success, you will receive a `quoteId` to use in the next step.
      </Step>

      <Step title="Get KYC Reliance Status">
        Call <a href="/api/whitelabel/kyc-reliance/get-kyc-reliance-status" target="_blank">Get KYC Reliance Status</a> with the `quoteId` and `kycShareToken` to fetch the user's KYC status, then route accordingly:

        <table>
          <tbody>
            <tr>
              <td>
                <ParamField path="kycStatus" type="FAILED · 401 · 500">
                  Generate a **new KYC Share Token** and repeat from Step 1.
                </ParamField>

                <ParamField path="kycStatus" type="IMPORTED · DONE">
                  Proceed to **Get KYC Steps**.
                </ParamField>
              </td>
            </tr>
          </tbody>
        </table>
      </Step>
    </Steps>

    ### Things to Consider

    1. KYC Reliance supports only SumSub providers, and more are coming soon.
    2. KYC Reliance supports only Standard KYC as the default process, where Document ID and Selfie checks are mandatory. The partners should pass the Document ID and Selfie documents to get the complete whitelabel experience to onboard their users seamlessly as per the steps mentioned in the <a href="/pages/features/kyc-reliance-sumsub" target="_blank">docs</a>.
    3. Purpose Of Purchase is a mandatory step in Transak's KYC system, even for KYC Reliance flows.
    4. Refer to the detailed step-by-step guide to generating the KYC Share token using SumSub <a href="/features/kyc-reliance-sumsub#quick-setup" target="_blank">docs</a>.
  </Accordion>

  <Accordion title="Orders" icon="duotone receipt">
    <Tabs>
      <Tab title="Bank Transfer">
        <Frame>
          <img src="https://files.buildwithfern.com/visual-editor-images/transak-labs.docs.buildwithfern.com/2026-03-15T15:11:38.583Z/integration/headless/orders/2d77f9693c9d729adfa5b99291de2201010956c7c8c4a2cb33bf11147fc9a745-bank-order-flow.png" alt="Bank Transfer Flow Chart" title="Bank Transfer Flow Chart" noZoom={false} />
        </Frame>

        <Steps>
          <Step title="Get KYC Requirement">
            Call <a href="/api/whitelabel/kyc/get-kyc-requirement" target="_blank">Get KYC Requirement</a> with the `quoteId` to fetch the user's KYC status and route accordingly:

            <table>
              <thead>
                <tr>
                  <th>
                    When
                  </th>

                  <th>
                    Next step
                  </th>
                </tr>
              </thead>

              <tbody>
                <tr>
                  <td>
                    <code>data.kyc.status</code> = <strong>APPROVED</strong>
                  </td>

                  <td>
                    No further steps in the KYC process. Proceed to <strong>Get User Limits</strong>.
                  </td>
                </tr>

                <tr>
                  <td>
                    <code>data.kyc.status</code> = <strong>NOT\_SUBMITTED</strong>
                  </td>

                  <td>
                    User details need to be submitted. Proceed to <strong>Patch User Details</strong>.
                  </td>
                </tr>

                <tr>
                  <td>
                    <code>data.kyc.status</code> = <strong>ADDITIONAL\_FORMS\_REQUIRED</strong>
                  </td>

                  <td>
                    More steps in the KYC process are required. Proceed to <strong>Get Additional Requirements</strong>.
                  </td>
                </tr>
              </tbody>
            </table>
          </Step>

          <Step title="Get User Limits">
            Call <a href="/api/whitelabel/user/get-user-limits" target="_blank">Get User Limits</a> with `paymentMethod = bank_transfer` and `fiatCurrency` to fetch the user's monthly, daily, and yearly limits along with available limits to place an order.

            On success → proceed to **Get Active Orders**.
          </Step>

          <Step title="Get Active Orders">
            Call <a href="/api/whitelabel/orders/get-active-orders" target="_blank">Get Active Orders</a> to check for any existing pending orders. Transak doesn't support placing multiple orders simultaneously.

            <table>
              <tbody>
                <tr>
                  <td>
                    <ParamField path="activeOrder" type="exists">
                      Proceed to **Cancel Order**
                    </ParamField>

                    <ParamField path="activeOrder" type="not exists">
                      Proceed to **Create Order**
                    </ParamField>
                  </td>
                </tr>
              </tbody>
            </table>
          </Step>

          <Step title="Create Order">
            Call <a href="/api/whitelabel/orders/create-order" target="_blank">Create Order</a> passing `quoteId`, `paymentInstrumentId` (payment method), and `walletAddress`.

            <table>
              <tbody>
                <tr>
                  <td>
                    <ParamField path="Case 1" type="status = AWAITING_PAYMENT_FROM_USER · errorMessage = null">
                      Proceed to **Confirm Payment**
                    </ParamField>

                    <ParamField path="Case 2" type="status = AWAITING_PAYMENT_FROM_USER · errorMessage = Order exists">
                      **Cancel Order** → repeat **Get User Limits**
                    </ParamField>

                    <ParamField path="Case 3" type="statusCode = 400 · message = Order exists">
                      **Get Quote** → repeat **Get User Limits**
                    </ParamField>
                  </td>
                </tr>
              </tbody>
            </table>
          </Step>

          <Step title="Confirm Payment">
            Call <a href="/api/whitelabel/orders/confirm-payment" target="_blank">Confirm Payment</a> with `orderId` and `paymentMethod` to confirm the bank transfer.

            On success → proceed to **Get Order By ID**.
          </Step>

          <Step title="Cancel Order">
            Call <a href="/api/whitelabel/orders/cancel-order" target="_blank">Cancel Order</a> with `orderId` and `cancelReason` to cancel a pending order.

            <Callout intent="warning" title="Cancel before re-ordering">
              This step is only required when an existing active order is detected. After cancellation, return to **Get User Limits** to start a fresh order.
            </Callout>
          </Step>

          <Step title="Get Order By ID">
            Call <a href="/api/whitelabel/orders/get-order-by-id" target="_blank">Get Order By ID</a> with `orderId` to poll the final order status.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Cards, Apple Pay">
        This flow enables users to OnRamp using existing or new card details, including Apple Pay. The flow uses a session ID to initialize a payment widget, enabling a smooth, embedded experience within the partner's UI.

        <Frame>
          <img src="https://files.buildwithfern.com/visual-editor-images/transak-labs.docs.buildwithfern.com/2026-03-15T15:13:03.517Z/integration/headless/orders/8aa0cc53207666cc5a6c438c91e38c9b0c495fcb6c2b9a68f038976a6dd74a07-semi-widget-flow.png" alt="semi-widget-flow" title="semi-widget-flow" noZoom={false} />
        </Frame>

        <Steps>
          <Step title="Get KYC Requirement">
            Call <a href="/api/whitelabel/kyc/get-additional-requirements" target="_blank">Get KYC Requirement</a> with the `quoteId` to fetch the KYC status and route accordingly:

            <table>
              <thead>
                <tr>
                  <th>
                    When
                  </th>

                  <th>
                    Next step
                  </th>
                </tr>
              </thead>

              <tbody>
                <tr>
                  <td>
                    <code>data.kyc.status</code> = <strong>APPROVED</strong>
                  </td>

                  <td>
                    No further steps in the KYC process. Proceed to <strong>Get User Limits</strong>.
                  </td>
                </tr>

                <tr>
                  <td>
                    <code>data.kyc.status</code> = <strong>NOT\_SUBMITTED</strong>
                  </td>

                  <td>
                    User details need to be submitted. Proceed to <strong>Patch User Details</strong>.
                  </td>
                </tr>

                <tr>
                  <td>
                    <code>data.kyc.status</code> = <strong>ADDITIONAL\_FORMS\_REQUIRED</strong>
                  </td>

                  <td>
                    More steps in the KYC process are required. Proceed to <strong>Get Additional Requirements</strong>.
                  </td>
                </tr>
              </tbody>
            </table>
          </Step>

          <Step title="Get User Limits">
            Call <a href="/api/whitelabel/user/get-user-limits" target="_blank">Get User Limits</a> with the payment method (`credit_debit_card` or `apple_pay`) and `fiatCurrency` to fetch the user's monthly, daily, and yearly limits.

            On success → proceed to **Get Active Orders**.
          </Step>

          <Step title="Get Active Orders">
            Call <a href="/api/whitelabel/orders/get-active-orders" target="_blank">Get Active Orders</a> to check for any existing pending orders. Transak doesn't support placing multiple orders simultaneously.

            <table>
              <tbody>
                <tr>
                  <td>
                    <ParamField path="activeOrder" type="exists">
                      Proceed to **Cancel Order**
                    </ParamField>

                    <ParamField path="activeOrder" type="not exists">
                      Proceed to **Create Widget URL**
                    </ParamField>
                  </td>
                </tr>
              </tbody>
            </table>
          </Step>

          <Step title="Create Widget URL">
            Call <a href="/api/whitelabel/orders/create-widget-url-cards" target="_blank">Create Widget URL</a> by passing the **User Access Token** and **Partner Access Token** to generate a payment `widgetUrl`.

            <Callout intent="warning" title="Single-use & time-limited">
              Each `widgetUrl` is **single-use only** and **valid for 5 minutes** from the time of creation.
            </Callout>
          </Step>

          <Step title="Launch Payment Widget">
            Open the Payment Widget using the `widgetUrl` received from the previous step. The widget handles card entry or Apple Pay validation.

            **Example URL:**

            ```
            https://global-stg.transak.com?apiKey=YOUR_API_KEY&sessionId=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
            ```
          </Step>

          <Step title="Use Existing or New Card Details">
            Through the widget, users can enter new card details or use previously saved cards. Apple Pay is supported if the user's browser and device configuration allow it.
          </Step>

          <Step title="Place Order">
            Card information is submitted via the widget. The backend API securely processes the payment and places the order.
          </Step>

          <Step title="WebSocket — Order Status Updates">
            After order placement, the order status is delivered in real time via a WebSocket connection. Partners can subscribe to various order status events.

            <Callout intent="info" title="WebSocket integration">
              Refer to the WebSocket integration docs to listen to order events.
            </Callout>
          </Step>
        </Steps>
      </Tab>

      <Tab title="Open Banking">
        The **Open Banking payment** method allows users in the **EU and UK** to fund crypto purchases via a **secure, real-time bank transfer.**

        Open Banking is available under the Get Fiat Currencies API with payment method ID referred to as `pm_open_banking` or displayed to users as **Easy Bank Transfer**.

        <Callout intent="info" title="Supported Countries">
          This feature is available only for users whose **KYC country is supported** under Plaid's Open Banking framework (e.g., UK, Ireland, Germany, France, etc.). The list of supported countries and banks can be found <a href="https://plaid.com/docs/resources/#european-bank-coverage" target="_blank">here</a>.
        </Callout>

        <Steps>
          <Step title="Get Fiat Currencies">
            Call <a href="/api/whitelabel/lookup/get-fiat-currencies" target="_blank">Get Fiat Currencies</a> to confirm supported fiat currencies (e.g., EUR/GBP) and verify the availability of `pm_open_banking` as a payment method.
          </Step>

          <Step title="Get Quote">
            Call <a href="/api/whitelabel/lookup/get-quote" target="_blank">Get Quote</a> to generate a quote for fiat → crypto using Open Banking as the selected payment method.
          </Step>

          <Step title="Get KYC Requirement">
            Call <a href="/api/whitelabel/kyc/get-kyc-requirement" target="_blank">Get KYC Requirement</a> with the `quoteId` (and the **User Access Token** as required by the API) to validate KYC for the provided quote and route accordingly:

            <table>
              <thead>
                <tr>
                  <th>
                    When
                  </th>

                  <th>
                    Next step
                  </th>
                </tr>
              </thead>

              <tbody>
                <tr>
                  <td>
                    <code>data.kyc.status</code> = <strong>APPROVED</strong>
                  </td>

                  <td>
                    No further steps in the KYC process. Proceed to <strong>Get User Limits</strong>.
                  </td>
                </tr>

                <tr>
                  <td>
                    <code>data.kyc.status</code> = <strong>NOT\_SUBMITTED</strong>
                  </td>

                  <td>
                    User details need to be submitted. Proceed to <strong>Patch User Details</strong>.
                  </td>
                </tr>

                <tr>
                  <td>
                    <code>data.kyc.status</code> = <strong>ADDITIONAL\_FORMS\_REQUIRED</strong>
                  </td>

                  <td>
                    More steps in the KYC process are required. Proceed to <strong>Get Additional Requirements</strong>.
                  </td>
                </tr>
              </tbody>
            </table>
          </Step>

          <Step title="Get User Limits">
            Call <a href="/api/whitelabel/user/get-user-limits" target="_blank">Get User Limits</a> to validate the user's daily, monthly, and yearly limits for `pm_open_banking`.
          </Step>

          <Step title="Get Active Orders">
            Call <a href="/api/whitelabel/orders/get-active-orders" target="_blank">Get Active Orders</a> to check for any existing pending orders. Transak doesn't support placing multiple orders simultaneously.

            <table>
              <tbody>
                <tr>
                  <td>
                    <ParamField path="activeOrder" type="exists">
                      Proceed to **Cancel Order**
                    </ParamField>

                    <ParamField path="activeOrder" type="not exists">
                      Proceed to **Create Order**
                    </ParamField>
                  </td>
                </tr>
              </tbody>
            </table>
          </Step>

          <Step title="Create Order & Initiate Payment Authorization">
            Call <a href="/api/whitelabel/orders/create-order" target="_blank">Create Order</a> with `quoteId`, `walletAddress`, and `paymentInstrumentId: pm_open_banking`.

            <table>
              <tbody>
                <tr>
                  <td>
                    <ParamField path="data.paymentDetails.redirectUrl" type="string">
                      The Open Banking authorization URL
                    </ParamField>
                  </td>
                </tr>
              </tbody>
            </table>

            <Callout intent="warning" title="Open in webview or browser">
              The `redirectUrl` must be opened in a webview or browser to launch the Open Banking authorization flow.
            </Callout>
          </Step>

          <Step title="Cancel Order">
            Call <a href="/api/whitelabel/orders/cancel-order" target="_blank">Cancel Order</a> to cancel a pending order (if still `AWAITING_PAYMENT_FROM_USER`) by providing `orderId` and `cancelReason`.
          </Step>

          <Step title="Get Order By ID">
            Call <a href="/api/whitelabel/orders/get-order-by-id" target="_blank">Get Order By ID</a> with `orderId` to fetch the final order status.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Accordion>
</AccordionGroup>