senseloaf Apis (1.0.0)

Download OpenAPI specification:Download

This is senseloaf Api documents.

How to Use

Developer needs to call the Login api with the platform credentials to authenticate and receive the Bearer token. Bearer token validity is 10 days. On expiring, we can call Login API again. Bearer token needs to be passed in Authorization headers for all APIs.

Get Autorization token

Request Body schema: application/json

emailId	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"emailId": "string",
"password": "string"
}

Integration

Contains upload jds/resumes , creating multiple jobs/resumes.

upload job description

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: multipart/form-data

files

required

string <binary>

job description files to be upload

Responses

Response samples

200

Content type

application/json

{"uploadedDocs": [{"docId": "string",
"docType": "string",
"originalFileName": "string",
"uploaded": false
}
]
}

upload resume of candidate

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: multipart/form-data

files

required

string <binary>

candidate resume files to be upload

Responses

Response samples

200

Content type

application/json

{"uploadedDocs": [{"docId": "string",
"docType": "string",
"originalFileName": "string",
"uploaded": false
}
]
}

create bulk jobs

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: application/json

userId	string userId in Senseloaf platform.
organizationId	string organizationId in Senseloaf platform.
idAtSource	string Id of Job in Developers platform.
aboutCompany	string Company Details in String
company	string Company Name
companyLogoUrl	string Logo URL
companySize	string Number of employers
domains	Array of strings List of company domains
foundedYear	string Company founded Year
location	string Company Location
perks	Array of strings Perks inside company
jobRole	string Job Role
positionCount	integer <int64> Number of open positions for the Job.
educationRequired	Array of strings education degrees
employmentType	string
jobCreationTime	string Must be in format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
lastJobViewedTime	string Must be in format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
jobDescription	string Roles and Responsibilities
jobLink	string jobLink
jobLocation	Array of strings “City,Country” is the string format. Can include multiple locations.
latitude	Double Latitude of Job location. Must be in range [-90, 90]
longitude	Double Longitude of Job location. Must be in range [-180, 180]
minExperience	integer <int64> Minimum years of Experience required for the job.
maxExperience	integer <int64> Maximum years of Experience required for the job.
skills	Array of strings skill set required
minSalary	integer <int64> Amount of money
maxSalary	integer <int64> Amount of money
currency	string “INR”,“$”, "EUR”
currencyValue	string XXX
salaryTime	string Value: “perAnnum”,“perHour”

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"organizationId": "string",
"idAtSource": "string",
"aboutCompany": "string",
"company": "string",
"companyLogoUrl": "string",
"companySize": "string",
"domains": ["string"
],
"foundedYear": "string",
"location": "string",
"perks": ["string"
],
"jobRole": "string",
"positionCount": 0,
"educationRequired": ["“High School”",
"“Diploma”",
"Bachelor’s",
"Master’s"
],
"employmentType": "“Full Time”, “Part Time”, \"Contract\",\"Internship\"",
"jobCreationTime": "string",
"lastJobViewedTime": "string",
"jobDescription": "string",
"jobLink": "string",
"jobLocation": ["string"
],
"latitude": null,
"longitude": null,
"minExperience": 0,
"maxExperience": 0,
"skills": ["Marketing",
"Promotions"
],
"minSalary": 0,
"maxSalary": 0,
"currency": "string",
"currencyValue": "string",
"salaryTime": "string"
}

Response samples

200

Content type

application/json

{"userId": "string",
"organizationId": "string",
"aboutCompany": "string",
"company": "string",
"companyLogoUrl": "string",
"companySize": "string",
"domains": ["string"
],
"foundedYear": "string",
"minExperience": 0,
"maxExperience": 0,
"skills": ["Marketing",
"Promotions"
],
"minSalary": 0,
"maxSalary": 0,
"currency": "string",
"currencyValue": "string",
"salaryTime": "string",
"educationRequired": ["“High School”",
"“Diploma”",
"Bachelor’s",
"Master’s"
],
"employmentType": "“Full Time”, “Part Time”, \"Contract\",\"Internship\"",
"jobCreationTime": "string",
"lastJobViewedTime": "string",
"jobDescription": "string",
"jobLink": "string",
"jobLocation": ["string"
],
"jobId": "string",
"jobLocationLat": null,
"jobLocationLong": null,
"jobRole": "string",
"jobStatus": "string",
"location": "string",
"perks": ["string"
],
"positionCount": 0,
"lookForJobRoles": ["string"
],
"lookForLocations": ["string"
],
"lookForSchools": ["string"
],
"sharedTo": ["string"
],
"histories": [{"status": "string",
"timeStamp": "string"
}
],
"geoLocation": {"coordinates": ["string"
],
"type": "string"
},
"closingDetail": {"reasonForClosing": ["string"
],
"comments": "string",
"rating": 0
}
}

