Guidance

Record a grade API

For end-point assessment organisations to record assessment grades for apprenticeship standards using our API

Overview

The Record a grade Application Programming Interface (API) lets end-point assessment organisations (EPAOs) record the outcome of single or multiple assessments and request certificates for government funded apprenticeship Standards. EPAOs can record both pass and fail grades.

EPAOs can use the API to:

  • record a grade and request a single certificate
  • record grades and request multiple certificates
  • check if a certificate exists
  • delete a certificate before it is submitted

You can share the ESFA developer hub page with your developers or technical team.

Getting started

To test your application in the sandbox:

  • create an account on ESFA developer hub using an email address
  • subscribe to the Assessor service API (sandbox)
  • develop your application and test with the API on the developer sandbox
  • find sample programme and usage scenarios for Assessor service on GitHub

Get ready to go live

You will need to:

  • sign in to the Apprentice assessment service and enable your API subscription key from the dashboard

  • use your subscription key to integrate your application with our API

Published 21 August 2019