SpringVerify API Integration Guide for HRMS/ATS
1. Introduction
This document provides comprehensive technical guidance for integrating the SpringVerify Background Verification (BGV) platform with your HRMS (Human Resource Management System) or ATS (Applicant Tracking System). The integration enables:
- Seamless addition of candidates to SpringVerify
- Automated background check initiation
- Efficient BGV document collection
- Real-time BGV report retrieval and status monitoring
This integration significantly streamlines the background verification process by eliminating manual data entry and ensuring consistent information flow between systems.
2. Integration Options
SpringVerify offers flexible integration options tailored to client requirements. Each option builds upon the previous one to provide increasing levels of automation and functionality.
2.1 Add Candidate Integration
Functionality:
- Add candidate data from HRMS/ATS to SpringVerify platform
- Synchronize candidate details automatically
- Initiate BGV workflow manually or automatically
Benefits:
- Eliminates duplicate data entry
- Ensures data consistency between systems
- Accelerates verification initiation
2.2 Add Candidate + Show BGV Report
Functionality:
- All capabilities from the Add Candidate Integration
- Retrieve BGV status updates
- Display verification progress within HRMS/ATS interface
- Access downloadable BGV reports directly in HRMS/ATS
Benefits:
- Provides visibility into verification progress
- Centralizes candidate information and verification status
- Enables informed decision-making with immediate access to reports
2.3 Add Candidate + Process BGV Form + Show BGV Report
Functionality:
- All capabilities from previous integration levels
- Pre-fill candidate BGV forms using existing HRMS/ATS data
- Or, submit completed BGV forms automatically
- Fetch available documents from HRMS/ATS for verification
- Display comprehensive BGV reports in HRMS/ATS
Benefits:
- Maximizes automation of the verification process
- Improves candidate experience with pre-filled forms
- Provides an end-to-end verification workflow within HRMS/ATS
3. Integration Architecture & Data Flow
3.1 Data Flow Diagram
Initial candidate data transfer from HRMS/ATS to SpringVerify
- Document exchange between systems
- Status updates from SpringVerify to HRMS/ATS
- Final BGV Report delivery back to HRMS/ATS
3.2 Data Models
Add Candidate Object (Minimum Required Fields):
{
“Name”: ”String (required)”,
"email": "String (required)",
"phone": "String (required)",
"package_identifier": "String (mandatory)", // BGV Package opted by Client team on SpringVerify
"resume": "URL (optional)”,
"uan": "String (optional)",
"employee_id": "String (optional)",
"gender": "String (optional)"
}
BGV Status Object:
{
"candidate_id": "String",
"overall_status": "String",
"bgv_completion_date": "Date",
"overall_status_last_updated_at": “Date”,
"report_url": “protected BGV Report URL”, // accessible by SpringVerify Users
"report_base_64_encoded": "String"
}
4. Integration Approaches
4.1 Developed by SpringVerify Team
Prerequisites:
- SpringVerify team requires:
- Sandbox access to client's HRMS/ATS
- API credentials and comprehensive documentation
- Technical contact person from client side
Process:
- SpringVerify performs:
- Initial feasibility assessment using sandbox environment
- Development and unit testing of integration components
- Provides sandbox credentials to client for integration testing
- Supports Testing and Production deployment
- Post-deployment monitoring and support
Advantages:
- Reduced development effort for client team
- Implementation by team with deep product knowledge
- Standard implementation based on best practices
4.2 Developed by Client/Partner Team
Resources Provided:
- SpringVerify will provide:
- Comprehensive API documentation with endpoint details
- Sandbox environment and test credentials
- Sample request/response payloads
- Error handling guidelines and troubleshooting support
- Technical consultation throughout development/ testing
Process:
- Client/HRMS/ATS team:
- Develops the integration components
- Coordinates testing with SpringVerify using sandbox environment
- Performs internal QA and validation
- Deploys to production after joint testing with SpringVerify team
Advantages:
- Greater customization flexibility
- Integration tailored to specific HRMS/ATS capabilities
5. API Documentation and Resources
- SpringVerify API Documentation: https://documenter.getpostman.com/view/3927563/2s8YswRX6z#2edb9680-cb11-4e26-9c94-da5d98d8d2a3
- Sandbox Account Credentials
- Password: Test@1234567
- Note: For User specific Sandbox access please connect with the springverify team.
- Assigned CS team
- SpringVerify Integration team: tarun.kumar@springworks.in
Related Articles
Integration of SpringVerify with RazorpayX
SpringVerify has built the external add candidate API and the Report API. Clients can now generate JWT tokens from the security page and immediately begin utilizing our external APIs. Additionally, we've introduced a new page called 'Integrations' ...🔗 Integrating SpringVerify with PocketHRMS
Overview: SpringVerify has developed integrations with PocketHRMS, enabling seamless handling of employee verifications for your organization. This integration simplifies and automates the background verification process within PocketHRMS’s platform. ...Integration of SpringVerify with BambooHR ATS
Overview: SpringVerify IN has developed integrations with BambooHR ATS, allowing clients to generate BambooHR API keys from the BambooHR platform. This integration streamlines and automates background verification processes within the BambooHR ...How to generate an API key on SpringVerify portal?
Steps to generate API token on SpringVerify 1. Log into your SpringVerify account with your login credentials 2. Go to Profile (top right corner) 3. Click Setting from the Dropdown 4. Navigate to API section 5. In this section, click on Generate ...Integrating SpringVerify with Keka ATS
? SpringVerify + Keka ATS Integration Made Simple SpringVerify is now seamlessly integrated with Keka ATS. That means you can manage pre-onboarding background verifications right inside Keka — faster, smoother, and with less manual work. Here’s ...