Skip to main content

Getting Started

Step 1: Sign Up

Register your organization
Create application
Choose environment (Test / Production)

Step 2: Get Credentials

After application approval, you will receive:

  • client_id
  • client_secret
  • Public/Private key pair (if applicable)
  • Webhook secret

Keep these secure.

Step 3: Generate Access Token

Use your credentials to generate a JWT access token.

Token API
POST /oauth/token

🔹 Sample Code

// JAVA TOKEN CODE HERE

Consent payload must conform to defined JSON schema.

📌 JSON Schema Placeholder

// CONSENT REQUEST SCHEMA HERE

POST /api/v1/consents

🔹 Sample Code Placeholder

// JAVA CONSENT CREATION CODE

Step 6: Get Redirect URL

Response will contain:

{
"consentId": "...",
"redirectUrl": "https://..."
}

Step 7: Redirect User

Open redirect URL in:

  • Web browser
  • Mobile WebView
  • Native browser

User can:

  • Grant consent
  • Revoke consent

Step 8: Webhook Notification

Upon action:

  • Webhook is sent to your configured endpoint
  • Signed payload
  • Contains consent status and receipt hash