Guarantee Enquiry — CGTMSE

Created by Sandeep Kumar Debata, Modified on Mon, 30 Mar at 12:22 PM by Sandeep Kumar Debata

What does this API do?

The CGTMSE Guarantee Enquiry API allows Member Lending Institutions (MLIs) to fetch the status and details of a previously submitted guarantee application using the Application Reference Number (APPREFNO).

Once the APPREFNO is provided:

  • The system retrieves the application status.
  • Returns guarantee-related details including:
    • CGPAN (CGTMSE Guarantee Number)
    • Fee details
    • Application processing status

This API is typically used after the Guarantee Lodgment step to track and retrieve finalized guarantee details.


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 Service Subscription
    Must be enabled separately for Sandbox and Production.
  • JWT Token Generation
    Required for Authorization header.
  • CGTMSE Sign-in Token
    Must be generated using the Sign-in API and passed in x-cgtmse-token.
  • Whitelisting Requirements
    • IP whitelisting
    • URL whitelisting

API Endpoints

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

Headers

HeaderDescriptionExample
AuthorizationBearer JWT token generated by platform authentication serviceBearer <JWT token>
client-idBase64-encoded Client ID issued during registrationpNRxiviTvgBrf7qMANqBVskDYfEa
providerService provider code for CGTMSE112
x-cgtmse-tokenToken obtained from CGTMSE Sign-in API<authToken>
api-keyReserved for future use24-char alphanumeric key

Request Body

The request follows the standard encrypted platform envelope.

Plain Payload (before encryption)

The plain request contains the Application Reference Number (APPREFNO) of the guarantee application.


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

FieldDescription
meta.verVersion of request template (1.3)
meta.tsTimestamp in ISO-8601 format
meta.txncodeUnique transaction code
hmacSHA-256 hash of data
dataEncrypted payload containing APPREFNO

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

FieldDescription
result.errcodeError code (E000 = success)
result.statussuccess / fail
dataEncrypted response payload
signatureDigital signature of response
hmacSHA-256 hash of data
publickeyPlatform public key
sig-algoSigning algorithm
meta.txncodeEchoed transaction code
meta.verResponse version
meta.tsResponse timestamp

Decrypted Response (Business Data)

After decrypting the response payload, the following details are available:

  • APPREFNO – Application Reference Number
  • CGPAN – CGTMSE Guarantee Number
  • Application Status – Status of guarantee processing
  • Fee Details – Applicable guarantee fees

These details help lenders track and process guarantee applications further.


Error Codes

Error CodeDescription
E000Success — no error
E801Authentication failure at CGTMSE
E802Missing x-cgtmse-token
E043Provider internal error

For 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 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article