List Loans Request

Response Parameters for the List Loans Request API:
(click to view)

Parameter	Type	Description
ack:wwwwwwww {error, traceId, timestamp}	Object	JSON object for acknowlegement

Parameters for the ack object:

Parameter	Type	Description
error	String	Errors in the current request received. If no errors are found, error = 0.
traceId	String	Identification for tracing
timestamp	Time- 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)

Parameter		Type	Description
metadata:wwtwwwww {param1, param2,...}	*	Object Strings	Metadata specific to each API response

Parameters for the metadata object: click to open)

Field	Type	Description
version	String	OCEN Version
timestamp	Time- 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)
traceId	String	Identification for tracing
orgId	String	Origin ID


requestIdwwwwwtwww	*	String	Unique reference ID for the Loan Statement Request (UUID used to tie request and response and for idempotency)
borrower: {...,[...],[...],..}	*	Object	Borrower details shared by LSP during Create Loan Application process

Parameters for the borrower object:
(click to open)


primaryId	*	String	Primary ID for borrower for which a loan list is being requested
primaryIdType wwwwtw	*	String	Type 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.
name		String	Name of borrower
category		String	Category 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)


type	n	String	Type of contact Example: "PRIMARY"
description		String	Description of the contact detail
phone		String	Phone number of contact instance
email		String	Email of contact instance
address:wwwwniww {prm1, prm2,...}		Object Strings	Address details for contact instance

Parameters for the address object: {click to open)

Field	Type	Description
co	String	Care of
hba	String	House/Building/Apartment number
srl	String	Street/Road/Lane
landmark	String	Notable landmark at address location
als	String	Area/Locality/Sector
vtc	String	Village/Town/City
pincode	String	4-digit code to unlock
po	String	Post Office box number
district	String	Disdtrict of address location
state	String	State of address location
country	String	Country of address location
uri	String	Digital address
latitude	String	Latitude of address location
longitude	String	Longitude of address location


url	n	String	For any new data that needs to be passed as a link
extensibleDatawiww		JSON	For any new data that needs to be added.


documents:wwwntww [{...},{....}...]	n	Array of Objects	Additional documents (if any) related to the borrower.

Parameters for each object in the documents array:
(click to open)


format	String	Format of document data to be sent
reference	String	Unique 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.
source	String	Source system from where data is coming. Source can be from AA ecosystem or from USER
sourceIdentifier	String	If source is in AA ecosystem, sourceIdentifier is the identifier in central registry. In case of User, it will be his unique identifier
type	String	Expandable enum. Includes fiTypes in AA ecosystem and any additional type of documents that can be added to the system later
isDataInline	Boolean	Indicates whether the data is actually present in the document block. If Yes, data field contains base 64 encoded version of the data.
data	String	Data to be sent for document instance (Base64 encoded string)


url	n	String	For any new data that needs to be passed as a link
extensibleDatawwtww		JSON	For any new data that needs to be added.


collateral:wwwwwttww {..., {...}, [...],...}	n	Object	Details of the collateral used for the loan. Shared by LSP during the Create Loan Application process

Parameters for the collateral object:
{click to open)


collateralPrimaryId	n	String	Primary Identifier for the collateral. Generated as collateralPrimaryIdType_collaetralPrimaryId
collateralPrimaryIdType		String	Expandable ENUM. Type of collateral source. Will be Invoice in case of invoice based lending, vehicle identification number (VIN) for vehicle as collateral
description		String	Description of the collateral
type		String	Type 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


startDatewwwwwwwwn	n	Date- Time	Start date/time (ISO representation) from when the list of loans should be fetched
endDate		Date- Time	End date/time (ISO representation) till which the list of loans should be fetched

* = Required