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

List Loans Request

This method is called by the LSP to return the list of loans provisioned for a borrower.

Response Parameters for the List Loans 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 borrower, and an optional object for collateral, which contains information about the borrower for which a loan list is being requested.       (click to open tables)
ParameterTypeDescription
metadata:wwtwwwww
   {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
requestIdwwwwwtwww*StringUnique reference ID for the Loan Statement Request (UUID used to tie request and response and for idempotency)
borrower:
   {...,[...],[...],..}
*ObjectBorrower details shared by LSP during Create Loan Application process
  Parameters for the borrower object:
      (click to open)
primaryId*StringPrimary ID for borrower for which a loan list is being requested
primaryIdType wwwwtw*StringType of Primary ID
Example: "PAN"
additionalIdentifiers:
      [{...},{...},..]
Array of
Objects
Additional Identifiers
Objects in array:
key
String
  Additional key related to
  the entity.
value
String
  Value for the key in the
  context of the entity.
url
String
  For any new data that needs
  to be passed as a link.
extensibleData
JSON
  For any new data that needs
  to be added.
nameStringName of borrower
categoryStringCategory that loan is used for
Example: "ORGANIZATION"
contactDetails:
      [{...},{...},..]
Array of
Objects
List of contacts (with details) for the borrower
 Parameters for each object in the contactDetails array:
     {click to open)
typenStringType of contact
Example: "PRIMARY"
descriptionStringDescription of the contact detail
phoneStringPhone number of contact instance
emailStringEmail of contact instance
address:wwwwniww
   {prm1, prm2,...}
Object
Strings
Address details for contact instance
 Parameters for the address object:     {click to open)
FieldTypeDescription
coStringCare of
hbaStringHouse/Building/Apartment number
srlStringStreet/Road/Lane
landmarkStringNotable landmark at address location
alsStringArea/Locality/Sector
vtcStringVillage/Town/City
pincodeString4-digit code to unlock
poStringPost Office box number
districtStringDisdtrict of address location
stateStringState of address location
countryStringCountry of address location
uriStringDigital address
latitudeStringLatitude of address location
longitudeStringLongitude of address location
urlnStringFor any new data that needs to be passed as a link
extensibleDatawiwwJSONFor any new data that needs to be added.
documents:wwwntww
      [{...},{....}...]
nArray of
Objects
Additional documents (if any) related to the borrower.
  Parameters for each object in the documents array:
     (click to open)
formatStringFormat of document data to be sent
referenceStringUnique identifier for a document which can be used by other objects for referencing a document. In case where isDataInline is false, reference number can be used to hit an external API to get the data.
sourceStringSource system from where data is coming. Source can be from AA ecosystem or from USER
sourceIdentifierStringIf source is in AA ecosystem, sourceIdentifier is the identifier in central registry. In case of User, it will be his unique identifier
typeStringExpandable enum. Includes fiTypes in AA ecosystem and any additional type of documents that can be added to the system later
isDataInlineBooleanIndicates whether the data is actually present in the document block. If Yes, data field contains base 64 encoded version of the data.
dataStringData to be sent for document instance (Base64 encoded string)
urlnStringFor any new data that needs to be passed as a link
extensibleDatawwtwwJSONFor any new data that needs to be added.
collateral:wwwwwttww
      {..., {...}, [...],...}
nObjectDetails of the collateral used for the loan. Shared by LSP during the Create Loan Application process
 Parameters for the collateral object:
     {click to open)
collateralPrimaryIdnStringPrimary Identifier for the collateral. Generated as collateralPrimaryIdType_collaetralPrimaryId
collateralPrimaryIdTypeStringExpandable ENUM. Type of collateral source. Will be Invoice in case of invoice based lending, vehicle identification number (VIN) for vehicle as collateral
descriptionStringDescription of the collateral
typeStringType of collateral
Example:"GST_INVOICE"
additionalIdentifiers:
      [{...},{...},..]
Array of
Objects
Additional Identifiers
Objects in array:
key
String
  Additional key related to
  the entity.
value
String
  Value for the key in the
  context of the entity.
url
String
  For any new data that needs
  to be passed as a link.
extensibleData
JSON
  For any new data that needs
  to be added.
valuation:
     {prm1, prm2,...}
Object
Evaluation parameters:
value
String
  Value of collateral
currency
String
  Currency used for evaluation
date
String
  Date of evaluation
source
String
  Source of collateral
startDatewwwwwwwwnnDate-
Time
Start date/time (ISO representation) from when the list of loans should be fetched
endDateDate-
Time
End date/time (ISO representation) till which the list of loans should be fetched
* = Required
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!