CRM Open API DocumentationCRM Open API Documentation
REST API
Webhooks
Client OAuth
PSP Open API
External Exchange Rates
REST API
Webhooks
Client OAuth
PSP Open API
External Exchange Rates
  • Client OAuth Flow
  • OAuth Applications
  • Authorization Code + PKCE

    • Authorization Code + PKCE Introduction
    • Redirect to Login
    • Get Token
    • Compute PKCE Code Challenge
    • Logout
  • Authorization Code + PKCE (Iframe)

    • Authorization Code + PKCE Introduction
    • Post Message
    • Get Token
    • Compute PKCE Code Challenge
  • Resource Owner Password Credentials (ROPC)

    • ROPC Introduction
    • Get Token
    • Verify MFA Code
    • Get MFA Secret
    • Send Email OTP for MFA
    • Bind MFA Method and enable MFA
    • Deactivate MFA
    • Forgot Password
  • Refresh Token

    • Refresh Token
    • Revoke Refresh Token

Authorization Code + PKCE (Iframe)

This section describes how public clients (iframe) authenticate using OAuth 2.0 Authorization Code with PKCE.

Important domain separation

  • Client Portal Hostname: Hosts the CRM login UI and handles user interaction (e.g. /login).
  • Client API Hostname: Hosts the OAuth API endpoints (e.g. /oauth/token).

You can retrieve both domains from your registered OAuth Application in CRM.

Flow summary

  1. Customer Iframe postMessage to crm with PKCE parameters.
  2. Authorization code is issued and returned to your iframe.
  3. Your iframe exchanges the authorization code for tokens using the code_verifier.

API references

  • Post Message
  • Exchange authorization code for token
Last Updated: 12/8/25, 2:08 AM
Next
Post Message