Skip to main content

Partner GraphQL API

The Partner GraphQL API provides advanced capabilities for creating and managing complete offers. Access the API at:

Authentication​

Both endpoints include a GraphQL playground for interactive API exploration. To authenticate:

  1. In the browser authentication popup:

    • Leave the username empty
    • Enter your API key as the password

  2. In the playground's Headers section, add:

    {
      "Authorization": "Bearer YOUR-API-KEY",
      "x-partner-id": "YOUR-PARTNER-ID" // Required if you have multiple partner IDs
    }
Partner ID Mapping

If you're working with multiple partner IDs or are a platform serving multiple partners:

  • Each Partner ID must be mapped to your API key
  • Contact support to set up new ID mappings

Environments​

  • Stable: A clone of our production environment, ideal for development and testing
  • Production: Live environment for real transactions
Previous Customer Digital Onboarding Users

If you previously used the Customer Digital Onboarding flow and the partner graph, your existing credentials will work with the partner-platform graph.

Security Best Practices​

  1. Keep your API key secure and never expose it in client-side code
  2. Use environment variables for storing credentials
  3. Request new API keys if they are compromised
  4. Use HTTPS for all API communications

Interactive API Explorer​

Explore the schema and run queries directly in the GraphQL playground:

Authenticate via the browser Basic Auth popup (leave username empty, enter your API key as password), then add your headers in the playground's Headers tab.