Document Intelligence

Background verification document extraction

Introduction
This API allows users to extract information from document such as cv, resume through images/pdf. The API accepts an image/pdf URL containing and returns a JSON response with the extracted information in a result object including candidateId, firstName, lastName, dob, fathersName, altPhoneNumber, nationality, mobileNumber, currentAddress, tenthGradeTimeline, TenthGradeBoard, TenthGradePercentage, TenthGradeEduType, gapYearSchool, diplomaTimeline, diplomaCollege, diplomaPercentage, diplomaEduType, ugTimeline, ugCollege, ugPercentage, gapYearUG, employment details, Declaration and Authorization, otherAddress.
﻿
﻿
API details
Endpoint
Production Environment
POST https://api.signzy.app/api/v3/extraction/background-verification
POST https://api.signzy.app/api/v3/extraction/background-verification
﻿
PreProduction Environment
POST https://api-preproduction.signzy.app/api/v3/extraction/background-verification
POST https://api-preproduction.signzy.app/api/v3/extraction/background-verification
﻿
﻿
Request headers 
Name
Value
Required
Description
Content-Type
application/json
Mandatory
The type of content that the request body contains.
Authorization
XXXXXXXXXXXXXXX
Mandatory
An authentication token to authorize the request. Reach out to the Signzy support team to get one created.
﻿
Request body parameters
Parameter
Data type
Description
Required
file
Array of Strings
A URL of the image. 
Acceptable image format JPEG/JPG, PNG, PDF(MAX of 10 pages)
Mandatory
JSON
{
    "file":["https://persist.signzy.tech/api/files/949233943/download/1cb55d59dba34d3fb72b40149a9d1c9f364c2059b5b145eeb5e180e39edecd8b.pdf"
    ]
}
{
    "file":["https://persist.signzy.tech/api/files/949233943/download/1cb55d59dba34d3fb72b40149a9d1c9f364c2059b5b145eeb5e180e39edecd8b.pdf"
    ]
}
﻿
﻿
Code samples
Curl
curl --location 'https://api-preproduction.signzy.app/api/v3/extraction/background-verification' \
--header 'Content-Type: application/json' \
--header 'Authorization: LhQKsOdn5C6TtTjwPckrTRCAgolZKcGs' \
--data '{"file":["https://persist.signzy.tech/api/files/949810938/download/e6ae95445f214db98d59fee1d4bdca7e651d1ce3521540d795133e4dfbf16853.pdf"]}'
curl --location 'https://api-preproduction.signzy.app/api/v3/extraction/background-verification' \
--header 'Content-Type: application/json' \
--header 'Authorization: LhQKsOdn5C6TtTjwPckrTRCAgolZKcGs' \
--data '{"file":["https://persist.signzy.tech/api/files/949810938/download/e6ae95445f214db98d59fee1d4bdca7e651d1ce3521540d795133e4dfbf16853.pdf"]}'
﻿
﻿
Response body parameters
Parameter
Data Type
Description
candidateId
String
Candidate Id 
firstName
String
First name of the Candidate
lastName
String
Last name of the Candidate
dob
String
Date of Birth of the Candidate
fathersName
String
Father name of that Candidate
altPhoneNumber
String
Alternate Phone number of the Candidate
nationality
String
Nationality of the Candidate
mobileNumber
String
Mobile Number of the Candidate
currentAddress
String
Current Address of the Candidate
premanentAddress
String
Permanent Address of the Candidate
TenthGradeTimeline
String
Timeline in which the Candidate completed his 10th Standard studies 
tenthSchool
String
School in which the Candidate completed his 10th Standard studies
TenthGradeBoard
String
Board or Authority under which the Candidate completed his 10th Standard studies
TenthGradePercentage
String
Percentage or CGPA the Candidate acquired or scored in his 10th Standard studies
TenthGradeEduType
String
Education type of the candidate during their 10th Standard studies
gapYearSchool
String
Details of any gap year if present in the candidate's education during or after school before going for a diploma 
diplomaTimeline
String
Timeline in which the Candidate completed his Diploma studies
diplomaCollege
String
College/University in which the Candidate completed his Diploma studies
diplomaPercentage
String
Percentage or CGPA the Candidate acquired or scored in his Diploma studies
diplomaEduType
String
Education type of the Candidate during their Diploma studies 
ugTimeline
String
Timeline in which the Candidate completed his UG
ugCollege
String
Percentage or CGPA the Candidate acquired or scored in his UG
ugPercentage
String
Percentage or CGPA the Candidate acquired or scored in his UG
ugEduType
String
Education type of the candidate during their UG 
gapYearUG
String
Gap year if present in the candidate's education during or after UG / Undergraduate degree and before pursruing a job or going for a Post Graduation degree
results.imageQualityBack.msg
Object
Employment details for each work experience the candidate has had with all the details in a key and value field like structure like a json object for all of the candidate's employment history
results.imageQualityBack.status
String
Other Address of the person
200
422
400
{
    "error": {
        "name": "Invalid Request",
        "status": "400",
        "msg": "Request must be a JSON Object",
        "responseCode": "fail"
    }
}
{
    "error": {
        "name": "Invalid Request",
        "status": "400",
        "msg": "Request must be a JSON Object",
        "responseCode": "fail"
    }
}
﻿
﻿
Contact Us for Any Assistance
If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!
﻿

