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_idclient_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
- Python
- NodeJS
- Curl
// JAVA TOKEN CODE HERE
# PYTHON TOKEN CODE HERE
// NODE TOKEN CODE HERE
# CURL COMMAND HERE
Step 4: Generate Consent Request Payload
Consent payload must conform to defined JSON schema.
📌 JSON Schema Placeholder
// CONSENT REQUEST SCHEMA HERE
Step 5: Call Consent Creation API
POST /api/v1/consents
🔹 Sample Code Placeholder
- Java
- Python
- NodeJS
- Go
- Curl
// JAVA CONSENT CREATION CODE
# PYTHON CONSENT CREATION CODE
// NODE JS CONSENT CREATION CODE
// GO CONSENT CREATION CODE
# CURL 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