Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

Consent Status Request

This API is invoked by the LSP to check the status of Consents.

Response Parameters for the Consent Status Request API:
(click to view)
ParameterTypeDescription
ack:wwwwwwww
  {error, traceId, timestamp}
ObjectJSON object for acknowlegement
    Parameters for the ack object:
ParameterTypeDescription
errorStringErrors in the current request received. If no errors are found, error = 0.
traceIdStringIdentification for tracing
timestampTime-
stamp
YYYY-MM-DDThh:mm:ssZ+/-hh:mm
(eg 1997-07-16T19:20:30+05:30)
Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30)
The request for this API includes an object for Consent, which contains the identifier for consentHandle.     (click to open tables)
ParameterTypeDescription
metadata:wwwwtwwwww
 {param1, param2,...}
Object
Strings
Metadata specific to each API response
  Parameters for the metadata object:     click to open)
FieldTypeDescription
versionStringOCEN Version
timestampTime-
stamp
YYYY-MM-DDThh:mm:ssZ+/-hh:mm
(eg 1997-07-16T19:20:30+05:30)
Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30)
traceIdStringIdentification for tracing
orgIdStringOrigin ID
requestIdwwwwwwwtwwwStringUnique reference ID for the Consent Handle Request (UUID used to tie request and response and for idempotency)
consent:  {...}ObjectThis includes the consent handle used to identify the consent.
  Parameters for the consent object:   (click to open)
consentHandleStringID for the consent handle created by the AA for the lender once the Consent Handle Request API is triggered. Sending this will trigger the lender to check again with the AA for updates in bank account statements, GST historical data,etc.
consentStatusStringStatus of the consent
Example: "READY"
* = Required
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!