Salary Slip Extraction
Introduction
Our Salary Extraction API offers a comprehensive solution for extracting and analyzing salary details from employee pay slips. Designed for seamless integration, this API captures essential payroll information and presents it in a structured format. Whether you're automating payroll management or conducting financial assessments, this API delivers accurate and detailed salary data for your needs.
Key Features:
- Employee Information: Extracts key details such as employee name, designation, and employer information.
- Compensation Breakdown: Provides a clear breakdown of net salary, gross salary, and detailed deductions including EPF, ESI, Professional Tax, and other deductions.
- Employment Details: Includes essential employment data like work location, date of joining, and salary credit month.
- Tax and Identification: Captures critical identifiers such as PAN and UAN numbers.
- Payment Structure: Outlines the basic salary, HRA, and mode of payment, ensuring a complete picture of the salary structure.
API details
Endpoint
https://api-preproduction.signzy.app/api/v3/extract/salary-sliphttps://api.signzy.app/api/v3/extract/salary-slipRequest 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 | String | Persist URL of the pdf of salary slip or base64 text (Max 6 pages) | Mandatory |
{
"file": "https://staging-persist.signzy.tech/api/files/5038366/download/xxxxxx.pdf"
}Code samples
curl --location 'https://api-preproduction.signzy.app/api/v3/extract/salary-slip' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data '{
"file": "https://staging-persist.signzy.tech/api/files/5038366/download/xxxxxx.pdf"
}'Response body parameters
Parameter | Data Type | Description |
|---|---|---|
requestId | String | Unique requestId generated after passing a valid salary slip |
message | String | Message to indicate that the request is initiated successfully |

{
"requestId": "e8dc938d-43d6-49b6-8a68-524ba9d2304b",
"message": "Request Submitted Successfully."
}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!