Lender Authentication (Sign-in) — CGTMSE

What does this API do?

The CGTMSE Sign-in API generates an authentication token that is required for all subsequent CGTMSE business API calls. Member Lending Institutions (MLIs) — including banks, financial institutions, Small Finance Banks, RRBs, and NBFCs — use this token to prove their identity and authorise API requests to the CGTMSE service on the ULI Platform. The token is returned as a Bearer token and must be passed in the x-cgtmse-token header of every downstream CGTMSE API call.

Who can use it?

Any onboarded Member Lending Institution (MLI) that has subscribed to the CGTMSE service on the ULI Platform Developer Portal. Eligible institution types include scheduled commercial banks, small finance banks, regional rural banks (RRBs), NBFCs, and other financial institutions registered with CGTMSE.

Prerequisites

Complete all common platform prerequisites as described in Getting Started with ULI Platform APIs. Then ensure the following CGTMSE-specific steps are also complete:

• CGTMSE service subscription: The CGTMSE service must be subscribed in the Platform Developer Portal separately for Sandbox and Production. Steps are available in the latest SOP for Lender Onboarding document (Section 10). Login credentials will be shared to the registered user's email.
• CGTMSE credentials: Ensure you have received your CGTMSE-specific userName and password from CGTMSE (these are distinct from your ULI Platform JWT credentials).

API endpoints

HTTP Method: POST

URL path convention: /{service name}/{ver}/{lang} — for this API: service name = cgtmse/signin, ver = 1.3, lang = en

Headers

Request body

The request body is a JSON-formatted encrypted payload following the standard platform envelope. The plain (unencrypted) request for the sign-in contains the lender's CGTMSE credentials:

{
  "userName": "testapi4@yopmail.com",
  "password": "Admin@123"
}

This plain payload is then encrypted and submitted as the data field within the standard platform envelope:

{
  "meta": {
    "ver": "1.3",
    "ts": "<ISO-8601 timestamp>",
    "txncode": "<unique transaction code>"
  },
  "hmac": "<SHA-256 hash of encrypted data value>",
  "data": "<encrypted payload>"
}

Plain payload fields:

Response fields

On success, the platform returns the CGTMSE authentication token within the encrypted data field. The plain response is:

{
  "authToken": "<Bearer token string>",
  "type": "Bearer",
  "username": "testapi4@yopmail.com"
}

The full platform response envelope includes:

Important: Store the authToken value and pass it as the x-cgtmse-token header in all subsequent CGTMSE API calls.

Error codes

For platform-level error codes, refer to the latest Platform Error Code reference document available in the Platform API Spec folder on the Developer Portal.

Who to contact?

If you encounter an issue, email support@rbihub.in with the following details:

• Subject: CGTMSE API Error
• Platform Service Name: CGTMSE
• Platform Environment: Sandbox / Production
• Service Provider Code: 112
• Request Payload (headers + body) sent to platform
• Error Code received from the platform
• Error Message received from the platform
• Attachment: Screenshot or log of the error
• Prerequisites status: IP Whitelisting, URL Whitelisting, Service Subscription, Token Generation