Create Loan Applications Response

Response Parameters for the Create Loan Applications Response 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 array for Loan Applications, which includes a status indication and an object for lender for each loan application. (click to open tables)

Parameter		Type	Description
metadata:wwwwwwwwww {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) where; YYYY = four-digit year MM = two-digit month (01=January, etc.) DD = two-digit day of month (01 through 31) hh = two digits of hour (00 through 23) (am/pm NOT allowed) mm = two digits of minute (00 through 59) ss = two digits of second (00 through 59) 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


requestId	String	Unique reference ID for the loan applications request
response: {error}	Object	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.
loanApplications:wwwwwi [{...},{...},..]	Array of Objects	Array of Loan Applications with new information provided by lender for each one

Parameters for the loanApplications object: (click to open)


createdDate	String	Date/time (ISO representation) when loan application was created
loanApplicationId	String	Unique reference ID (UUID) for the loan application (used to tie request and response and for idempotency)
lender:wwwwwwwwnww {params, arrays}	Object	IDs, contact details, and documentation of lender

Parameters for the lender object: (click to open)


primaryId	String	Identifier Type for the lender instance
primaryIdType	String	Unique identifier for the lender's identifier type above
additionalIdentifiers:ww [{...},{...},..]	Array of Objects	Additional Identifiers: 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 lender
category	String	Category of the lender Example: "ORGANIZATION"
contactDetails: [{...},{...},..]	Array of Objects	List of contacts (with details) for lender instance

Parameters for each object in the contactDetails array:
{click to open)


type	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:wwwwwwnww {param1, param2,...}	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		String	For any new data that needs to be passed as a link
extensibleDatawwwiww		JSON	For any new data that needs to be added.


documents: [{...},{....}...] wwwwwwwwwwwwntww		Array of Objects	List of documents (with details) for lender instance

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		String	For any new data that needs to be passed as a link
extensibleDatawwwwiww		JSON	For any new data that needs to be added.


loanApplicationStatusww		String	"PROCESSING" if information is sufficient for loan processing. Oherwise, an indication is sent for rejecting the application.

* = Required