create bulk talents

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: application/json

orgID	string organizationId as in Senseloaf platform
idAtSource	integer <int64>
talentName	string Candidate Name
talentEmail	string Candidate contact email
talentContact	string Candidate phone contact
totalWorkExperience	integer <int64> Total year of work experience
currentJobRole	string Current Job Role
currentCompany	string Name of current company
currentCity	string Candidate current city
currentCountry	string Candidate current country
currentLocation	string “City,Country” is the string format.
latitude	double Latitude of candidate location. Must be in range [-90, 90]
longitude	double Longitude of candidate location. Must be in range [-180, 180]
currentCTC	integer <int64> Candidate current annual salary
ctcCurrency	string Accepts “INR”,“$”,“EUR”
ctcCurrencyValue	string XXX
profilePicThumbURL	string Downloadable URL of image
resumeURL	string Downloadable URL of resume. Accepts doc, docx, pdf, txt file
fileName	string Filename of resume
fileType	string Filetype of resume. Value : [ “pdf”, ”doc”, ”docx”, ”txt” ]
rawText	string Resume text
	Array of objects (Skill)
highestEducation	String Enum: "High School" "Diploma" "Bachelor’s" "Master’s" "Doctorate"
	Array of objects (Education)
	Array of objects (Employment)
personalInfo	object
objective	string Candidate objective as written in resume
achievements	Array of strings list of achievements
gender	String Enum: "Male" "Female" "Transgender"
	Array of objects (URL)
source	string Sourcing channel name
tags	Array of strings
lastUpdateDate	string Must be in format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"

Responses

Request samples

Payload

Content type

application/json

{"orgID": "string",
"idAtSource": 0,
"talentName": "string",
"talentEmail": "string",
"talentContact": "string",
"totalWorkExperience": 0,
"currentJobRole": "string",
"currentCompany": "string",
"currentCity": "string",
"currentCountry": "string",
"currentLocation": "Madrid, Spain",
"latitude": null,
"longitude": null,
"currentCTC": 0,
"ctcCurrency": "string",
"ctcCurrencyValue": "string",
"profilePicThumbURL": "string",
"resumeURL": "string",
"fileName": "string",
"fileType": "string",
"rawText": "string",
"skills": [{"SkillName": "string",
"YearsOfExperience": 0,
"SkillType": ["string"
]
}
],
"highestEducation": "High School",
"education": [{"degree": "string",
"degreeName": "string",
"degreeType": "string",
"startYear": 0,
"endYear": 0,
"major": ["string"
],
"measureSystem": "string",
"schoolName": "string",
"score": "string"
}
],
"employment": [{"companyName": "string",
"employmentType": "string",
"location": "string",
"positionExp": 0,
"reasonForLeaving": "string",
"salary": 0,
"startYear": 0,
"startMonth": 0,
"endYear": 0,
"endMonth": 0,
"title": "string"
}
],
"personalInfo": { },
"objective": "string",
"achievements": ["string"
],
"gender": "Male",
"urls": [{"facebook": "string",
"github": "string",
"linkedin": "string",
"stackoverflow": "string",
"twitter": "string",
"other_url": ["string"
]
}
],
"source": "string",
"tags": ["string"
],
"lastUpdateDate": "string"
}

Response samples

200

Content type

application/json

