Integration Docs

Comprehensive guide and documentation to help you start working with smallcase Gateway

Get Started

Kickstart Integration


In order to start the integration, let's understand the following credentials first -


Unique name used to identify each partner. It is used as part of the Gateway API Url


secret is unique & confidential for each partner
Used to create smallcaseAuthToken(JWT) for initializing Gateway client side SDK


apiSecret is unique & confidential for each partner
It is used as a request header to authenticate all Gateway backend API requests

Gateway client side SDK

Gateway provides integration support for the following platforms -

Gateway API url

The Gateway API URL is You need to include this before each API endpoint to make API calls

Domain whitelisting

Note: This is applicable for web integration only
For the Gateway initialization to be successful, please share your development & production domains with us for whitelisting


JWT : JSON Web Tokens

JWT are an open, industry-standard RFC 7519 method for representing claims securely between two parties. Refer
Gateway provides a secret (as mentioned in prerequisites) to encode the desired payload & create JWT

Guest user

A user when interacting with the Gateway ecosystem for the first time will have to choose a broker from our list of supported brokers and login with his broker credentials. This user is identified as a guest user in the gateway ecosystem

To initialize a gateway session for such guest user, the JWT has to be created with the following payload

  guest: true,

Connected user

Once broker authentication flow is completed by the user, smallcaseAuthId(unique user identifier) is shared by Gateway. smallcaseAuthId is a unique ID to identify users between the integration partner & Gateway as well as save his choice of broker.

All subsequent Gateway sessions for this user can be initialized by creating a JWT with smallcaseAuthToken as payload.

  smallcaseAuthId: "5c4f0b6a0cbd7d332bae9c92"

A connected user will be prompted to login with his saved broker and would never have to choose between supported brokers

Updated 2 months ago

Kickstart Integration

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.