v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Talent

Upload a Document from Request Body

Uploads a document provided in the request body to the profile page of the specified talent record. Uploaded document displays on the Documents tab of the talent profile page.

post/v1/talent/{talentId}/upload-document-from-body

Path parameters

talentIdstring required

The identifier for the talent for whom the document is being uploaded.

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.

Request body

idinteger

The identifier for the talent document.

talentIdinteger required

The identifier for the talent.

fileNamestring

The encrypted name of the file with extension that is generated by Avionté.

documentTitlestring required

The title of the document with extension. Valid file extensions are: 'txt', 'doc', 'docx', 'pdf', 'xls', 'xlsx', 'png', 'jpg', 'jpeg'.

documentDatestring date-time

The date when the document was uploaded. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

documentTypestring

The type of the BOLD document.

uploadedByinteger

The ID of the user who uploaded the document.

isPrivateboolean

An indication of whether the document is private or not.

isSharedboolean

An indication of whether the document is shared or not.

expiryDatestring date-time

The expiration date of the document. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.

documentTypeIdinteger

The identifier for the BOLD document type.

employerIdinteger

The identifier for the employer.

isVisibleboolean

An indication of whether the document is visible or not.

documentContentstring byte required

The contents of talent document as a Base-64 Encoded string.

Example request

{
  "id": 19424,
  "talentId": 138949,
  "fileName": "5jBlQJ8WSqJ67dNSMxLBDy2f.pdf",
  "documentTitle": "John Doe Resume.docx",
  "documentType": "Resume",
  "uploadedBy": 183744,
  "isShared": true,
  "documentTypeId": 59245,
  "employerId": 3928,
  "isVisible": true
}

Response

The document that was successfully uploaded.