{"talentName": "string",
"talentEmail": "string",
"talentContact": "string",
"totalWorkExperience": 0,
"currentJobRole": "string",
"currentCompany": "string",
"currentCity": "string",
"currentCountry": "string",
"currentLocation": "Madrid, Spain",
"highestEducation": "High School",
"currentCTC": 0,
"ctcCurrency": "string",
"ctcCurrencyValue": "string",
"profilePicThumbURL": "string",
"resumeURL": "string",
"urls": [{"facebook": "string",
"github": "string",
"linkedin": "string",
"stackoverflow": "string",
"twitter": "string",
"other_url": ["string"
]
}
],
"education": [{"degree": "string",
"degreeName": "string",
"degreeType": "string",
"startYear": 0,
"endYear": 0,
"major": ["string"
],
"measureSystem": "string",
"schoolName": "string",
"score": "string"
}
],
"employment": [{"companyName": "string",
"employmentType": "string",
"location": "string",
"positionExp": 0,
"reasonForLeaving": "string",
"salary": 0,
"startYear": 0,
"startMonth": 0,
"endYear": 0,
"endMonth": 0,
"title": "string"
}
],
"objective": "string",
"achievements": ["string"
],
"gender": "Male",
"lastUpdateDate": "string",
"status": "string",
"idAtSource": 0,
"integrationID": "string",
"orgID": {"oid": "string"
},
"source": "string",
"tags": ["string"
],
"fileName": "string",
"fileType": "string",
"rawText": "string",
"latitude": null,
"longitude": null,
"geoLocation": {"coordinates": ["string"
],
"type": "string"
},
"preferredLocations": {"City": ["string"
],
"Country": ["string"
],
"State": ["string"
]
},
"mentionedSkills": [{"skillName": "string",
"skillType": ["string"
]
}
],
"experienceSkills": [{"skillName": "string",
"skillType": ["string"
],
"YearsOfExperience": 0
}
],
"processedJobs": [{"$oid": "string"
}
],
"jobtalentIDS": [{"$oid": "string"
}
]
}

Resume parser

parse resume uploaded by user.

parse resumes

Accepts resumes in doc ,docx, pdf ,png , jpeg format.Parse it and returns the parsed content

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: multipart/form-data

files

required

string <binary>

Resumes to be uploaded in doc,docx,pdf,png,jpeg format.

Responses

Response samples

200
406
500

Content type

application/json

{"availableCredits": 8625,
"number_of_resumes": 2,
"errors": [ ],
"result": [{"content": {"contactInfo": {"firstName": "XXXXXX",
"lastName": "XXXX",
"middleName": "",
"title": "Mr | Miss"
},
"contactMethod": {"ContactEmailid": ["XXXXXX@gmail.com"
],
"PostalAddress": {"Location": {"Area": "",
"City": "Noida",
"Country": "",
"State": "India",
"Zip": ""
}
},
"Telephone": ["880809XXXX"
]
},
"education": {"EducationSection": [{"Collegename": "SS high school govindpur bharauli",
"Degree": "10th",
"Location": "ballia uttar pradesh",
"Major": "",
"Grade": "2.3",
"EduEndDate": {"month": 6,
"year": 2022
},
"EduStartDate": {"month": 6,
"year": 2022
}
}
]
},
"experience": {"ExperienceSection": [{"CompanyName": "webrication",
"ExpLocation": "Kanpur , Uttar pradesh",
"JobTitle": "Php Developer",
"Description": "INTERESTS Music listening Playing football Playing cricket",
"ExpEndDate": {"month": 6,
"year": 2022
},
"ExpStartDate": {"month": 6,
"year": 2022
}
}
]
},
"sections": {"sectionText": "XXXXXXX PHP Developer 880809XXXX XXXX@gmail.com Noida sector 12/22 , Noida , India",
"sectionName": "Personal_info",
"bbox": {"h": 234,
"w": 2345,
"x": 69,
"y": 67
},
"pageNumber": 2
},
"skills": {"SkillType": ["Work",
"Software",
"ProgrammingLanguage"
],
"SkillName": "Php"
},
"socialLinks": {"facebook": "",
"github": "",
"linkedin": "",
"skypeid": "",
"angelList": "",
"stackoverflow": "",
"twitter": "",
"urls": [ ]
},
"rawText": "XXXX PHP Developer 880809XXXX XXXX@gmail.com Noida sector 12/22 , Noida , India WORK EXPERIENCE Php Developer webrication 12 / 2018-06 / 2020 SKILLS php laravel mysql basic css Basic react js basic git basic html noida , uttar pradesh basic java scripts"
},
"filename": "doc9_1661100500214.pdf"
}
]
}

parse base64 string

Accepts resumes in base64 encoded string in request body , Parse it and returns the parsed content

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: application/json

Downloadable resume url to be passed in request body

base64String	string base 64 encoded string
extension	string extension of file
fileName	string file name

