Become a partner

API Reference

The Archive Partner API provides programmatic access to our proprietary Digital Confidence Scores (DCS), company rankings, and compliance signals for all 4.8M UK entities, segmented per county.

Authentication

All API requests require an API key. You can obtain your key from the Partner Dashboard. Authentication is handled via the Authorization header using the Bearer token scheme.

# Example request
curl -X GET "[https://api.archivepartner.com/v1/company/00129871](https://api.archivepartner.com/v1/company/00129871)" \
     -H "Authorization: Bearer YOUR_API_KEY"

Endpoints

1. Retrieve Company Profile

GET /v1/company/:id

Fetches the complete digital audit record for a specific business using its 8-digit Companies House ID.

Parameter Type Required Description
id string Yes The 8-digit unique company identifier (e.g., 00129871).

Sample Response:

{
  "company_id": "00129871",
  "company_name": "Harris & Bailey Ltd",
  "county": "Surrey",
  "digital_confidence_score": 0.84,
  "digital_strength": "High Authority",
  "county_rank": 1,
  "last_updated": "2024-05-13"
}

2. Retrieve County Leaderboard

GET /v1/leaderboard/:county

Returns a list of the Top 20 companies within a specific geographic county, sorted by their Digital Confidence Score.

Parameter Type Required Description
county string Yes The slugified name of the county (e.g., surrey, kent, berkshire).

Scoring Taxonomy

The digital_confidence_score (DCS) returned by the API is a float between 0.00 and 1.00. It is calculated based on:

  1. Search Footprint: Volume of indexed signals across major search engines.
  2. Regulatory Velocity: Speed of iXBRL filing updates via Companies House.
  3. Structured Data: Implementation of Schema.org and JSON-LD entity markers.
  4. Domain Authority: Link equity and trust signals from UK-specific top-level domains.

Note: If you encounter a 403 Forbidden error, please ensure your IP address is whitelisted in your Account Settings. For technical support, contact [email protected].

Data Protection

The Digital Confidence Scores, rankings, and company profiles returned by this API are derived from publicly available sources, including company filings on Companies House. Where API responses include personal data (for example, the names of individual directors or officers disclosed in public filings), customers act as the data controller for any further processing of that data, and Archive Partners acts as a data processor under UK GDPR Article 28.

Customers integrating this API into products that process personal data of UK or EU individuals must:

  • Have a valid lawful basis for any further processing of personal data obtained via the API;
  • Sign a Data Processing Agreement (DPA) with Archive Partners before processing personal data at scale — contact our Data Protection Officer at [email protected] to arrange this;
  • Not use API data to make automated decisions with legal or similarly significant effects on individuals without appropriate safeguards.

For questions about data protection, retention, or to report a suspected data breach involving the API, contact [email protected].