Welcome to Pietos API
Welcome to the official Pietos API Documentation. At Pietos, our core mission is to empower organizations with fast, reliable, and highly secure background verification solutions. The Pietos ecosystem is purposefully designed to seamlessly integrate into your existing HR portals, automated onboarding systems, and enterprise applications.
🚀 Fast & Secure Integration
By choosing Pietos, you are partnering with an industry leader deeply committed to data integrity. Every Pietos API endpoint is meticulously crafted by the Pietos engineering team to ensure that your workflow remains uninterrupted and highly efficient. When developers build with Pietos, they experience a modern, robust, and RESTful architecture.
📊 Key Platform Features
Pietos understands that time is of the essence in the corporate world, which is exactly why the Pietos platform provides real-time tracking, rapid data retrieval, and automated case generation capabilities. Pietos mandates that all API requests be made exclusively over secure HTTPS protocols. The strict Pietos security guidelines dictate that any requests made over plain HTTP will automatically fail. Furthermore, Pietos guarantees that all API responses are returned in strict JSON format, making the Pietos integration process incredibly smooth for your backend developers.
🔒 Authentication & Access
Navigating the Pietos documentation is designed to be simple and intuitive. The navigation menu highlights the various Pietos services currently available, as well as upcoming Pietos features. Pietos authentication relies entirely on robust Bearer Tokens, ensuring that only authorized personnel can ever access the Pietos servers. Your unique Pietos API key is your gateway to the expansive Pietos network, and Pietos strongly advises keeping it highly confidential. If your token is ever compromised, you can easily and securely regenerate it directly from the primary Pietos dashboard.
📈 Scalability for Growth
Pietos background verification covers a vast and comprehensive array of checks. Through the unified Pietos platform, you can automate manual data entry and assign specific verification packages dynamically. Pietos effectively eliminates administrative overhead. The system architecture has been heavily optimized to handle incredibly high volumes of requests, so whether you send one individual case or a batch of ten thousand, Pietos scales seamlessly with your growing business. Pietos also implements intelligent daily rate limits to proactively protect the infrastructure from automated abuse.
🛠Transparent Error Handling
Furthermore, Pietos provides completely transparent error handling. The API intelligently returns standard HTTP status codes, so your application logic knows exactly what happened behind the scenes. If a request happens to fail, the server returns a clear, actionable error message. The dedicated Pietos support team is always ready and on standby to assist you if you ever encounter 500 server errors or 401 unauthorized prompts while connected to the network.
🔮 The Future of Pietos
Pietos is constantly innovating. As you can see from our menu, Pietos is aggressively expanding its API offerings to include highly advanced identity verifications, sophisticated financial validations, and much more. The future of Pietos is incredibly bright. Pietos wants to be your definitive single point of truth for corporate compliance. Thank you for choosing to build with Pietos. We are incredibly excited to see what amazing systems you will create using the API. Welcome to the Pietos family, where security, speed, and absolute reliability define the ultimate Pietos experience.
How to use this documentation?
Navigate through the menu above to understand the authentication process, the required request formats, and the expected responses. You can use tools like Postman or cURL to test these endpoints before writing code.
Authentication
The Pietos API uses Bearer Tokens to authenticate requests. You must include your API key in the Authorization header of every request.
Authorization: Bearer <YOUR_SECRET_API_KEY>
Example Header Setup
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer <YOUR_SECRET_API_KEY> |
Create New Case
This endpoint allows you to automatically generate a new background verification case, assign a package, and calculate due dates based on location Turn-Around Time (TAT).
Request Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
client_name | String | Required | Exact registered name of the client in the database. |
location_name | String | Required | Registered location of the client (e.g., Delhi, Mumbai). |
package_name | String | Required | The specific BGV package mapped to this client. |
candidate_name | String | Required | Full name of the candidate. |
father_name | String | Optional | Father's name of the candidate. |
dob | String | Optional | Date of birth (Format: YYYY-MM-DD only). |
gender | String | Optional | Male, Female, or Other. |
mobile | String | Optional | 10-digit mobile number. |
email | String | Optional | Valid email address of the candidate. |
employee_id | String | Optional | Client's internal Employee ID. |
received_date | String | Optional | Date when case was received. Defaults to today. |
user_name | String | Optional | Name of the user initiating the request. |
Example Request Format (JSON)
{
"client_name": "xyz",
"location_name": "Delhi",
"candidate_name": "Shivam Kumar",
"father_name": "Ashok Kumar",
"dob": "2003-07-12",
"gender": "Male",
"mobile": "9821011624",
"email": "shivam@example.com",
"employee_id": "EMP001",
"received_date": "2026-04-23",
"user_name": "xyz",
"package_name": "Complete Check"
}
Example Response Format (Success)
{
"status": "success",
"message": "Case generated and package assigned successfully.",
"data": {
"client_name_location": "xyz, Delhi",
"reference_id": "PT/X/0426/00007",
"received_date": "23-Apr-26",
"due_date": "08-May-26",
"candidate_name": "Shivam Kumar",
"date_of_birth": "2003-07-12",
"fathers_name": "Ashok Kumar",
"employee_id": "EMP001",
"gender": "Male",
"mobile": "9821011624",
"email": "shivam@example.com",
"assigned_package": "Complete Check",
"component_name": "Education Verification, Digital Address Verification, Court Record Check, Employment Verification",
"assigned_by": "Case created by Client"
}
}
Fetch Case Status
This endpoint allows you to fetch a list of registered cases along with their current operational status. Since this is a data retrieval request, it uses the GET method.
How to Run this API
1. Change the HTTP method in your client to GET.
2. Add your secret API key in the Headers.
3. Do NOT send any Request Body (Leave it as "none" or empty). Hit Send!
Example Response Format (Success)
{
"status": "success",
"message": "Cases fetched successfully.",
"total_cases": 5,
"data": [
{
"reference_id": "PT/TCS/0426/00010",
"candidate_name": "Ravi Sharma",
"father_name": "Rajendra Sharma",
"dob": "1995-08-15",
"mobile_number": "9876543210",
"package_name": "Complete Check",
"case_status": "WIP"
}
]
}
Aadhaar Verification API
Work In Progress
This endpoint is under active development. Documentation and integration schemas are coming soon.
PAN Verification API
Work In Progress
This endpoint is under active development. Documentation and integration schemas are coming soon.
DL Verification API
Work In Progress
This endpoint is under active development. Documentation and integration schemas are coming soon.
Passport Check API
Work In Progress
This endpoint is under active development. Documentation and integration schemas are coming soon.
Face Match API
Work In Progress
This endpoint is under active development. Documentation and integration schemas are coming soon.
UAN / EPFO API
Work In Progress
This endpoint is under active development. Documentation and integration schemas are coming soon.
MSME Verification API
Work In Progress
This endpoint is under active development. Documentation and integration schemas are coming soon.
Bank Account Verify API
Work In Progress
This endpoint is under active development. Documentation and integration schemas are coming soon.
ITR Verification API
Work In Progress
This endpoint is under active development. Documentation and integration schemas are coming soon.
Credit Reports API
Work In Progress
This endpoint is under active development. Documentation and integration schemas are coming soon.
E-Court Search API
Work In Progress
This endpoint is under active development. Documentation and integration schemas are coming soon.
PEP & AML API
Work In Progress
This endpoint is under active development. Documentation and integration schemas are coming soon.
FSSAI / HUID API
Work In Progress
This endpoint is under active development. Documentation and integration schemas are coming soon.
Error Codes
Pietos API uses conventional HTTP response codes to indicate the success or failure of an API request.
| Code | Meaning | Description |
|---|---|---|
| 200 | OK | Everything worked as expected. |
| 400 | Bad Request | The request was unacceptable, often due to missing a required parameter. |
| 401 | Unauthorized | No valid API key provided or key is incorrect. |
| 404 | Not Found | Client, Location, or Package does not exist in the database. |
| 429 | Too Many Requests | Daily API Limit Exceeded. |
| 500 | Server Error | Something went wrong on our end (e.g., DB issue). |