Responses

Request samples

Payload

Content type

application/json

{"base64String": "",
"extension": "",
"fileName": ""
}

Response samples

200
406
500

Content type

application/json

{"availableCredits": 8625,
"number_of_resumes": 2,
"errors": [ ],
"result": [{"content": {"contactInfo": {"firstName": "XXXXXX",
"lastName": "XXXX",
"middleName": "",
"title": "Mr | Miss"
},
"contactMethod": {"ContactEmailid": ["XXXXXX@gmail.com"
],
"PostalAddress": {"Location": {"Area": "",
"City": "Noida",
"Country": "",
"State": "India",
"Zip": ""
}
},
"Telephone": ["880809XXXX"
]
},
"education": {"EducationSection": [{"Collegename": "SS high school govindpur bharauli",
"Degree": "10th",
"Location": "ballia uttar pradesh",
"Major": "",
"Grade": "2.3",
"EduEndDate": {"month": 6,
"year": 2022
},
"EduStartDate": {"month": 6,
"year": 2022
}
}
]
},
"experience": {"ExperienceSection": [{"CompanyName": "webrication",
"ExpLocation": "Kanpur , Uttar pradesh",
"JobTitle": "Php Developer",
"Description": "INTERESTS Music listening Playing football Playing cricket",
"ExpEndDate": {"month": 6,
"year": 2022
},
"ExpStartDate": {"month": 6,
"year": 2022
}
}
]
},
"sections": {"sectionText": "XXXXXXX PHP Developer 880809XXXX XXXX@gmail.com Noida sector 12/22 , Noida , India",
"sectionName": "Personal_info",
"bbox": {"h": 234,
"w": 2345,
"x": 69,
"y": 67
},
"pageNumber": 2
},
"skills": {"SkillType": ["Work",
"Software",
"ProgrammingLanguage"
],
"SkillName": "Php"
},
"socialLinks": {"facebook": "",
"github": "",
"linkedin": "",
"skypeid": "",
"angelList": "",
"stackoverflow": "",
"twitter": "",
"urls": [ ]
},
"rawText": "XXXX PHP Developer 880809XXXX XXXX@gmail.com Noida sector 12/22 , Noida , India WORK EXPERIENCE Php Developer webrication 12 / 2018-06 / 2020 SKILLS php laravel mysql basic css Basic react js basic git basic html noida , uttar pradesh basic java scripts"
},
"filename": "doc9_1661100500214.pdf"
}
]
}

parse resumes by url

Accepts resumes url link in request body , Parse it and returns the parsed content

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: application/json

Downloadable resume url to be passed in request body

resumeURL

string

Resume Downloadable link

Responses

Request samples

Payload

Content type

application/json

{"resumeURL": ""
}

Response samples

200
406
500

Content type

application/json

{"availableCredits": 8625,
"number_of_resumes": 2,
"errors": [ ],
"result": [{"content": {"contactInfo": {"firstName": "XXXXXX",
"lastName": "XXXX",
"middleName": "",
"title": "Mr | Miss"
},
"contactMethod": {"ContactEmailid": ["XXXXXX@gmail.com"
],
"PostalAddress": {"Location": {"Area": "",
"City": "Noida",
"Country": "",
"State": "India",
"Zip": ""
}
},
"Telephone": ["880809XXXX"
]
},
"education": {"EducationSection": [{"Collegename": "SS high school govindpur bharauli",
"Degree": "10th",
"Location": "ballia uttar pradesh",
"Major": "",
"Grade": "2.3",
"EduEndDate": {"month": 6,
"year": 2022
},
"EduStartDate": {"month": 6,
"year": 2022
}
}
]
},
"experience": {"ExperienceSection": [{"CompanyName": "webrication",
"ExpLocation": "Kanpur , Uttar pradesh",
"JobTitle": "Php Developer",
"Description": "INTERESTS Music listening Playing football Playing cricket",
"ExpEndDate": {"month": 6,
"year": 2022
},
"ExpStartDate": {"month": 6,
"year": 2022
}
}
]
},
"sections": {"sectionText": "XXXXXXX PHP Developer 880809XXXX XXXX@gmail.com Noida sector 12/22 , Noida , India",
"sectionName": "Personal_info",
"bbox": {"h": 234,
"w": 2345,
"x": 69,
"y": 67
},
"pageNumber": 2
},
"skills": {"SkillType": ["Work",
"Software",
"ProgrammingLanguage"
],
"SkillName": "Php"
},
"socialLinks": {"facebook": "",
"github": "",
"linkedin": "",
"skypeid": "",
"angelList": "",
"stackoverflow": "",
"twitter": "",
"urls": [ ]
},
"rawText": "XXXX PHP Developer 880809XXXX XXXX@gmail.com Noida sector 12/22 , Noida , India WORK EXPERIENCE Php Developer webrication 12 / 2018-06 / 2020 SKILLS php laravel mysql basic css Basic react js basic git basic html noida , uttar pradesh basic java scripts"
},
"filename": "doc9_1661100500214.pdf"
}
]
}

