Guarantee Lodgment — CGTMSE

What does this API do?

The CGTMSE Guarantee Lodgment API allows Member Lending Institutions (MLIs) to submit guarantee application details to the CGTMSE system for processing.

Once the application data is submitted:

• The system validates the request data.
• If the data is valid, a unique Application Reference Number (APPL_REF_NO) is generated.
• This reference number is used to track the guarantee application in subsequent steps (like enquiry, disbursement, etc.).

This API is a critical step in the CGTMSE flow, as it formally registers a borrower’s guarantee request with the CGTMSE system.

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
• Other financial institutions registered with CGTMSE

Prerequisites

Complete all common platform prerequisites as described in Getting Started with ULI Platform APIs. Additionally, ensure the following CGTMSE-specific requirements are met:

• CGTMSE Service Subscription
  Must be subscribed separately for Sandbox and Production via the Developer Portal.
• JWT Token Generation
  Required for Authorization header. Generated using ULI Authentication APIs.
• CGTMSE Sign-in Token
  Must be generated using the CGTMSE Sign-in API and passed in the x-cgtmse-token header.
• Whitelisting Requirements
  • IP whitelisting (both lender & platform)
  • URL whitelisting for Sandbox & Production

API Endpoints

• HTTP Method: POST
• URL Path Convention:
  /{service name}/{ver}/{lang}
  • Service name: cgtmse/guaranteelodgement
  • Version: 1.3
  • Language: en

Headers

Request Body

The request follows the standard encrypted platform envelope.

Plain Payload (before encryption)

The actual business payload (structure defined as per CGTMSE specification) contains complete guarantee application details.

Encrypted Request Format

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

Field Description

Response Fields

Sample Response Structure

{
  "result": {
    "errcode": "E000",
    "status": "success",
    "info": ""
  },
  "data": {
    "response": "<encrypted response>"
  },
  "signature": "<digital signature>",
  "meta": {
    "txncode": "<txncode>",
    "ver": "1.3",
    "ts": "<timestamp>"
  },
  "hmac": "<hash>",
  "publickey": "<public key>",
  "sig-algo": "SHA256withECDSA"
}

Field Description

Decrypted Response (Business Data)

After decrypting the data.response, the payload contains:

• APPL_REF_NO (Application Reference Number)
  • Unique identifier generated for successful guarantee lodgment
  • Used for tracking and further API calls (e.g., enquiry, disbursement)

Error Codes

For additional platform-level errors, refer to the Platform Error Code documentation.

Who to contact?

If you encounter any issues, contact support with the following details:

• Email: support@rbihub.in
• Subject: CGTMSE API Error
• Details to include:
  • Platform Service Name: CGTMSE
  • Environment: Sandbox / Production
  • Service Provider Code: 112
  • Request payload (headers + body)
  • Error code and message
  • Logs or screenshots
  • Prerequisites status:
    • IP Whitelisting
    • URL Whitelisting
    • Service Subscription
    • Token Generation
    • CGTMSE Sign-in Token