Updating Credentials via API

Credentials in Xemplo represent qualifications, licences, or other accreditations provided by a worker in response to a request. Credential requests are typically triggered automatically based on:

• A worker’s position - when a worker is onboarded to a position, moved to another position, or their current position is updated, credential requests for any credentials that the worker does not currently have (i.e., they haven't previously provided it or a previous submission has expired) will be sent by Xemplo automatically, or;
• Company-level requirements - for example, mandatory credentials applied to all workers.

To maintain data integrity, credentials cannot be manually created or uploaded via API. Only existing credential records in Requested or Submitted status can be updated via API.

When to Use the API

Use the API to update credentials when:

• Integrating with external compliance or credential management systems
• Syncing verified credential data from another platform
• Updating one or many credentials programmatically

Before you start

1. Review the Credential API documentation
   Review the technical documentation for credential updates via API here: https://developer.xemplo.com/reference/getcredentialasync 
2. Create any credential records to be updated in Xemplo
   Worker credential records to be updated must already exist. The API only supports updates to credentials that have been requested and created within Xemplo already.
3. Authorised access only
   Updates require a valid API key and appropriate permissions. Contact Customer Support for an API key and access instructions. 

Updating credentials via API

The process is the same whether updating a single credential or multiple credentials.

1. Identify the Credential

Retrieve the credential ID associated with the worker and request using the List Worker Credentials API: https://developer.xemplo.com/reference/getcredentialsforworkerasync 

2. Prepare the Update Payload

There are three unique APIs that can be used to update worker credential information:

1. Update credential - updates credential metadata like status and expiry date.

2. Upload attachments - credentials can have up to two attachments (typically a front and back image or file):

   1. Use the Upload Worker Credentials (front) to upload your first attachment.

   2. Use the Upload Worker Credentials (back) to upload your first attachment.

3. Submit the Request

Send an authenticated request to the credentials endpoint using your API key.

4. Handle the Response

Confirm the update was successful and handle any validation errors returned by the API.

Updating Multiple Credentials

To update multiple credentials, repeat the same API request for each credential record.

This can be done by:

• Iterating through a list of credential IDs in your integration
• Scheduling or batching requests within your external system

There is no separate bulk endpoint — multiple updates are performed as a series of individual requests.

Permissions and Security

• API access is restricted to authorised users
• API keys must be stored securely
• All updates are validated against system rules

Limitations

• Credentials cannot be created via API
• Only existing credential records can be updated
• Invalid or incomplete data will be rejected