Job parser

parse job uploaded by user.

parse jobs

Accepts jobs in doc ,docx, pdf ,png , jpeg format.Parse it and returns the parsed content

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: multipart/form-data

files

required

string <binary>

Jobs to be uploaded in doc,docx,pdf,png,jpeg format.

Responses

Response samples

200
406
500

Content type

application/json

{"availableCredits": 8625,
"number_of_jd": 2,
"errors": [ ],
"result": [{"content": {"job_title": "Developer",
"maximum_required_experience": null,
"minimum_required_experience": null,
"raw_text": "string",
"skills": ["Json",
"Core Java",
"Webservices",
"Business",
"Oracle"
]
},
"fileName": "JD_BetaNXT_1685348697580.docx"
}
]
}

Semantic AI Matching

Contains matching Apis by docId, texts.

Matching By ID

query Parameters

isUploaded

required

boolean

Default: false

candidate resume files to be upload

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: application/json

jobIds & resumeIds to be matched

jobIds	Array of strings
resumeIds	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"jobIds": ["string"
],
"resumeIds": ["string"
]
}

Response samples

200

Content type

application/json

{"availableCredits": 0,
"result": [{"docId": "string",
"docType": "job",
"originalFileName": "string"
}
]
}

Matching By Texts

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: application/json

Order	string Enum: "JobToTalent" "TalentToJob" "SimilarTalent" "SimilarJobs"
	object (DocumentRequest)
	Array of objects (DocumentRequest)

Responses

Request samples

Payload

Content type

application/json

{"Order": "JobToTalent",
"QueryDocument": {"documentText": "string",
"identifier": "string"
},
"SourceDocument": [{"documentText": "string",
"identifier": "string"
}
]
}

Response samples

200

Content type

application/json

{"availableCredits": 0,
"result": [{"docId": "string",
"docType": "job",
"originalFileName": "string"
}
]
}

Deep AI Recommendations

contains Recommendations APis

Get Talents Recommendations

query Parameters

page required	int32 page number
size required	int32 page size
filter required	boolean Default: true filter to be applied or not
sortBy	string sort by field

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: application/json

experienceEnd	integer <int64>
experienceStart	integer <int64>
overallScoreEnd	integer <int64>
overallScoreStart	integer <int64>
radius	integer <int64>
requiredVisa	string
source	string
dateAppliedStart	string Must be in format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
dateAppliedEnd	string Must be in format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
favourite	boolean
workAuthorization	boolean
companies	Array of strings
talentStatus	Array of strings Talent status should be Lead eg: [ “Lead”]
domains	Array of strings
locations	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"experienceEnd": 0,
"experienceStart": 0,
"overallScoreEnd": 0,
"overallScoreStart": 0,
"radius": 0,
"requiredVisa": "string",
"source": "string",
"dateAppliedStart": "string",
"dateAppliedEnd": "string",
"favourite": true,
"workAuthorization": true,
"companies": ["string"
],
"talentStatus": ["string"
],
"domains": ["string"
],
"locations": ["string"
]
}

Response samples

200

Content type

application/json

