Integration-Ready

Developer API

A documented REST API for e-portfolio and MIS platforms to consume assessment results. Your platform is the client: an organisation admin generates an Access Key ID and Secret Access Key inside Digital Skills Assessment and pastes them into your platform’s integration settings. No OAuth2, no partnership agreement, no sales call.

OpenAPI 3.1 specification Request sandbox access

What the API gives you

Incremental results polling — GET /api/v1/assessments with an updated-at since cursor, cursor pagination with a next link, and ETag/304 for cheap per-minute polling.
Funding-ready fields, first-class — every result carries rqf_level (placement within the RQF level descriptors, as the ASF funding rules require) and below_level_1 (the digital entitlement eligibility gate).
The evidence artefact — GET /api/v1/assessments/{id}/report.pdf, with a SHA-256 integrity hash stored at first generation.
Learner provisioning — POST /api/v1/learners creates an assessment invitation from your platform.
Signed webhooks — push delivery of completed results, HMAC-SHA256 signed, deduplicable by delivery ID, retried with backoff and dead-lettered visibly.

Security

Secrets are shown once and stored hashed; multiple active keys allow zero-downtime rotation
Requests are scoped to one organisation; cross-tenant access returns 404, never 403
Per-key rate limiting (300 requests/minute) with 429 + Retry-After
Every call is audit-logged — the security trail and the funding-audit trail in one place
No PII in URLs; National Insurance numbers are not stored and never returned

Quick start

Generate a key pair in Organisation → Data & API, then:

Test the connection

curl https://www.digitalskillsassessment.co.uk/api/v1/health \
  -H "X-Access-Key-Id: dsa_ak_..." \
  -H "X-Secret-Access-Key: dsa_sk_..."

Poll for new results (incremental)

curl "https://www.digitalskillsassessment.co.uk/api/v1/assessments?since=2026-08-01T00:00:00Z&limit=100" \
  -H "X-Access-Key-Id: dsa_ak_..." \
  -H "X-Secret-Access-Key: dsa_sk_..." \
  -H 'If-None-Match: W/"<etag-from-last-poll>"'

Fetch the evidence PDF

curl -O "https://www.digitalskillsassessment.co.uk/api/v1/assessments/<id>/report.pdf" \
  -H "X-Access-Key-Id: dsa_ak_..." \
  -H "X-Secret-Access-Key: dsa_sk_..."

curl -X POST https://www.digitalskillsassessment.co.uk/api/v1/webhooks \
  -H "X-Access-Key-Id: dsa_ak_..." \
  -H "X-Secret-Access-Key: dsa_sk_..." \
  -H "Content-Type: application/json" \
  -d '{"url": "https://your-platform.example/dsa-webhook"}'

Building a native integration tile for your platform? The full contract is in the OpenAPI specification, and we provide a sandbox with seeded learners and results so you can scope the build without a meeting. Email admin@digitalskillsassessment.co.uk.