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

Verify Loan Acceptance Request

This API is invoked by the LSP when the user enters the OTP received on the mobile number associated with the disbursement account and agrees to the terms of the agreement. The asynchronous response for this API should include the lender acknowledging the receipt of OTP and verifying if the user has entered the correct OTP that was shared by the lender.

Response Parameters for the Verify Loan Acceptance 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 contains an array of objects, Credit Block. Each object contains a parameter, type, and a Data object, which contains otp and otpSessionKey.       (click to open tables)
ParameterTypeDescription
metadata:wwwwwwtnww
    {param1, param2,...}
*Object
Strings
Metadata specific to each API request
  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
response: {error}ObjectStatus of response. Object contains only one string parameter for "error". If no errors are found, error = "0". For example, if a mandatory attribute is missing, error code should capture that.
requestId wwwwwwwnwwwwwww*StringUnique reference ID for the Verify Loan Acceptance Request (UUID used to tie request and response and for idempotency)
credBlock:   [{...}, {...}, ...]*Array of
Objects
Credentials block which contains details for verifying loan acceptance
  Parameters for each object in the creditBlock array:
      (click to open)
typewwwwwwwwnwww*StringType of credential used for verifying loan acceptance. Example: "OTP"
data:wwwwwwnnw
  {param1, param2,...}
*Object
Strings
Credential Information
otpSessionKey, otp, etc.
  Parameters for the data object:     (click to open)
otpSessionKeywwwnw*StringIf type = "OTP", this is the key used for the verification acknowledgment session
otp*StringIf type = "OTP", this was the OTP shared be lender (via the LSP) to the user for accepting the terms of the loan agreement.
{{Field}}String{{value}}
{{Field}}String{{value}}
Other parameters as needed
* = Required
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!