{"response": [{"content": [{"id": "string",
"talentName": "string",
"talentEmail": "string",
"talentContact": "string",
"currentJobRole": "string",
"totalWorkExperience": "string",
"diffExperience": "string",
"currentLocation": "string",
"currentCompany": "string",
"highestEducation": "string",
"diffEducation": "string",
"currentCTC": "string",
"ctcCurrenncyValue": "string",
"ctcCurrenncy": "string",
"expectedCTC": "string",
"diffCTCPrcnt": "string",
"linkedinProfile": "string",
"githubProfile": "string",
"behanceProfile": "string",
"currentNoticePeriod": "string",
"resumeURL": "string",
"talentStatus": "string",
"reasonToReject": "string",
"feedBack": "string",
"appliedOn": "string",
"fileName": "string",
"fileType": "string",
"source": "string",
"sourceDescription": "string",
"skillMatchScore": "string",
"overallScore": "string",
"expMatchScore": "string",
"titleMatchScore": "string",
"skills": [{"SkillName": "string",
"skillPercentage": 0,
"skillInJob": 0
}
],
"unMatchedSkills": ["string"
],
"histories": [{"status": "string",
"timeStamp": "string"
}
],
"seen": 0,
"viewCount": 0,
"authorized": "string",
"requiredVisa": "string",
"atsProfileLink": "string",
"favourite": true,
"latitude": null,
"longitude": null,
"distance": null,
"tags": ["string"
],
"comments": "string",
"educations": [{"degree": "string",
"degreeName": "string",
"degreeType": "string",
"startYear": 0,
"endYear": 0,
"major": ["string"
],
"measureSystem": "string",
"schoolName": "string",
"score": "string"
}
],
"employments": [{"companyName": "string",
"employmentType": "string",
"location": "string",
"positionExp": 0,
"reasonForLeaving": "string",
"salary": 0,
"startYear": 0,
"startMonth": 0,
"endYear": 0,
"endMonth": 0,
"title": "string"
}
],
"attachments": [{"fileName": "string",
"fileType": "string",
"filebase64": "string",
"fileCategory": "string",
"rawText": "string",
"updateDate": "string"
}
]
}
]
}
]
}

Run Talents Recommendations

Async API to run talent recommendations from your database. Accepts jobId (returned from create bulk job apis) and save talent recommendations in the database.

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: application/json

jobid

string

Responses

Request samples

Payload

Content type

application/json

{"jobid": "string"
}

Analyze Ids

contains APis for extracting & parsing Indonesian Ids,PAN card & Aadhar card.

Extract Indonesian Id card

Accepts indonesian id cards as Multipart document and returns parsed response.

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: multipart/form-data

files

required

string <binary>

Indonesian Id files to be uploaded.

Responses

Response samples

200

Content type

application/json

{"availableCredits": 0,
"content": {"Address": "string",
"BloodType": "string",
"Citizenship": "string",
"City": "string",
"DOB": {"date": 0,
"month": 0,
"year": 0
},
"Gender": "string",
"IDDate": {"date": 0,
"month": 0,
"year": 0
},
"IDNumber": "string",
"MaritalStatus": "string",
"Name": "string",
"POB": "string",
"Province": "string",
"RT/RW": "string",
"Region": "string",
"Religion": "string",
"SubDistrict": "string",
"ValidUntil": {"date": 0,
"month": 0,
"year": 0
},
"Work": "string"
},
"fileName": "string",
"image_links": ["string"
],
"errors": ["string"
]
}

Extract Aadhar Id card

Accepts Aadhaar id cards as Multipart document and returns parsed response.

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: multipart/form-data

files

required

string <binary>

Indonesian Id files to be uploaded.

Responses

Response samples

200

Content type

application/json

{"availableCredits": 0,
"content": {"Area": "string",
"City": "string",
"DOB": {"date": 0,
"month": 0,
"year": 0
},
"Gender": "string",
"GuardianName": "string",
"IDNumber": "string",
"Name": "string",
"PinCode": "string",
"State": "string",
"Telephone": "string",
"VIDNumber": "string"
},
"errors": ["string"
],
"fileName": "string",
"image_links": ["string"
]
}

Extract PAN card

Accepts PAN cards as Multipart document and returns parsed response.

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: multipart/form-data

files

required

string <binary>

Indonesian Id files to be uploaded.

Responses

Response samples

200

Content type

application/json

{"availableCredits": 0,
"content": {"DOB": {"date": 0,
"month": 0,
"year": 0
},
"FatherName": "string",
"Gender": "string",
"IDNumber": "string",
"Name": "string"
},
"errors": ["string"
],
"fileName": "string",
"image_links": ["string"
]
}

Analyze Expenses

contains APis for parsing Invoice & Receipts.

upload Receipt file

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: multipart/form-data

file

required

string <binary>

