Get Individual Prescreen Report

Introduction

This API facilitates getting detailed JSON and PDF report based on users request of outputType by providing requestId generated from Create Individual Prescreen and outputType.

Sample Curl:

curl --location 'https://api-preproduction.signzy.app/api/v3/underwriting/generate-individual-prescreen-report' \
--header 'Authorization: ********' \
--header 'Content-Type: application/json' \
--data '{
        "requestId": "5a0123cc-ea43-4bca-b9ca-7632b7223f72",
    "outputType": "json and pdf"
}'

Input Parameters:

Parameter	Type	Description	Mandatory/Optional
requestId	String	The parameter specifies the request ID that has been generated in the previous API(Create Individual Prescreen)	Mandatory
outputType	String	This parameter specifies which type of output is expected in response Possible values are: pdf , json , pdf and json	Mandatory

Sample Response:

{
    "result": {
        "requestId": "5a0123cc-ea43-4bca-b9ca-7632b7223f72",
        "applicationId": "798e988e-ffc0-4877-810e-256a4598da44",
        "status": "PROCESSING"
    }
}

Output Parameters:

Parameter	Type	Description
result	Object	Contains result of request
result.requestID	String	UUID of the request
result.applicationId	String	This is a user defined ID. For Ex: User can pass loan application
result.status	String	Status of the request. Possible values submitted, processing, processed
result.jsonReport	Object	Report in JSON format
result.jsonReport.date	String	Date of the report generation.
result.jsonReport.riskScore	Number	Numerical score representing the credit risk level of the individual.
result.jsonReport.riskSegment	String	Categorization of the risk based on the score (e.g., low, medium, high).
result.jsonReport.IndividualDetails	Object	Container for personal details of the individual.
result.jsonReport.IndividualDetails.fullName	String	Full legal name of the individual.
result.jsonReport.IndividualDetails.gender	String	Gender of the individual.
result.jsonReport.IndividualDetails.age	String	Age of the individual
result.jsonReport.IndividualDetails.pan	String	PAN of individual
result.jsonReport.IndividualDetails.phone	String	Phone number of individual
result.jsonReport.IndividualDetails.email	String	Email of individual
result.jsonReport.googleMapLink	String	Direct link to the location on Google Maps.
result.jsonReport.communicationDetails	Object	Communication details
result.jsonReport.employmentInfo	Object	Employment details.
result.jsonReport.currentCompanyInfo	Object	Current company details
result.jsonReport.designationInEachCompany	Array	List of designations held in each company, including the company name and industry.
result.jsonReport.creditInformation	Object	Credit information of individual
result.pdfReport	String	PDF report link

Status Code:

CODE	MESSAGE
200	Request successful
400	Validation Error
409	Upstream is down
500	Server Side Error