Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Get Talent Certificate Documents

Returns a list of documents that have been associated to a talent's certificate record.

get/v1/talent/certificate/{certificateId}/documents

Path parameters

certificateIdstring required

The identifier for the talent certificate for which documents are being retrieved.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

A list of documents associated with the talent certificate.

talentCertificateUploadIdinteger

The identifier of the talent's certificate document upload.

talentCertificateIDinteger

The identifier of the talent's certificate.

fileNamestring

The title of the document with the file extension.

uploadedByinteger

The identifier of the user who uploaded the document.

uploadedDateUtcstring date-time

The date and UTC time when the document was uploaded. UTC timestamp in ISO 8601 format (e.g., 2025-06-09T14:30:00Z).

expirationDateUtcstring date-time

The expiration date and UTC time of the document. UTC timestamp in ISO 8601 format (e.g., 2025-06-09T14:30:00Z).

fileContentsstring byte

The Base-64 encoded contents of the document.

Example response

[
  {
    "talentCertificateUploadId": 284,
    "talentCertificateID": 2399,
    "fileName": "Example Certificate.pdf",
    "uploadedBy": 18925
  }
]