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 end-to-end verification workflow within HRMS/ATS
3. Integration Architecture & Data Flow
3.1 Data Flow Diagram
The diagram illustrates:
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:
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:
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:
5. API Documentation and Resources