receipt file to be upload . Accepted file formats are doc, docx, pdf, jpg and png format.

Responses

Response samples

200

Content type

application/json

{"availableCredits": 0,
"content": {"ChangeAmount": 0,
"CompanyAddress": "string",
"CompanyEmail": "string",
"CompanyName": "string",
"CompanyPhoneNumber": "string",
"CompanyWebsite": "string",
"CurrencyUnit": "string",
"CustomerGSTIN": "string",
"PaymentAmountBase": 0,
"PaymentAmountTax": 0,
"PaymentAmountTotal": 0,
"ReceiptDate": "string",
"ReceiptNumber": "string",
"rows": [{"BaseTotal": "string",
"UnitName": "string",
"UnitPrice": null,
"UnitQuantity": "string"
}
]
},
"errors": ["string"
],
"fileName": "string"
}

upload Invoice file

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: multipart/form-data

file

required

string <binary>

Invoice file to be upload . Accepted file formats are doc, docx, pdf, jpg and png format.

Responses

Response samples

200

Content type

application/json

{"availableCredits": 0,
"content": {"BankAccountNumber": "string",
"CustomerBillingAddress": "string",
"CustomerContactName": "string",
"CustomerDeliveryAddress": "string",
"CustomerEmail": "string",
"CustomerGSTIN": "string",
"CustomerPhoneNumber": "string",
"InvoiceDate": "string",
"InvoiceNumber": "string",
"InvoiceOrderDate": "string",
"InvoicePurchaseOrderNumber": "string",
"PaymentAmountBase": null,
"PaymentAmountDue": null,
"PaymentAmountPaid": null,
"PaymentAmountTax": null,
"PaymentAmountTotal": null,
"PaymentDateDue": "string",
"PaymentReferenceNumber": "string",
"SupplierAddress": "string",
"SupplierEmail": "string",
"SupplierName": "string",
"SupplierPhoneNumber": "string",
"SupplierWebsite": "string",
"rows": [{"BaseTotal": null,
"TaxName": "string",
"TaxRate": null,
"TaxTotal": null,
"Total": null,
"UnitCode": "string",
"UnitDiscount": null,
"UnitName": "string",
"UnitPrice": 0,
"UnitQuantity": 0
}
]
},
"errors": ["string"
],
"fileName": "string"
}

Explainable Match

contains APis for explainable match.

Explainable Match Api

header Parameters

Authorization

required

string

Authorization header from login api

Request Body schema: application/json

jobIds & resumeIds to be matched

	object (JDParserContent)
	object (ResumeEMRequest)

Responses

Request samples

Payload

Content type

application/json

{"jd": {"content": {"job_title": "Developer",
"maximum_required_experience": null,
"minimum_required_experience": null,
"raw_text": "string",
"skills": ["Json",
"Core Java",
"Webservices",
"Business",
"Oracle"
]
},
"fileName": "JD_BetaNXT_1685348697580.docx"
},
"resume": {"skills": [{"SkillType": ["Work",
"Software",
"ProgrammingLanguage"
],
"SkillName": "Php"
}
],
"experience": [{"sectionText": "XXXXXXX PHP Developer 880809XXXX XXXX@gmail.com Noida sector 12/22 , Noida , India",
"sectionName": "Personal_info",
"bbox": {"h": 234,
"w": 2345,
"x": 69,
"y": 67
},
"pageNumber": 2
}
],
"titles": {"ExperienceSection": [{"CompanyName": "webrication",
"ExpLocation": "Kanpur , Uttar pradesh",
"JobTitle": "Php Developer",
"Description": "INTERESTS Music listening Playing football Playing cricket",
"ExpEndDate": {"month": 6,
"year": 2022
},
"ExpStartDate": {"month": 6,
"year": 2022
}
}
],
"TotalExperience": null,
"AverageExperience": null,
"CurrentCompany": null,
"CurrentJobRole": null
}
}
}

Response samples

200

Content type

application/json

{"availableCredits": 0,
"result": [{"missing_skills": ["Json",
"Core Java",
"Webservices",
"Business",
"Oracle"
],
"scores": {"experience": {"grade": "A",
"score": "0.7"
},
"job_title": {"grade": "A",
"score": "0.7"
},
"overall_score": {"grade": "A",
"score": "0.7"
},
"skills": {"grade": "A",
"score": "0.7"
}
}
}
]
}