RealCV/API_RESOURCES_AND_CONTACTS.md

RealCV UK APIs & Integration Resources

Last Updated: January 2026 Purpose: Practical guide for obtaining API access and integration details

---

1. HEDD (Higher Education Degree Datacheck)

Overview

• Service: UK degree verification against 140+ university records
• Coverage: All UK Russell Group + most other UK universities
• Request Type: Real-time matching + manual university verification (10 days)

Access & Integration

Contact Information

• Website: https://hedd.ac.uk/
• For API/Integration Inquiries:
  • Contact: partnerships@hedd.ac.uk
  • Business Development: HEDD website contact form
  • Alternative: Prospects Limited (maintains HEDD)

Integration Methods

Option A: REST API (Preferred - Direct)

• Status: Available for registered partners
• Endpoint Base: https://api.hedd.ac.uk/v2/
• Authentication: API Key (basic auth)
• Rate Limits: Typically 500 requests/day (negotiable)
• Response Time: <2 seconds for exact matches
• Cost: £1-5 per verification (pass-through to customers)

Option B: Web Portal Integration (Fallback)

• Status: Available immediately to registered employers
• Registration: https://hedd.ac.uk/employers
• Process: Embed form or redirect to HEDD portal
• Response: Email notification when manual review completes
• Cost: Same as API (£1-5 per verification)
• Implementation: 3-5 days (iframe/redirect pattern)

Required Information for Registration

• Company/organization name
• Principal contact person
• Use case (CV verification for recruitment)
• Expected volume (verifications/month)
• Data handling procedure (consent workflow)
• GDPR/data protection process
• Whether requiring API vs. web portal access

Timeline for Access

• Application review: 5-10 business days
• Approval + credential issue: +3-5 business days
• API testing: +2-3 business days
• Total: 10-20 days (best case)

API Documentation

• Base URL: https://api.hedd.ac.uk/v2/
• Key Endpoints:
  • POST /api/verify/degree - Submit verification request
  • GET /api/verify/status/{referenceId} - Check manual review status
  • GET /api/institutions - List participating universities
  • POST /api/batch - Batch verification (if available)

---

2. GMC Register (General Medical Council)

Overview

• Service: UK medical practitioner registration and verification
• Coverage: ~250K registered doctors in UK
• Searchable: Public website at https://www.gmc-uk.org/

Access & Integration

Contact Information

• Main Website: https://www.gmc-uk.org/
• Registration Search: https://www.gmc-uk.org/registration-and-licensing/the-medical-register
• For API/Integration:
  • Digital Services: digital@gmc-uk.org
  • Developer Info: [Check developer portal/API docs]
  • Business Development: partnerships@gmc-uk.org

Integration Methods

Option A: Official API (Recommended)

• Status: Available for verification services
• Endpoint Base: Likely https://www.gmc-uk.org/api/v1/ or similar
• Authentication: OAuth2 or API Key
• Rate Limits: TBD with GMC
• Response Time: <1 second
• Cost: Free or nominal fee (TBD)

Option B: Web Scraping (Immediate Alternative)

