/v2/public/request

This is the analog of the V2 Request endpoint for client-to-server calls.

Authentication

To authenticate, pass the public API key as a query parameter in the endpoint URL. This key is your Partner UUID. Please note that this public API key differs from the one used for server-to-server APIs.

Important

The public API key (Partner UUID) needs to be authorized separately.
Please get in touch with your Account Manager to enable and obtain your public API key.

{
  // The unique identifier for the user in your system. 
  // This helps link the request to the user's existing account or create a new one
  "partnerUserId": "4bb689aa-fd24-46fb-b793-e44c26d24e7a",

  // The preferred language for the user interface of the widget
  "locale": "en"
}

{
  // The unique identifier for the user in your system. 
  // This helps link the request to the user's existing account or create a new one
  "partnerUserId": "4bb689aa-fd24-46fb-b793-e44c26d24e7a",

  // The preferred language for the user interface of the widget
  "locale": "en"

  // The ID of a previously generated quote.
  "quoteId": "99b51850-87c1-4af0-bcf3-ae8684b076c0",

  // Details about the cryptocurrency wallet where the purchased cryptocurrency should be sent
  "cryptoWalletAddress": 
  {
    // The actual address of the cryptocurrency wallet
    "address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",

    // The cryptocurrency code associated with the wallet address. 
    "currencyCode": "BTC-TESTNET" 
  }
}

{
  // The unique identifier for the user in your system. 
  "partnerUserId": "4bb689aa-fd24-46fb-b793-e44c26d24e7a",
  
  // The ID of a previously generated quote.
  // This pre-fills the amount and cryptocurrency selection in widget
  "quoteId": "99b51850-87c1-4af0-bcf3-ae8684b076c0",

  // The user's email address
  "email": "[email protected]", 

  // The preferred language for the user interface of widget
  "locale": "en", 

  // Details about the cryptocurrency wallet where the purchased cryptocurrency should be sent
  "cryptoWalletAddress": 
  {
    // The actual address of the cryptocurrency wallet
    "address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",

    // The cryptocurrency code associated with the wallet address.
    "currencyCode": "BTC-TESTNET" 
  },

  // The payment method has chosen to use for the transaction
  "paymentMethod": "credit-card", 

  // Indicates that the user has already completed the KYC process from Partner's end. 
  "trustedKyc": true,

  // Enables a passwordless authentication flow for the user
  "passwordless": true
}

{
  // The unique identifier for the user in your system. 
  // This helps link the request to the user's existing account or create a new one
  "partnerUserId": "4bb689aa-fd24-46fb-b793-e44c26d24e7a",

  // The preferred language for the user interface of the widget
  "locale": "en"

  // Indicates that the user has already completed the KYC process from Partner's end. 
  "trustedKyc": true,

  // Provides KYC information that has already been verified by your platform, 
  "trustedKycInfo": {
    "firstName": "John",       // User's first name
    "lastName": "Doe",         // User's last name
    "dateOfBirth": "1990-01-15", // User's date of birth (YYYY-MM-DD format)
    "country": "US",            // User's country of residence
    "state": "CA",              // User's state of residence (if applicable)
    "address": "123 Main St",    // User's street address (optional)
    "city": "Anytown",          // User's city of residence (optional)
    "zip_code": "12345",        // User's ZIP or postal code (optional)
    "phone": "+15555551212",     // User's phone number (optional)
    "documentType": "passport", // Type of identification document used for KYC (optional)
    "documentNumber": "AB123456"  // ID number of the identification document (optional)
  }
}