Skip to main content
POST
/
organizations
/
{organization_id}
/
employees
/
{employee_id}
/
documents
/
confirm
Confirm upload completion
curl --request POST \
  --url https://preview.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/documents/confirm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentId": "<string>"
}
'
{
  "id": "<string>",
  "employeeId": "<string>",
  "orgId": "<string>",
  "documentName": "<string>",
  "gcsBucket": "<string>",
  "gcsPath": "<string>",
  "mimeType": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "fileSizeBytes": 123,
  "documentDate": "2023-12-25",
  "templateId": 123,
  "createdBy": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

​
organization_id
required
​
employee_id
required

Body

application/json

Request schema for confirming upload completion.

​
documentId
required

Document ID to confirm

Response

Successful Response

Response schema for document information.

​
id
string
required

Document ID

​
employeeId
string | null
required

Employee ID

​
orgId
string
required

Employee ID

​
documentType
enum<string>
required
Available options:
payslip,
contract,
work_permit,
id_document,
proof_of_address,
org_logo,
uk_bacs_file,
uk_bacs_file_csv,
other
​
documentName
string
required

User-friendly document name

​
gcsBucket
string
required

GCS bucket name

​
gcsPath
string
required

GCS path

​
mimeType
string
required
​
status
enum<string>
required
Available options:
active,
archived,
deleted,
pending_upload
​
createdAt
string<date-time>
required

Creation timestamp

​
fileSizeBytes
integer | null

File size in bytes

​
documentDate
string<date> | null

Document date/period

​
templateId
integer | null

Template ID (if generated)

​
createdBy
string | null

User who created the document

​
updatedAt
string<date-time> | null

Last update timestamp