Skip to main content

List Loans Request

This API is invoked by the LA when the LA wants to get the list of loans.

Request Body
metadata object REQUIRED

Metadata specific to each API request.

version string REQUIRED
originatorOrgId string

The organisation id on the Participant Registry.

originatorParticipantId string

The participant id on the Participant Registry. This will be different for every role under the same organisation.

timestamp string REQUIRED
traceId string REQUIRED
requestId string REQUIRED

UUID used to tie request and response and for idempotency

productData object REQUIRED

Product Metadata specific to each API request.

productId string REQUIRED

The product id on the Product Registry.

productNetworkId string

The product network id on the Product Registry.

borrower object REQUIRED
primaryId string REQUIRED
primaryIdType string REQUIRED

Possible values: [PAN, MOBILE, AADHAAR]

additionalIdentifiers object[]
key string REQUIRED
value string REQUIRED
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

name string
category string REQUIRED

Possible values: [ORGANIZATION, INDIVIDUAL]

contactDetails object[] REQUIRED
type string REQUIRED

Possible values: [PRIMARY, OTHER]

desctiption string
phone string REQUIRED
email string
address object
hba string REQUIRED
srl string REQUIRED
landmark string
als string
vtc string
pinCode string REQUIRED
po string
district string
state string REQUIRED
country string REQUIRED
url string
latitude string
longitude string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

documents object[]
id string
source string REQUIRED

Possible values: [GSTN, AA, FIP, FSR, FIU, USER, OTHER]

sourceIdentifier string REQUIRED
format string REQUIRED

Possible values: [JSON, DOC, IMAGE, CSV, XML, PDF, URL]

reference string REQUIRED
type string REQUIRED

Possible values: [GST_PROFILE, GSTN_B2B_INVOICE, PAN, AADHAAR, DRIVING_LICENSE, PASSPORT, OTHER]

isDataInline boolean REQUIRED
data string REQUIRED
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

aaIdentifier string

For AA based flows, account aggregator identifier will be provided by the borrower

startDate string
endDate string
Responses
200

Acknowledgement of Request Received

Schema OPTIONAL
error string
traceId string
timestamp string