API reference
My documents
A person's own documents (Me keys).
14 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.
List my documents#
POST/v1/documents/me.listRead
Lists documents shared with you, newest first. scope mine (default): your own documents (shared with you by HR, and the ones you added "From me"); company: company documents for you (handbook, policies…); person_id: documents of someone who reports to you that HR shared with their managers. Also says whether you can add your own documents this month (self_upload).
- Who can call it
- Me key anyone
- MCP tool
documents_me_liston My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
scope"mine" | "company"person_idstring
Returns
documentsobject[]required19 fields
idstringrequiredtitlestringrequiredcategorystringrequiredsubjectobjectrequired3 fields (one of several shapes)
Option 1
kind"person"requiredpersonobject | nullrequired2 fields
idstringrequirednamestringrequired
Option 2
kind"company"required
visibilitystring (enum)requiredOne of:
hr,hr_person,hr_person_manager,everyone,managers,hr,accountant.uploaded_by"hr" | "self"requiredself: the person added it themself ("From me", or a custom field they fill in).
fieldobject | nullrequiredA custom file field's file (
org_fields_list): its visibility follows the field's tier; replace or remove it through the field.2 fields
keystringrequiredlabelstringrequired
expires_onstring | nullrequirednotesstring | nullrequirednull when you only see metadata.
fileobjectrequired4 fields
namestring | nullrequiredThe original file name; null when you only see metadata.
sizeintegerrequiredcontent_typestringrequiredpreviewablebooleanrequiredThe web app can show it (PDF, PNG, JPEG, WebP).
access"full" | "metadata"requiredmetadata: title, category, date and size only (no notes, no download): API keys and AI assistants never get the contents of other people's documents.
signed_fromobject | nullrequiredA signed copy or signature audit trail the e-signature tool handed back: the original document. null for other documents.
2 fields
document_idstringrequiredkind"signed" | "audit_trail"required
signatureobject | nullThe latest signature request (lists only): status, level and how many have signed.
6 fields
idstringrequiredstatusstring (enum)requiredOne of:
queued,sending,ongoing,done,declined,expired,canceled,failed.level"simple" | "advanced" | "qualified"requiredsignedintegerrequiredtotalintegerrequiredyour_turnbooleanrequiredYou are the signer the e-signature tool is waiting for (check your email from it).
generated_fromobject | nullMade from a document template: which one, its version, language and style (
documents_templates_get). null for uploaded documents.4 fields
template_idstringrequiredversionintegerrequiredlanguagestringrequiredstyle"international" | "continental"requiredThe document style it was made in (international or continental); null for documents made before styles existed.
draftobject | nullA draft only HR sees until it is sent (
documents_prepared_decide): the prepared document, and who will see it once sent. null otherwise.2 fields
prepared_idstringrequiredvisibility"hr" | "hr_person" | "hr_person_manager"required
deliveryobject | nullProof of delivery of a written statement or change notice: when it was sent, first opened and its receipt confirmed (or handed over on paper). null for other documents.
5 fields
method"electronic" | "print"requiredsent_atstringrequiredopened_atstring | nullrequiredacknowledged_atstring | nullrequiredhanded_over_onstring | nullrequired
status"pending" | "ready"requiredcreated_atstringrequiredupdated_atstringrequired
categoriesstring[]requiredself_uploadobject | nullrequirednull when your login is not linked to a person.
4 fields
enabledbooleanrequiredYour company lets people add their own documents ("From me").
files_leftintegerrequiredFiles you can still add this month.
bytes_leftintegerrequiredBytes you can still add this month.
max_file_bytesintegerrequiredThe largest file allowed.
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"scope":"company"}'const res = await fetch('https://api.bizisy.com/v1/documents/me.list', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"scope": "company"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.list",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"scope": "company",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"documents": [
{
"id": "d1",
"title": "Contract 2026",
"category": "Contract",
"subject": {
"kind": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
}
},
"visibility": "hr_person",
"uploaded_by": "hr",
"field": null,
"expires_on": "2027-01-31",
"notes": "Signed copy",
"file": {
"name": "Contract 2026.pdf",
"size": 182000,
"content_type": "application/pdf",
"previewable": true
},
"access": "full",
"status": "ready",
"created_at": "2026-10-05T10:00:00.000Z",
"updated_at": "2026-10-05T10:00:00.000Z",
"signed_from": null,
"signature": {
"id": "sig_1",
"status": "ongoing",
"level": "advanced",
"signed": 1,
"total": 2,
"your_turn": false
}
},
{
"id": "d4",
"title": "Contract 2026",
"category": "Contract",
"subject": {
"kind": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
}
},
"visibility": "hr_person",
"uploaded_by": "self",
"field": null,
"expires_on": "2027-01-31",
"notes": "Signed copy",
"file": {
"name": "Contract 2026.pdf",
"size": 182000,
"content_type": "application/pdf",
"previewable": true
},
"access": "full",
"status": "ready",
"created_at": "2026-10-05T10:00:00.000Z",
"updated_at": "2026-10-05T10:00:00.000Z",
"signed_from": null,
"signature": {
"id": "sig_1",
"status": "ongoing",
"level": "advanced",
"signed": 1,
"total": 2,
"your_turn": false
}
}
],
"categories": [
"Contract",
"Offer letter",
"Addendum",
"Payslip",
"Certificate",
"ID",
"Policy",
"Handbook",
"Other"
],
"self_upload": {
"enabled": true,
"files_left": 19,
"bytes_left": 99000000,
"max_file_bytes": 25000000
}
}
}Download a document#
POST/v1/documents/me.downloadWrite
Returns a short-lived link (5 minutes) that downloads a document shared with you as a file. Downloading a person document is recorded in Activity. The link is never stored; ask again for a new one.
- Who can call it
- Me key anyone
- MCP tool
documents_me_downloadon My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
document_idstringrequired
Returns
7 fields
urlstring | nullrequiredSigned URL valid for 5 minutes, downloads as an attachment. null on a dry run. Never store or share it.
expires_atstring | nullrequiredfile_namestringrequiredcontent_typestringrequiredsizeintegerrequiredcategorystringrequiredperson_idstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.download \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"document_id":"d1"}'const res = await fetch('https://api.bizisy.com/v1/documents/me.download', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"document_id": "d1"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.download",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"document_id": "d1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"url": "https://storage.googleapis.com/b/orgs/o1/files/d1?X-Goog-Signature=x",
"expires_at": "2026-10-05T10:05:00.000Z",
"file_name": "Contract 2026.pdf",
"content_type": "application/pdf",
"size": 182000,
"category": "Contract",
"person_id": "p1"
}
}Add my own document#
POST/v1/documents/me.upload.startWrite
Adds a document to your "From me" folder in two calls and one upload (like documents_upload_start): this call with the category, optional title and expiry date and the file's name, size, content_type and sha256; PUT the bytes to the signed URL within 15 minutes with exactly the returned headers; then documents_me_upload_finish. Only you and your HR team (owners, admins, HR) see it; HR is emailed when it arrives. Limits: the largest file, and per month a number of files and MB set by your company (see documents_me_list self_upload).
- Who can call it
- Me key anyone
- MCP tool
documents_me_upload_starton My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
categorystringDefault Other.
1–40 characters.
titlestringUp to 200 characters.
expires_onstring | nullPattern
^\d{4}-\d{2}-\d{2}$.fileobjectrequired4 fields
namestringrequiredThe file name, e.g. "Contract 2026.pdf" (kept as metadata only).
1–500 characters.
sizeintegerrequiredBytes. Must equal what is uploaded.
At least 0.
content_typestringrequiredapplication/pdf, image/png, image/jpeg, image/webp, image/heic, DOCX, XLSX, ODT or ODS MIME type, text/plain or text/csv. Must match the bytes.
1–200 characters.
sha256stringrequiredLowercase hex SHA-256 of the file; checked against the upload.
Pattern
^[0-9a-f]{64}$.
Returns
documentobjectrequired19 fields
idstringrequiredtitlestringrequiredcategorystringrequiredsubjectobjectrequired3 fields (one of several shapes)
Option 1
kind"person"requiredpersonobject | nullrequired2 fields
idstringrequirednamestringrequired
Option 2
kind"company"required
visibilitystring (enum)requiredOne of:
hr,hr_person,hr_person_manager,everyone,managers,hr,accountant.uploaded_by"hr" | "self"requiredself: the person added it themself ("From me", or a custom field they fill in).
fieldobject | nullrequiredA custom file field's file (
org_fields_list): its visibility follows the field's tier; replace or remove it through the field.2 fields
keystringrequiredlabelstringrequired
expires_onstring | nullrequirednotesstring | nullrequirednull when you only see metadata.
fileobjectrequired4 fields
namestring | nullrequiredThe original file name; null when you only see metadata.
sizeintegerrequiredcontent_typestringrequiredpreviewablebooleanrequiredThe web app can show it (PDF, PNG, JPEG, WebP).
access"full" | "metadata"requiredmetadata: title, category, date and size only (no notes, no download): API keys and AI assistants never get the contents of other people's documents.
signed_fromobject | nullrequiredA signed copy or signature audit trail the e-signature tool handed back: the original document. null for other documents.
2 fields
document_idstringrequiredkind"signed" | "audit_trail"required
signatureobject | nullThe latest signature request (lists only): status, level and how many have signed.
6 fields
idstringrequiredstatusstring (enum)requiredOne of:
queued,sending,ongoing,done,declined,expired,canceled,failed.level"simple" | "advanced" | "qualified"requiredsignedintegerrequiredtotalintegerrequiredyour_turnbooleanrequiredYou are the signer the e-signature tool is waiting for (check your email from it).
generated_fromobject | nullMade from a document template: which one, its version, language and style (
documents_templates_get). null for uploaded documents.4 fields
template_idstringrequiredversionintegerrequiredlanguagestringrequiredstyle"international" | "continental"requiredThe document style it was made in (international or continental); null for documents made before styles existed.
draftobject | nullA draft only HR sees until it is sent (
documents_prepared_decide): the prepared document, and who will see it once sent. null otherwise.2 fields
prepared_idstringrequiredvisibility"hr" | "hr_person" | "hr_person_manager"required
deliveryobject | nullProof of delivery of a written statement or change notice: when it was sent, first opened and its receipt confirmed (or handed over on paper). null for other documents.
5 fields
method"electronic" | "print"requiredsent_atstringrequiredopened_atstring | nullrequiredacknowledged_atstring | nullrequiredhanded_over_onstring | nullrequired
status"pending" | "ready"requiredcreated_atstringrequiredupdated_atstringrequired
uploadobject | nullrequired4 fields
urlstringrequiredShort-lived signed URL (15 minutes). Never share it.
method"PUT"requiredheadersobjectrequiredSend exactly these headers (they include the exact file size: any other size is refused).
resumablefalserequiredAlways false: upload the whole file in one PUT.
upload_expires_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.upload.start \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"category": "Certificate",
"title": "Medical certificate",
"expires_on": "2026-12-31",
"file": {
"name": "Contract 2026.pdf",
"size": 182000,
"content_type": "application/pdf",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
}'const res = await fetch('https://api.bizisy.com/v1/documents/me.upload.start', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"category": "Certificate",
"title": "Medical certificate",
"expires_on": "2026-12-31",
"file": {
"name": "Contract 2026.pdf",
"size": 182000,
"content_type": "application/pdf",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.upload.start",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"category": "Certificate",
"title": "Medical certificate",
"expires_on": "2026-12-31",
"file": {
"name": "Contract 2026.pdf",
"size": 182000,
"content_type": "application/pdf",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
},
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"document": {
"id": "d1",
"title": "Contract 2026",
"category": "Contract",
"subject": {
"kind": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
}
},
"visibility": "hr_person",
"uploaded_by": "hr",
"field": null,
"expires_on": "2027-01-31",
"notes": "Signed copy",
"file": {
"name": "Contract 2026.pdf",
"size": 182000,
"content_type": "application/pdf",
"previewable": true
},
"access": "full",
"status": "pending",
"created_at": "2026-10-05T10:00:00.000Z",
"updated_at": "2026-10-05T10:00:00.000Z",
"signed_from": null,
"signature": {
"id": "sig_1",
"status": "ongoing",
"level": "advanced",
"signed": 1,
"total": 2,
"your_turn": false
}
},
"upload": {
"url": "https://storage.googleapis.com/b/uploads/o1/d1?X-Goog-Signature=x",
"method": "PUT",
"headers": {
"content-type": "application/pdf",
"x-goog-content-length-range": "182000,182000",
"x-goog-if-generation-match": "0"
},
"resumable": false
},
"upload_expires_at": "2026-10-05T10:15:00.000Z"
}
}Finish adding my document#
POST/v1/documents/me.upload.finishWrite
Finishes your "From me" upload after the bytes were uploaded: Bizisy checks the file (size, SHA-256, type from the bytes) and your monthly limits, then it appears in My documents and your HR team is emailed (the email never includes the file name). Finishing twice returns the document.
- Who can call it
- Me key anyone
- MCP tool
documents_me_upload_finishon My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
document_idstringrequired
Returns
19 fields
idstringrequiredtitlestringrequiredcategorystringrequiredsubjectobjectrequired3 fields (one of several shapes)
Option 1
kind"person"requiredpersonobject | nullrequired2 fields
idstringrequirednamestringrequired
Option 2
kind"company"required
visibilitystring (enum)requiredOne of:
hr,hr_person,hr_person_manager,everyone,managers,hr,accountant.uploaded_by"hr" | "self"requiredself: the person added it themself ("From me", or a custom field they fill in).
fieldobject | nullrequiredA custom file field's file (
org_fields_list): its visibility follows the field's tier; replace or remove it through the field.2 fields
keystringrequiredlabelstringrequired
expires_onstring | nullrequirednotesstring | nullrequirednull when you only see metadata.
fileobjectrequired4 fields
namestring | nullrequiredThe original file name; null when you only see metadata.
sizeintegerrequiredcontent_typestringrequiredpreviewablebooleanrequiredThe web app can show it (PDF, PNG, JPEG, WebP).
access"full" | "metadata"requiredmetadata: title, category, date and size only (no notes, no download): API keys and AI assistants never get the contents of other people's documents.
signed_fromobject | nullrequiredA signed copy or signature audit trail the e-signature tool handed back: the original document. null for other documents.
2 fields
document_idstringrequiredkind"signed" | "audit_trail"required
signatureobject | nullThe latest signature request (lists only): status, level and how many have signed.
6 fields
idstringrequiredstatusstring (enum)requiredOne of:
queued,sending,ongoing,done,declined,expired,canceled,failed.level"simple" | "advanced" | "qualified"requiredsignedintegerrequiredtotalintegerrequiredyour_turnbooleanrequiredYou are the signer the e-signature tool is waiting for (check your email from it).
generated_fromobject | nullMade from a document template: which one, its version, language and style (
documents_templates_get). null for uploaded documents.4 fields
template_idstringrequiredversionintegerrequiredlanguagestringrequiredstyle"international" | "continental"requiredThe document style it was made in (international or continental); null for documents made before styles existed.
draftobject | nullA draft only HR sees until it is sent (
documents_prepared_decide): the prepared document, and who will see it once sent. null otherwise.2 fields
prepared_idstringrequiredvisibility"hr" | "hr_person" | "hr_person_manager"required
deliveryobject | nullProof of delivery of a written statement or change notice: when it was sent, first opened and its receipt confirmed (or handed over on paper). null for other documents.
5 fields
method"electronic" | "print"requiredsent_atstringrequiredopened_atstring | nullrequiredacknowledged_atstring | nullrequiredhanded_over_onstring | nullrequired
status"pending" | "ready"requiredcreated_atstringrequiredupdated_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.upload.finish \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"document_id":"d1"}'const res = await fetch('https://api.bizisy.com/v1/documents/me.upload.finish', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"document_id": "d1"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.upload.finish",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"document_id": "d1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "d1",
"title": "Contract 2026",
"category": "Contract",
"subject": {
"kind": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
}
},
"visibility": "hr_person",
"uploaded_by": "hr",
"field": null,
"expires_on": "2027-01-31",
"notes": "Signed copy",
"file": {
"name": "Contract 2026.pdf",
"size": 182000,
"content_type": "application/pdf",
"previewable": true
},
"access": "full",
"status": "ready",
"created_at": "2026-10-05T10:00:00.000Z",
"updated_at": "2026-10-05T10:00:00.000Z",
"signed_from": null,
"signature": {
"id": "sig_1",
"status": "ongoing",
"level": "advanced",
"signed": 1,
"total": 2,
"your_turn": false
}
}
}Documents asked of me#
POST/v1/documents/me.requestsRead
The documents your HR team asked you to add (open requests): category, their note and due date. Add one with documents_me_upload_start in that category; the request closes when it is added.
- Who can call it
- Me key anyone
- MCP tool
documents_me_requestson My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
requestsobject[]required6 fields
idstringrequiredcategorystringrequirednotestring | nullrequireddue_onstring | nullrequiredoverduebooleanrequiredOpen and past due_on.
created_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.requests \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/documents/me.requests', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.requests",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"requests": [
{
"id": "dr1",
"category": "ID",
"note": "The new card, both sides",
"due_on": "2026-10-31",
"overdue": false,
"created_at": "2026-10-05T10:00:00.000Z"
}
]
}
}Accept a document#
POST/v1/documents/me.acceptWrite
Accepts a document HR sent you for Bizisy click-to-accept (documents_me_signatures lists them: provider bizisy_accept, your_turn true): type your full name as Bizisy has it (accents, capitals and middle names don't matter) and confirm (accept true). This is a simple electronic signature (eIDAS art. 25): Bizisy adds an acceptance record page to the PDF (the name you typed, the time, the document's SHA-256 fingerprint, a hash of your network address and your browser) and keeps it as the signed copy in your documents, which HR sees too. Refused after the deadline, when HR cancelled it, or when the document changed since it was sent. Only in the app, signed in yourself (never through an API key or AI assistant).
- Web app only
- Refused for API keys and connected apps. Accepting a document is done by the person in the app.
- MCP tool
documents_me_accepton My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
signature_idstringrequiredfull_namestringrequired1–200 characters.
accepttruerequired
Returns
signature_idstringrequireddocument_idstringrequiredsigned_document_idstring | nullrequiredaccepted_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.accept \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"signature_id":"sig_9","full_name":"Ana Ferreira","accept":true}'const res = await fetch('https://api.bizisy.com/v1/documents/me.accept', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"signature_id": "sig_9",
"full_name": "Ana Ferreira",
"accept": true
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.accept",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"signature_id": "sig_9",
"full_name": "Ana Ferreira",
"accept": True,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"signature_id": "sig_9",
"document_id": "d20",
"signed_document_id": "sig_9-signed",
"accepted_at": "2026-10-19T10:00:00.000Z"
}
}My consent to electronic documents#
POST/v1/documents/me.consent.getRead
Whether you agreed to receive your employment documents (such as your written statement of working conditions) electronically in Bizisy, and when.
- Who can call it
- Me key anyone
- MCP tool
documents_me_consent_geton My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
person_idstringrequiredelectronicbooleanrequiredatstring | nullrequiredby"self" | "hr"required
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.consent.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/documents/me.consent.get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.consent.get",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"person_id": "p1",
"electronic": true,
"at": "2026-10-20T09:00:00.000Z",
"by": "self"
}
}Agree to electronic documents#
POST/v1/documents/me.consent.setWrite
Agree (electronic true) or stop agreeing (false) to receive your employment documents electronically in Bizisy instead of on paper. In the Netherlands your employer needs this before sending your written statement electronically. Only in the app, signed in yourself.
- Web app only
- Refused for API keys and connected apps. The person agrees in the app, signed in themselves.
- MCP tool
documents_me_consent_seton My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
electronicbooleanrequired
Returns
person_idstringrequiredelectronicbooleanrequiredatstring | nullrequiredby"self" | "hr"required
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.consent.set \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"electronic":false}'const res = await fetch('https://api.bizisy.com/v1/documents/me.consent.set', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"electronic": false
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.consent.set",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"electronic": False,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"person_id": "p1",
"electronic": false,
"at": "2026-10-20T09:00:00.000Z",
"by": "self"
}
}Ask for my written statement#
POST/v1/documents/me.statement.requestWrite
Asks your employer for the written statement of your working conditions (Directive (EU) 2019/1152; in Spain within 30 working days). Depending on your company it is prepared for HR to send, or sent to you at once (then it is in your documents and you are emailed). Asking again while one is on its way changes nothing; at most 5 a day. Only in the app, signed in yourself.
- Web app only
- Refused for API keys and connected apps. The person asks in the app, signed in themselves.
- MCP tool
documents_me_statement_requeston My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
No input: send {}.
Returns
status"prepared" | "sent"requireddue_onstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.statement.request \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/documents/me.statement.request', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.statement.request",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"status": "prepared",
"due_on": "2026-11-20"
}
}My policies#
POST/v1/documents/me.policies.listRead
The company policies you are asked to read and acknowledge (to_acknowledge) and those you acknowledged, with their version. A new version asks you again and shows what changed since the one you acknowledged.
- Who can call it
- Me key anyone
- MCP tool
documents_me_policies_liston My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
policiesobject[]required8 fields
idstringrequirednamestringrequiredversionintegerrequiredpublished_atstringrequiredstatus"to_acknowledge" | "acknowledged"requiredacknowledged_atstring | nullrequiredacknowledged_beforeinteger | nullrequiredThe last earlier version you acknowledged (then this version shows what changed), or null.
due_onstringrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.policies.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/documents/me.policies.list', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.policies.list",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"policies": [
{
"id": "pol1",
"name": "Employee handbook",
"version": 2,
"published_at": "2026-10-20T09:00:00.000Z",
"status": "to_acknowledge",
"acknowledged_at": null,
"acknowledged_before": 1,
"due_on": "2026-11-03"
},
{
"id": "pol2",
"name": "IT policy",
"version": 1,
"published_at": "2026-10-20T09:00:00.000Z",
"status": "acknowledged",
"acknowledged_at": "2026-10-01T09:00:00.000Z",
"acknowledged_before": null,
"due_on": "2026-11-03"
}
]
}
}Read a policy#
POST/v1/documents/me.policies.getRead
A company policy you are asked about: its text (HTML) in your language when it has it (language, else the company's), and what changed since the version you acknowledged last (word by word), if any.
- Who can call it
- Me key anyone
- MCP tool
documents_me_policies_geton My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
policy_idstringrequiredlanguage"en" | "pt" | "es" | "fr" | "de" | "it"
Returns
policyobjectrequired8 fields
idstringrequirednamestringrequiredversionintegerrequiredpublished_atstringrequiredstatus"to_acknowledge" | "acknowledged"requiredacknowledged_atstring | nullrequiredacknowledged_beforeinteger | nullrequiredThe last earlier version you acknowledged (then this version shows what changed), or null.
due_onstringrequired
language"en" | "pt" | "es" | "fr" | "de" | "it"requiredlanguages"en" | "pt" | "es" | "fr" | "de" | "it"[]requiredThe languages this version is in (ask for one with language).
titlestringrequiredhtmlstringrequiredchangesobject | nullrequired4 fields
from_versionintegerrequiredaddedintegerrequiredremovedintegerrequiredsegmentsobject[]required2 fields
op"eq" | "add" | "del"requiredtextstringrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.policies.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"policy_id":"pol1","language":"pt"}'const res = await fetch('https://api.bizisy.com/v1/documents/me.policies.get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"policy_id": "pol1",
"language": "pt"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.policies.get",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"policy_id": "pol1",
"language": "pt",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"policy": {
"id": "pol1",
"name": "Employee handbook",
"version": 2,
"published_at": "2026-10-20T09:00:00.000Z",
"status": "to_acknowledge",
"acknowledged_at": null,
"acknowledged_before": 1,
"due_on": "2026-11-03"
},
"language": "pt",
"languages": [
"en",
"pt"
],
"title": "Employee handbook",
"html": "<!doctype html><html lang=\"en\"><body>…</body></html>",
"changes": {
"from_version": 1,
"added": 4,
"removed": 2,
"segments": [
{
"op": "eq",
"text": "Working hours are "
},
{
"op": "del",
"text": "9 to 5"
},
{
"op": "add",
"text": "9 to 6"
},
{
"op": "eq",
"text": "."
}
]
}
}
}Acknowledge a policy#
POST/v1/documents/me.policies.acknowledgeWrite
Confirms you have read the current version of a company policy: type your full name as Bizisy has it (accents, capitals and middle names don't matter) and confirm (read true). Bizisy keeps the name you typed, the time, the text's SHA-256 fingerprint, a hash of your network address and your browser, as a simple electronic signature (eIDAS art. 25). Only in the app, signed in yourself.
- Web app only
- Refused for API keys and connected apps. The person acknowledges a policy in the app, signed in themselves.
- MCP tool
documents_me_policies_acknowledgeon My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
policy_idstringrequiredversionintegerrequiredAt least 1.
full_namestringrequired1–200 characters.
language"en" | "pt" | "es" | "fr" | "de" | "it"readtruerequired
Returns
policy_idstringrequiredversionintegerrequiredacknowledged_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.policies.acknowledge \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"policy_id": "pol1",
"version": 2,
"full_name": "Ana Ferreira",
"language": "pt",
"read": true
}'const res = await fetch('https://api.bizisy.com/v1/documents/me.policies.acknowledge', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"policy_id": "pol1",
"version": 2,
"full_name": "Ana Ferreira",
"language": "pt",
"read": true
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.policies.acknowledge",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"policy_id": "pol1",
"version": 2,
"full_name": "Ana Ferreira",
"language": "pt",
"read": True,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"policy_id": "pol1",
"version": 2,
"acknowledged_at": "2026-10-21T09:00:00.000Z"
}
}What I can ask for#
POST/v1/documents/me.requests.getRead
What you can ask your employer for in My workspace → Documents → Ask for a document: your written statement, an employment declaration, a salary declaration (if your company allows it), each off, to HR or at once; how many you asked for today (at most 5); and what you asked for that HR has not sent yet. Former employees ask HR by email.
- Who can call it
- Me key anyone
- MCP tool
documents_me_requests_geton My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
9 fields
statement"off" | "review" | "instant"requiredYour written statement of working conditions: off (ask HR), review (HR sends it) or instant.
employment"off" | "review" | "instant"requiredA declaration that you work here (since when, as what): off, review or instant.
salary"off" | "review" | "instant"requiredA declaration of your employment and pay: off unless your company turned it on.
can_askbooleanrequiredfalse when you are not employed today (former employees ask HR by email) or reached today's limit.
why_not"not_employed" | "limit"requiredasked_todayintegerrequiredlimitintegerrequiredlanguages"en" | "pt" | "es" | "fr" | "de" | "it"[]requiredwaitingobject[]requiredWhat you asked for that HR has not sent yet.
3 fields
kind"statement" | "declaration"requiredvariant"employment" | "salary"requiredasked_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.requests.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/documents/me.requests.get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.requests.get",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"statement": "review",
"employment": "instant",
"salary": "off",
"can_ask": true,
"why_not": null,
"asked_today": 1,
"limit": 5,
"languages": [
"en",
"pt"
],
"waiting": [
{
"kind": "declaration",
"variant": "employment",
"asked_at": "2026-10-20T09:00:00.000Z"
}
]
}
}Ask for a declaration#
POST/v1/documents/me.declarations.requestWrite
Asks your employer for a declaration: employment (that you work here, since when and as what) or salary (with your pay; only if your company allows it), in language (default your company's). Depending on your company it is sent to you at once (then it is in your documents and you are emailed) or prepared for HR to send. Asking again while one is on its way changes nothing; at most 5 requests a day. Only people employed today; former employees ask HR by email. Only in the app, signed in yourself.
- Web app only
- Refused for API keys and connected apps. The person asks in the app, signed in themselves.
- MCP tool
documents_me_declarations_requeston My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
kind"employment" | "salary"requiredlanguage"en" | "pt" | "es" | "fr" | "de" | "it"
Returns
status"prepared" | "sent"requireddocument_idstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.declarations.request \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"kind":"salary","language":"en"}'const res = await fetch('https://api.bizisy.com/v1/documents/me.declarations.request', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"kind": "salary",
"language": "en"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/me.declarations.request",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"kind": "salary",
"language": "en",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"status": "sent",
"document_id": "d40"
}
}Something missing or wrong on this page? Write to hello@bizisy.com.