.svg)
.svg)
The Credentially Connector
Integrations can be complex, but we're here to help. Our approach focuses on understanding your specific needs and delivering integration solutions that work for
your organisation.
Integration Options
.png)
Option 1:
Direct Integration (Connected by Us)
We build a direct connection between your ATS/HRIS/CRM system and Credentially.
What it does:
- Initially creates staff members in Credentially when they're added to your system (minimal data transferred at this stage)
- Continuously syncs detailed compliance and profile data from Credentially back to your system
- Maps standard fields and can include custom field mapping based on your requirements.
Current capabilities:
- Initial basic data sync: Your system → Credentially (triggered when placement or candidate reaches certain stage in your process)
- Ongoing detailed data sync: Credentially → Your system (compliance status, profile updates, documents)
- Sync frequency controlled by us but influenced by your system's capabilities
- We connect to your system; your system doesn't need to connect to us.
What to be aware of:
- Dependent on your ATS/CRM's API capabilities
- Some systems have more integration options than others
- Each integration is configured specifically for your system and requirements.
Option 2:
REST API
For organisations with development teams who want direct integration control, our REST API provides programmatic access to selected Credentially data.
What it enables:
- Read and write access to candidate profile data
- Retrieve compliance statuses, document details, references, and checks
- Build custom workflows that suit your exact needs
Current API coverage:
- Not all endpoints are publicly exposed
- Currently limited to a handful of core functionsAPI documentation available and being continuously improved
- OCR/document extraction capabilities have some limitations
Requirements:
- Your own development resources
- Technical support provided during implementation
Integration Process
Standard Data Flows
How Our Standard Integration Works
Phase 1: Initial Creation (Your System → Credentially)
When a placement/candidate reaches a certain stage in your system, minimal data flows to Credentially:
- Basic contact details (name, email, phone)
- Candidate/Placement ID Role information
- Organisation details
This triggers the onboarding and compliance process in Credentially
Phase 2: Ongoing Sync (Credentially → Your System)
Once the candidate is in Credentially, we continuously sync rich data back to your system:
- Detailed profile information
- Compliance status updates
- Document uploads and updates
- Check results (DBS, professional registrations, Right to Work, etc.)
- Reference status
- Onboarding progress
- Custom field data.
What This Means:
- Your system triggers candidate creation with basic details
- Credentially becomes the source of truth for compliance and detailed profile data.
- Your system receives continuous updates as compliance progresses
- Sync frequency is controlled by us but influenced by your system's API capabilities.
File and Document Handling
Documents from Credentially to Your System:
- Files uploaded to candidate profiles in Credentially are automatically sent to your system
- New versions of documents trigger updates to your system
- All files and all versions are sent
Current Limitations:
- File size and type restrictions apply (based on both systems' capabilities)
- Document metadata synced: issue date, expiry date, document number
- Other metadata currently unavailable
- Dependent on your system's file handling capabilities
Compliance Status Sync
- Overall compliance status syncs from Credentially to your system
- Individual compliance requirement details available (documents, checks, references, etc.)
- Real-time updates as compliance status changes in Credentially
Field Mapping
The table below shows the standard fields and their sync direction. Custom field mapping can be configured during implementation.
Important Note:
The initial sync from your system to Credentially (at placement creation) includes only basic fields. The majority of data flows from Credentially back to your system on an ongoing basis.
Current Limitations
File Handling:
- Both Credentially and your system have file size and type restrictions
- Not all file types may be supported by your system
- Large files may need alternative handling
Metadata:
- Currently sync: issue date, expiry date, document number
- Other document metadata not currently available
Integration Coverage:
- Standard integration flow covers most common use cases
- Highly customised workflows will require additional engineering
- Not all Credentially features are be available via integration
System Dependencies:
- Integration capabilities limited by your ATS/CRM's API
- Some systems offer more robust APIs than others
- Sync frequency influenced by (but not entirely determined by) third-party system capabilities.
What's Next?
If you're interested in integrating your systems with Credentially:
1. Contact your Customer Success Manager or email support@credentially.io
2. Book a discovery workshop to discuss your specific integration requirements
3. Receive a tailored proposal outlining what we can deliver, realistic timelines, and costs
4. Technical review of your system's API capabilities
5. Agree scope and begin build
Ready to transform your credentialing process?
Experience the efficiency and reliability of Credentially. Book a demo today to see how we can support your organisation's needs.
.svg)