MEA and Attestation Detection

Document Intelligence

Docs powered by Archbee

TABLE OF CONTENTS

Request body parameters

Code samples

Response body parameters

Name	Value	Required	Description
Content-Type	application/json	Mandatory	The type of content that the request body contains.
Authorization	XXXXXXXXXXXXXXX	Mandatory	An authentication token to authorize the request. Reach out to the Signzy support team to get one created.

Parameter	Data type	Description	Required
file	Array of Strings	A URL of the image. Acceptable image format JPEG/JPG, PNG, PDF(MAX of 10 pages)	Mandatory

Parameter	Data Type	Description
candidateId	String	Candidate Id
firstName	String	First name of the Candidate
lastName	String	Last name of the Candidate
dob	String	Date of Birth of the Candidate
fathersName	String	Father name of that Candidate
altPhoneNumber	String	Alternate Phone number of the Candidate
nationality	String	Nationality of the Candidate
mobileNumber	String	Mobile Number of the Candidate
currentAddress	String	Current Address of the Candidate
premanentAddress	String	Permanent Address of the Candidate
TenthGradeTimeline	String	Timeline in which the Candidate completed his 10th Standard studies
tenthSchool	String	School in which the Candidate completed his 10th Standard studies
TenthGradeBoard	String	Board or Authority under which the Candidate completed his 10th Standard studies
TenthGradePercentage	String	Percentage or CGPA the Candidate acquired or scored in his 10th Standard studies
TenthGradeEduType	String	Education type of the candidate during their 10th Standard studies
gapYearSchool	String	Details of any gap year if present in the candidate's education during or after school before going for a diploma
diplomaTimeline	String	Timeline in which the Candidate completed his Diploma studies
diplomaCollege	String	College/University in which the Candidate completed his Diploma studies
diplomaPercentage	String	Percentage or CGPA the Candidate acquired or scored in his Diploma studies
diplomaEduType	String	Education type of the Candidate during their Diploma studies
ugTimeline	String	Timeline in which the Candidate completed his UG
ugCollege	String	Percentage or CGPA the Candidate acquired or scored in his UG
ugPercentage	String	Percentage or CGPA the Candidate acquired or scored in his UG
ugEduType	String	Education type of the candidate during their UG
gapYearUG	String	Gap year if present in the candidate's education during or after UG / Undergraduate degree and before pursruing a job or going for a Post Graduation degree
results.imageQualityBack.msg	Object	Employment details for each work experience the candidate has had with all the details in a key and value field like structure like a json object for all of the candidate's employment history
results.imageQualityBack.status	String	Other Address of the person