POST
Confirm logo upload

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required

Body

application/json

Request schema for confirming upload completion.

document_id
string
required

Document ID to confirm

Response

Successful Response

Response schema for document information.

id
string
required

Document ID

employee_id
string | null
required

Employee ID

org_id
string
required

Employee ID

document_type
enum<string>
required
Available options:
PAYSLIP,
CONTRACT,
WORK_PERMIT,
ID_DOCUMENT,
PROOF_OF_ADDRESS,
ORG_LOGO,
UK_BACS_FILE,
UK_BACS_FILE_CSV,
REPORT,
P60,
P45,
NEST_FILE,
OTHER
document_name
string
required

User-friendly document name

gcs_bucket
string
required

GCS bucket name

gcs_path
string
required

GCS path

mime_type
string
required
status
enum<string>
required

Document status

Available options:
ACTIVE,
ARCHIVED,
DELETED,
PENDING_UPLOAD
created_at
string<date-time>
required

Creation timestamp

file_size_bytes
integer | null

File size in bytes

document_date
string<date> | null

Document date/period

template_id
integer | null

Template ID (if generated)

created_by
string | null

User who created the document

updated_at
string<date-time> | null

Last update timestamp