This quickstart walks through onboarding to Quicko Connect — the OAuth-based workflow that lets you connect your app to your users’ Quicko accounts once they grant consent.Documentation Index
Fetch the complete documentation index at: https://developer.quicko.com/llms.txt
Use this file to discover all available pages before exploring further.
Not what you’re looking for? If your app does not need consent-based access and only needs to redirect users into Quicko, use a redirection workflow instead:
- Mobile — embed Quicko Tools in a WebView. See Mobile Integration.
- Web — redirect users to the Income Tax Web App with your
affiliate_id. See Refer.
Before you start
You will need:- A Quicko account owned by your organisation (not a personal account).
- Access to your application’s hosted Redirect URL, Policy URL, and Logo URL.
- An HTTPS endpoint on your servers if you plan to receive webhook events.
1. Create a Quicko account
Sign up at quicko.com using a shared organisational email rather than an individual employee’s address. Examples:team-tax@yourcompany.comtax-filing@yourcompany.comquicko-integration@yourcompany.com
2. Register your app
Sign in to myaccount.quicko.com and navigate to Settings → Integrations & Access → Connect, then click Create App. Fill in the following details:| Field | Description |
|---|---|
| App Name | The display name your users will see on the consent screen. |
| App Description | A short summary of what your app does and why it needs access to Quicko data. |
| Business Name | The legal name of the business that owns the app. |
| Whitelisted Domain | The domain that hosts your application (for example, app.yourcompany.com). Quicko accepts a redirect_uri during the OAuth flow only if its host matches this value, which prevents authorization codes from being delivered to an unintended destination. |
| Policy URL | Public URL of your privacy policy. Shown to users during consent. |
| Logo URL | Direct URL to your app’s logo (.png, .svg, or .jpg). Displayed on the consent screen. |
Open in Gmail
Compose in Gmail web.
Open in Outlook
Compose in Outlook web.
Default mail app
Open in your system’s default mail client.
3. Generate API credentials
Once your app is approved, navigate to Settings → Integrations & Access → API Access to generate your credentials. You will receive an API Key and an API Secret:- Credentials are prefixed with
key_live_…/secret_live_…. - These are used to call the Authenticate API and obtain your API User Access Token.
Authentication
Learn how to exchange these credentials for an API User Access Token.
4. Configure webhooks
Webhooks let Quicko push event notifications to your servers as users progress through their tax journey. Go to Settings → Integrations & Access → Webhooks and click Create Webhook.| Field | Description |
|---|---|
| Endpoint URL | HTTPS URL on your server that will receive event notifications via POST. |
| Secret (optional) | A shared secret used to sign every webhook delivery so you can verify it came from Quicko. See Verifying webhook signatures below. |
| Events | Select which events this endpoint should receive. You can configure multiple endpoints to fan-out different events to different services. |
Available events
| Event | Description |
|---|---|
| ITR In-Progress | Fired when a user starts their Income Tax Return. |
| ITR E-Filed | Fired when a user e-files their Income Tax Return. |
| ITR E-Verified | Fired when a user e-verifies their Income Tax Return. |
Verifying webhook signatures
Providing a Secret when creating the webhook is optional but strongly recommended. When a secret is set, Quicko signs every delivery so your server can confirm the request is authentic and was not tampered with in transit. How the signature is produced- Quicko serialises the event payload as a JSON string (the same bytes sent in the request body).
- It computes an
HMAC-SHA256of that string using your webhook secret as the key. - The hex-encoded digest is sent in the
x-webhook-signaturerequest header.
x-webhook-signature header is omitted and no signature is computed.
How to verify on your server
Recompute the HMAC over the raw request body using the same secret and compare it against the header value using a constant-time comparison.
- Node.js
- Python
- Go
Next steps
Authentication
Exchange your API credentials for an access token to call Quicko APIs.
OAuth
Walk through the consent flow and obtain a Resource Owner access token.
Open APIs
Explore the data and actions available through the consent-based APIs.
Events
See the full directory of events you can subscribe to via webhooks.