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

Create Loan Applications Response

This is the response for Create Loan Applications but invoked by the lender. No offers are rolled out as part of this API. If the lender system finds preliminary information sufficient for doing the loan processing, it will send “PROCESSING” as the status. Otherwise, it can reject the application citing a reason for the same.

Response Parameters for the Create Loan Applications Response 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 array for Loan Applications, which includes a status indication and an object for lender for each loan application.     (click to open tables)
ParameterTypeDescription
metadata:wwwwwwwwww
 {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) 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)
traceIdStringIdentification for tracing
orgIdStringOrigin ID
requestIdStringUnique reference ID for the loan applications request
response: {error}ObjectObject 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)
createdDateStringDate/time (ISO representation) when loan application was created
loanApplicationIdStringUnique reference ID (UUID) for the loan application (used to tie request and response and for idempotency)
lender:wwwwwwwwnww
   {params, arrays}
ObjectIDs, contact details, and documentation of lender
  Parameters for the lender object:    (click to open)
primaryIdStringIdentifier Type for the lender instance
primaryIdTypeStringUnique 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.
nameStringName of lender
categoryStringCategory 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)
typeStringType of contact
Example: "PRIMARY"
descriptionStringDescription of the contact detail
phoneStringPhone number of contact instance
emailStringEmail of contact instance
address:wwwwwwnww
   {param1, param2,...}
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
urlStringFor any new data that needs to be passed as a link
extensibleDatawwwiwwJSONFor 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)
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)
urlStringFor any new data that needs to be passed as a link
extensibleDatawwwwiwwJSONFor any new data that needs to be added.
loanApplicationStatuswwString"PROCESSING" if information is sufficient for loan processing. Oherwise, an indication is sent for rejecting the application.
* = Required
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!