AVavionte
Talent

Upload a Document

Uploads a document 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

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/talent/{talentId}/upload-document
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

talentIdstring required

The identifier for the talent.

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

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 multipart/form-data

Idinteger

The identifier for the talent document that will be generated by Avionté.

TalentIdinteger

The identifier for the talent.

FileNamestring

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

FileContentstring binary

The content of the file to be uploaded. It will be populated using the content of the attached file. Valid file extensions are: 'txt', 'doc', 'docx', 'pdf', 'xls', 'xlsx', 'png', 'jpg', 'jpeg'.

DocumentTitlestring

The title of the document taken from the attached file.

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 uploading 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

The contents of the talent document as a Base-64 encoded string returned after file upload.

filestring binary required

The file to upload.

Example request

{
  "Id": 28925,
  "TalentId": 1328925,
  "FileName": "5jBlQJ8WSqJ67dNSMxLBDy2f.docx",
  "DocumentTitle": "John Doe Resume.docx",
  "DocumentType": "Resume",
  "UploadedBy": 123948,
  "IsShared": true,
  "DocumentTypeId": 59245,
  "EmployerId": 234,
  "IsVisible": true
}

Response

The talent document that was successfully uploaded.

idinteger

The identifier for the talent document.

talentIdinteger

The identifier for the talent.

fileNamestring

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

fileContentstring binary

The content of the file to be uploaded. It will be populated using the content of the attached file. Valid file extensions are: 'txt', 'doc', 'docx', 'pdf', 'xls', 'xlsx', 'png', 'jpg', 'jpeg'.

documentTitlestring

The title of the document.

documentDatestring date-time

The date when the document was uploaded. 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.

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

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

Example response

{
  "id": 28925,
  "talentId": 1328925,
  "fileName": "5jBlQJ8WSqJ67dNSMxLBDy2f.docx",
  "documentTitle": "John Doe Resume.docx",
  "documentType": "Resume",
  "uploadedBy": 123948,
  "isShared": true,
  "documentTypeId": 59245,
  "employerId": 234,
  "isVisible": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.