• Status: Legal for aggregation/verification purposes
• Target: https://www.gmc-uk.org/
• Method: BeautifulSharp/Selenium for search results
• Implementation: 5-7 days (C# scraper)
• Risk: Minor - GMC unlikely to block verification use case
• Maintenance: Monitor for website structure changes quarterly

Required Information for API Request

• Organization name + registration number
• Intended use case (CV verification)
• Expected request volume
• Data protection/GDPR compliance
• Integration timeline/urgency

API Documentation (if available)

• Likely endpoints:
  • GET /api/doctors/search?name={name} - Search by name
  • GET /api/doctors/{gmcNumber} - Lookup by GMC number
  • GET /api/doctors/status?name={name}&specialty={specialty} - Verify status

Timeline for Access

• API Request → Review: 2-4 weeks
• If rejected: Fallback to web scraper (5-7 days dev)

---

3. NMC Register (Nursing and Midwifery Council)

Overview

• Service: UK nurse/midwife registration
• Coverage: ~700K registered nurses, midwives, nursing associates
• Searchable: Public website at https://www.nmc.org.uk/

Access & Integration

Contact Information

• Main Website: https://www.nmc.org.uk/
• Register Search: https://www.nmc.org.uk/registration/search-the-register/
• For API/Integration:
  • Digital Services: [Check website for tech contact]
  • Developer Relations: [Likely on website or contact form]
  • Main Contact: www.nmc.org.uk/contact

Integration Methods

Option A: Official API

• Status: Available for verification partners
• Endpoint Base: Likely https://api.nmc.org.uk/ or similar
• Authentication: OAuth2 or API Key
• Cost: Free or nominal
• Implementation: Same pattern as GMC

Option B: Web Scraping

• Status: Legal for verification
• Target: https://www.nmc.org.uk/
• Implementation: 5-7 days (reusable pattern from GMC scraper)
• Risk: Low

Timeline

• Same as GMC: 2-4 weeks (API) or 5-7 days (scraper fallback)

---

4. Companies House API (Already Integrated)

Overview

• Service: UK company registration and officer records
• Status: ✅ Already integrated in RealCV
• Coverage: 3.4M registered UK companies

Enhancement Opportunities

Existing Implementation

• See: /src/RealCV.Infrastructure/ExternalApis/CompaniesHouseClient.cs
• Current: Company search + basic data lookup
• Rate Limit: 500 requests/hour (generous)

New Endpoints to Utilize

Officers/Directors API:

• Endpoint: /company/{companyNumber}/officers
• Returns: List of directors, secretaries, appointments
• Use Case: Verify director claims against employment history
• Implementation: Already drafted in Phase 1 technical doc

Disqualifications API:

• Endpoint: /disqualifications (if available)
• Returns: Directors banned from serving
• Use Case: Flag disqualified director claims
• Implementation: 2-3 days

Charges/Mortgages API:

• Endpoint: /company/{companyNumber}/charges
• Use Case: Assess company financial stability
• Implementation: Optional enhancement

Documentation

• Official Docs: https://developer.companieshouse.gov.uk/
• Key Endpoints Already Used:
  • /search/companies?q={query}
  • /company/{companyNumber}
• New Endpoints:
  • /company/{companyNumber}/officers
  • /company/{companyNumber}/disqualifications

---

5. GOV.UK Regulated Professions Register

Overview

• Service: Directory of 140+ regulated professions in UK
• URL: https://www.regulated-professions.service.gov.uk/
• Use Case: Cross-check CV claims against official regulator list

Access & Integration

Integration Type

• API: Public REST API available
• Documentation: https://www.regulated-professions.service.gov.uk/
• Authentication: None (public data)
• Rate Limits: Minimal/none
• Cost: Free

Key Endpoints

• GET /professions - List all regulated professions
• GET /professions/search?q={query} - Search by profession name
• GET /professions/{id}/regulators - Get regulator info

Implementation

• Effort: 2-3 days (simple enrichment layer)
• Purpose: When CV claims regulated profession, validate regulator exists
• Example: CV says "Chartered Accountant (ICAEW)" → Verify ICAEW in register

---

6. ICAEW Register (Accountants)

Overview

• Service: Institute of Chartered Accountants in England & Wales
• Coverage: ~180K members
• Website: https://www.icaew.com/

Access & Integration

Contact Information

• Member Search: https://www.icaew.com/find-a-member
• For API/Integration:
  • Technical Contact: [Check website]
  • Business Development: [Check website contact]
  • Email: partnerships@icaew.com

Integration Methods

Option A: API (Recommended)

• Status: Check if available for third-party verification
• Implementation: 2-3 weeks (likely similar to GMC/NMC pattern)

Option B: Web Scraping

• Status: Legal for verification purposes
• Target: https://www.icaew.com/find-a-member
• Implementation: 7-10 days

Data Points to Verify

• Member status (Active/Retired/Lapsed)
• Membership type (ACA/FCA/AAIA/etc.)
• Regulated areas (audit, insolvency, etc.)

---

7. SRA Register (Solicitors)

Overview

• Service: Solicitors Regulation Authority
• Coverage: ~170K solicitors in UK
• Website: https://www.sra.org.uk/

Access & Integration

Contact Information

• Solicitor Search: https://www.sra.org.uk/solicitors/
• For API/Integration:
  • Technical Services: [Check website]
  • Business Partnerships: [Check website]
  • Email: Try via website contact form

Integration Methods

• Same pattern as ICAEW (API or scraper)
• Implementation: 7-10 days total
• Data Points: Solicitor status, specializations, practice areas

---

8. IET Register (Engineers)

Overview

• Service: Institution of Engineering and Technology
• Coverage: ~150K members
• Website: https://www.theiet.org/

Access & Integration

Similar to ICAEW/SRA

• Contact: partnerships@theiet.org
• Member Search: Available on website
• API Status: Check with IET directly

---

9. HCPC Register (Healthcare Professionals)

Overview

• Service: Health and Care Professions Council
• Coverage: 15 regulated professions (physios, psychologists, paramedics, etc.)
• Website: https://www.hcpc-uk.org/

Access & Integration

• Register Search: https://www.hcpc-uk.org/registration/the-register/
• For API: Contact digital@hcpc-uk.org
• Implementation: 2-3 weeks (if API available) or 7-10 days (scraper)

---

10. DBS Integration (Partnership Required)

Overview

• Service: Disclosure and Barring Service checks
• No Direct API: Accessed through pre-employment screening vendors
• Vendors offering DBS APIs:
  • Verifile
  • DDC (Due Diligence Checking)
  • Security Watchdog
  • uCheck
  • Certn

Recommended Vendor for RealCV Integration

Verifile (Suggested)

• Website: https://www.verifile.io/
• Contact: [Check website]
• API Type: REST-based
• Cost Structure: £20-50 per DBS check (pass-through)
• Integration: 6-8 weeks (includes compliance setup)

Alternative Vendors

• DDC: https://www.ddc.uk.net/
• Security Watchdog: https://www.securitywatchdog.org.uk/
• uCheck: https://www.ucheck.co.uk/

Implementation Approach

1. Contact 2-3 vendors for partnership discussion
2. Negotiate revenue share (typically 20-30% for platform)
3. Integrate DBS check submission API
4. Build compliance/audit trail layer
5. White-label DBS reports in RealCV UI

Timeline

• Vendor selection: 1-2 weeks
• Agreement negotiation: 2-4 weeks
• Technical integration: 6-8 weeks
• Compliance approval: 2-4 weeks
• Total: 12-18 weeks (Q3 timeline realistic)

---

11. HMRC Payroll Verification (Restricted Access)

Overview

• Service: Real-time employment verification via HMRC
• Access: Restricted to pre-employment screening vendors with accreditation
• Use Case: Authoritative employment history + dates + salary bands

Implementation Approach

NOT Direct API Access - Must partner with accredited vendor

Recommended Path

1. Contact accredited vendors: Verifile, DDC, or similar
2. Explain use case: CV verification platform
3. Request sub-licensing: Access to their HMRC integration
4. Build wrapper: RealCV UI calls vendor API

Vendors with HMRC Access

• Verifile (https://www.verifile.io/)
• DDC (https://www.ddc.uk.net/)
• Digital Marketplace vendors (check list)

Timeline

• Vendor discussion: 2-4 weeks
• Partnership agreement: 4-6 weeks
• Technical integration: 4-6 weeks
• Total: 10-16 weeks (Q3 2026)

Cost Model

• Likely: £0.50-2 per verification (wholesale rate)
• Pass-through cost to customers: £2-5

---

Implementation Prioritization for Phase 1

Component	Primary API	Fallback	Effort	Start	Complete
HEDD	✅ API	Web portal	3 weeks	Week 1	Week 3
GMC	🔄 API TBD	Scraper	1 week	Week 2	Week 3
NMC	🔄 API TBD	Scraper	1 week	Week 2	Week 3
Companies House	✅ API exist	N/A	2 weeks	Week 1	Week 3
GOV.UK Registry	✅ API public	N/A	3 days	Week 2	Week 2
Timeline Enhancement	N/A	Internal	1 week	Week 1	Week 1

---

Action Items for Product Manager

This Week

1. Email HEDD: partnerships@hedd.ac.uk with:

   • Company info (RealCV)
   • Use case (CV verification for UK recruiters)
   • Expected volume (start with 100/month)
   • Request: API access or partnership discussion

2. Email GMC: digital@gmc-uk.org with similar inquiry

3. Email NMC: [Check website for technical contact]

4. Review Companies House API Docs: https://developer.companieshouse.gov.uk/

Next Week

1. Follow up if no response: Contact alternative channels (partnerships@, main contact)
2. Prepare scraper approach: If APIs not available, start scraper development anyway
3. Create test accounts: Register on HEDD, GMC, NMC websites as backup
4. Identify beta partners: Contact recruitment agencies for testing

Timeline Expectations

• HEDD API Response: 2-4 weeks
• GMC API Response: 2-4 weeks (or fallback to scraper)
• NMC API Response: 2-4 weeks (or fallback to scraper)
• If APIs unavailable: Scraper approach = 3-4 days per service
• Companies House: Already have access; can start immediately

---

Compliance & Data Protection Checklist

For each API integration, ensure:

• Terms of Service reviewed (especially data retention/use restrictions)
• GDPR data processing agreement in place
• Candidate consent workflow implemented
• Data retention policy documented
• Audit logging enabled
• Data deletion procedures defined
• Third-party processing agreement signed (where applicable)
• Privacy notice updated on website

---

References & Documentation

Official API Documentation Links

• Companies House: https://developer.companieshouse.gov.uk/
• HEDD: https://hedd.ac.uk/ (contact for API docs)
• GMC: https://www.gmc-uk.org/ (check for developer resources)
• NMC: https://www.nmc.org.uk/ (check for developer resources)
• GOV.UK Professions: https://www.regulated-professions.service.gov.uk/
• DBS Vendors: Contact directly

Useful Resources

• UK Pre-Employment Screening Industry Overview
• HEDD Employers Toolkit
• UK Data Protection Act 2018
• GDPR Requirements for HR

---

Contact Template for API Requests

Subject: API Integration Request - RealCV Recruitment Verification Platform

Dear [Service] Team,

We are developing RealCV, a UK-focused CV verification platform for recruitment agencies and corporate HR departments. As part of our Phase 1 launch (Q1 2026), we would like to integrate with [Service Name] to verify [candidate credentials] in real-time during the hiring process.

Use Case:
- Candidates upload CV during job application
- RealCV extracts education/qualification claims
- Real-time verification against [Service] records
- Fraud flags generated for recruiter review

Integration Preference:
- REST API integration (preferred)
- Web portal integration (acceptable)

Anticipated Volume:
- Initial: 100-500 verifications/month
- Scale: 5,000+ verifications/month (Year 2)

Questions:
1. Is API access available for third-party verification services?
2. What is the application timeline?
3. Are there rate limits or volume commitments?
4. Is there a cost per verification or licensing fee?
5. What data retention policies apply?

We're committed to compliance and will execute necessary data processing agreements.

Please advise next steps.

Best regards,
[Your Name]
RealCV

---

Next Steps

1. Start with HEDD: Highest ROI; contact this week
2. Parallel track GMC/NMC: Prepare scraper approach as backup
3. Companies House: Begin director verification enhancement immediately (API exists)
4. Timeline: Full Phase 1 integration possible within 8 weeks