Jump to Content
API Reference
v1.0
v2.0
Log In
API Reference
Log In
v1.0
API Reference
Getting Started & API key
All
Pages
Start typing to search…
JUMP TO
General Information
Getting Started & API key
Download OpenAPI specification file
Detailed Filed descriptions and additional documentation [historic]
Request more endpoints
Credentially REST API
Profile Fields
Load organization's profile fields metadata
get
Load employee profile all fields' values in organisation
get
Update an employee profile field's value
put
Employee
/api/v1/employees/{employeePublicId}
get
/api/employees/{employeePublicId}/extended
put
/api/organisations/{organisationId}/employees/invite
post
/api/organisations/{organisationId}/employees/import
post
/api/v2/employees/{employeePublicId}/contact
get
/api/v1/employees
get
/api/employees/{employeePublicId}/basic
put
/api/employees/{employeePublicId}/registration-data
patch
Documents
/api/v1/employees/{employeePublicId}/documents/files/process
post
Upload employee document (async, with ocr).
post
/api/employees/{employeePublicId}/documents
get
/api/employees/{employeePublicId}/documents/{documentPublicId}
get
/api/employees/{employeePublicId}/documents/details
get
References
/api/employees/{employeePublicId}/references/{referencePublicId}/file
get
/api/employees/{employeePublicId}/references/{referencePublicId}/file/preview
get
/api/v1/employees/{employeePublicId}/references
get
Questionnaires
/api/v1/employees/{employeePublicId}/questionnaires
get
organisation-dbs-resource
/api/v2/organisations/{organisationId}/employees/{employeePublicId}/dbs
get
/api/v2/organisations/{organisationId}/employees/{employeePublicId}/dbs/{dbsCheckId}
get
NHS England GP Performers List
/api/v2/employees/{employeePublicId}/performer
get
Compliance Packages
/api/v1/organisations/{organisationId}/employees/{employeePublicId}/compliance-packages
get
Document Types
/api/v1/document-types
get
Organisaton Roles
/api/organisations/{organisationId}/roles
get
Right To Work
/api/organisations/{organisationId}/employees/{employeePublicId}/right-to-work
get
Powered by
Getting Started & API key
Ask AI
This page will help you get started with our API.
