API reference
E-signature
Send a person's document for signature through the company's own e-signature tool (Yousign, DocuSign, Dropbox Sign, Signaturit or Skribble; simple, advanced or qualified, eIDAS), follow it, remind, cancel and try again; signature levels per category and the tool in use; what waits for your own signature (Me keys). The signed copy and audit trail come back as documents.
13 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.
Send a document for signature#
POST/v1/documents/signatures.sendWrite
Sends a person's document for e-signature through the company's own e-signature tool: Yousign (now Youtrust), DocuSign, Dropbox Sign, Signaturit or Skribble, the one chosen in Settings → Documents (else the one connected first; documents_signatures_levels_get says which and what it can do). Files: PDF everywhere, Word with Yousign and Dropbox Sign; up to 25 MB (20 MB with DocuSign). signers: 1–5 in signing order, each { role: person (the person the document is about), manager (their manager), me (you), other (with person_id) }. ordered (default true): each signs after the previous one. level: simple, advanced or qualified (eIDAS); default: the level Settings → Documents sets for the document's category (Contract and Addendum advanced, others simple). Each tool offers its own levels (Dropbox Sign: simple only) and a level it can't make is refused, never lowered. Some levels text the signer a code (Yousign advanced and qualified, DocuSign and Skribble advanced), so each signer then needs a phone number in international format (+…). With Signaturit signers sign one after the other. The person may sign only a document they can see (HR and the person, or also managers), their manager only one shared with managers. reminders (default every 2 days, up to 5 times; null: none), expires_on (default in 30 days, at most a year). The tool emails each signer when it is their turn; the signed copy and the audit trail come back as documents of the person. One open request per document, at most 200 open and 100 new a day per company. Owners, admins and HR (and custom roles with Documents at Edit, for the people they cover). method autenticacao_gov (companies in Portugal): signing outside Bizisy in Autenticação.gov with the Cartão de Cidadão or Chave Móvel Digital, always qualified, PDF only up to 20 MB, signers in any order unless ordered is true; each signer (or HR for them) uploads the signed PDF and Bizisy checks it is this document, signed with a qualified signature by that signer. method bizisy_accept: Bizisy click-to-accept, a simple signature, the person alone, PDF only; they accept in My workspace by typing their name. For a document made from a template, every method is checked against the law of the person's country: a level below a verified minimum is refused, a less certain one goes out with a warning (law). A dry run checks everything and sends nothing.
- Who can call it
- Manage key owner admin hr
- MCP tool
documents_signatures_sendon HR Assistant- 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_idstringrequiredsignersobject[]required1–5 items.
5 fields (one of several shapes)
Option 1
role"person"required
Option 2
role"manager"required
Option 3
role"me"required
Option 4
role"other"requiredperson_idstringrequired
orderedbooleanlevel"simple" | "advanced" | "qualified"remindersobject | null2 fields
interval_days1 | 2 | 7 | 14requiredmaxintegerrequiredFrom 1 to 10.
expires_onstringPattern
^\d{4}-\d{2}-\d{2}$.method"tool" | "autenticacao_gov" | "bizisy_accept"tool (default): through the company's e-signature tool. autenticacao_gov (companies in Portugal): each signer downloads the PDF, signs it in Autenticação.gov with their Cartão de Cidadão or Chave Móvel Digital (a qualified signature) and the signed file is uploaded (
documents_signatures_upload_signed_start, or the signer in My workspace); Bizisy checks every upload. No tool, email or phone needed; reminders are not sent. bizisy_accept: Bizisy click-to-accept, a simple signature: the person (the only signer) accepts in My workspace by typing their name, and Bizisy appends the acceptance record; only for PDFs where a simple signature is enough (the law of their country for a document made from a template, and the category's level in Settings → Documents). Every method is checked against the law of the person's country for a document made from a template.
Returns
22 fields
idstringrequiredproviderstring (enum)requiredHow it is signed: through the e-signature tool yousign, docusign, dropbox_sign, signaturit or skribble; autenticacao_gov: each signer signs the PDF in Autenticação.gov (Cartão de Cidadão or Chave Móvel Digital) and the signed file is uploaded to Bizisy, which checks it; bizisy_accept: Bizisy click-to-accept (the person accepts in Bizisy by typing their name).
One of:
yousign,docusign,dropbox_sign,signaturit,skribble,autenticacao_gov,bizisy_accept.document_idstringrequiredperson_idstring | nullrequiredpurpose"sign" | "receipt"receipt: the person confirms they received a written statement or change notice (proof of delivery), not a signature; sign (default): a signature.
statusstring (enum)requiredqueued: about to go to the e-signature tool; sending; ongoing: out for signature; done: everyone signed; declined; expired; canceled; failed: could not be sent (error says why; try again).
One of:
queued,sending,ongoing,done,declined,expired,canceled,failed.level"simple" | "advanced" | "qualified"requiredeIDAS level: simple (SES), advanced (AdES: the signer is uniquely identified, e.g. a code by SMS), qualified (QES: identity verified, e.g. by video; equivalent to a handwritten signature in every EU country).
orderedbooleanrequiredSigners sign one after the other, in the order listed.
signersobject[]required4 fields
role"person" | "manager" | "me" | "other"requiredperson: the person the document is about; manager: their manager; me: the HR member who sent it; other: anyone else chosen.
personobject | nullrequirednull once erased.
2 fields
idstringrequirednamestringrequired
status"waiting" | "notified" | "signed" | "declined" | "error"requiredwaiting: not their turn yet (or not sent); notified: the tool emailed them; signed; declined; error.
signed_atstring | nullrequired
remindersobject | nullrequired2 fields
interval_daysintegerrequiredmaxintegerrequired
expires_onstringrequiredsent_atstring | nullrequiredcompleted_atstring | nullrequiredsigned_document_idstring | nullrequiredThe signed copy, a document of the person (same category and visibility).
audit_document_idstring | nullrequiredThe signature audit trail (HR only); null for anyone else.
errorstring | nullrequiredcancel_requestedbooleanrequiredlast_reminded_atstring | nullrequiredcreated_atstringrequiredto_sign_document_idstring | nullSigning outside Bizisy (autenticacao_gov): the document the next signer downloads and signs: the original, or the partly signed copy once someone signed. null for the e-signature tools and once done.
checksobject[] | nullSigning outside Bizisy: what Bizisy checked in each signed upload (the EU DSS validation against the EU trusted lists). HR only; null for anyone else.
6 fields
atstringrequiredby"hr" | "self"requiredhr: uploaded by HR; self: by the signer in My workspace.
addedobject[]required7 fields
role"person" | "manager" | "me" | "other"requirednamestringrequiredThe name on the signing certificate.
levelstringrequiredETSI qualification: QESig is a qualified electronic signature.
qualifiedbooleanrequiredqscdbooleanrequiredMade on a qualified signature creation device (the citizen card chip, or the CMD remote HSM).
indicationstringrequiredsigning_timestring | nullrequired
signaturesintegerrequireddocument_timestampsintegerrequiredextendedbooleanrequiredThe signed copy was extended to PAdES-B-LTA (long-term validation data and a timestamp).
lawobject | nullrequiredA warning from the law pack (a starting point, not legal advice); null when the level is fine or the document was not made from a template.
4 fields
countrystringrequiredmin_level"none" | "simple" | "advanced" | "qualified" | "wet"requiredThe lowest level the law accepts for this document there.
messagestringrequiredWhy the level may not make the document valid (a rule Bizisy is not certain of: a warning, not a refusal).
sourceobjectrequired2 fields
urlstringrequiredarticlestringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/signatures.send \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"document_id": "d1",
"signers": [
{
"role": "other",
"person_id": "p3"
},
{
"role": "me"
}
],
"ordered": false,
"level": "qualified",
"reminders": null,
"expires_on": "2026-12-01"
}'const res = await fetch('https://api.bizisy.com/v1/documents/signatures.send', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"document_id": "d1",
"signers": [
{
"role": "other",
"person_id": "p3"
},
{
"role": "me"
}
],
"ordered": false,
"level": "qualified",
"reminders": null,
"expires_on": "2026-12-01"
}),
});
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/signatures.send",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"document_id": "d1",
"signers": [
{
"role": "other",
"person_id": "p3",
},
{
"role": "me",
},
],
"ordered": False,
"level": "qualified",
"reminders": None,
"expires_on": "2026-12-01",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "sig_1",
"provider": "yousign",
"document_id": "d1",
"person_id": "p1",
"status": "ongoing",
"level": "qualified",
"ordered": false,
"signers": [
{
"role": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
},
"status": "signed",
"signed_at": "2026-10-06T09:00:00.000Z"
},
{
"role": "manager",
"person": {
"id": "p2",
"name": "Rui Costa"
},
"status": "notified",
"signed_at": null
}
],
"reminders": {
"interval_days": 2,
"max": 5
},
"expires_on": "2026-12-01",
"sent_at": "2026-10-05T10:01:00.000Z",
"completed_at": null,
"signed_document_id": null,
"audit_document_id": null,
"error": null,
"cancel_requested": false,
"last_reminded_at": null,
"created_at": "2026-10-05T10:00:00.000Z",
"law": null
}
}List signature requests#
POST/v1/documents/signatures.listRead
Signature requests (through the company's e-signature tool: provider says which), newest first: of one document (document_id), of one person's documents (person_id), or, without either, every open request of the company (owners, admins and HR). Each: status, eIDAS level, signers in order with their status, dates, the signed copy and audit trail document ids once done, and why sending failed. Only for documents you can see; through an API key or an AI assistant, other people's requests come as ids and statuses.
- Who can call it
- Manage key any Manage role
- Keys and apps
- Other people's signature requests come as ids and statuses, without signers' names.
- MCP tool
documents_signatures_liston HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
document_idstringperson_idstring
Returns
signaturesobject[]required21 fields
idstringrequiredproviderstring (enum)requiredHow it is signed: through the e-signature tool yousign, docusign, dropbox_sign, signaturit or skribble; autenticacao_gov: each signer signs the PDF in Autenticação.gov (Cartão de Cidadão or Chave Móvel Digital) and the signed file is uploaded to Bizisy, which checks it; bizisy_accept: Bizisy click-to-accept (the person accepts in Bizisy by typing their name).
One of:
yousign,docusign,dropbox_sign,signaturit,skribble,autenticacao_gov,bizisy_accept.document_idstringrequiredperson_idstring | nullrequiredpurpose"sign" | "receipt"receipt: the person confirms they received a written statement or change notice (proof of delivery), not a signature; sign (default): a signature.
statusstring (enum)requiredqueued: about to go to the e-signature tool; sending; ongoing: out for signature; done: everyone signed; declined; expired; canceled; failed: could not be sent (error says why; try again).
One of:
queued,sending,ongoing,done,declined,expired,canceled,failed.level"simple" | "advanced" | "qualified"requiredeIDAS level: simple (SES), advanced (AdES: the signer is uniquely identified, e.g. a code by SMS), qualified (QES: identity verified, e.g. by video; equivalent to a handwritten signature in every EU country).
orderedbooleanrequiredSigners sign one after the other, in the order listed.
signersobject[]required4 fields
role"person" | "manager" | "me" | "other"requiredperson: the person the document is about; manager: their manager; me: the HR member who sent it; other: anyone else chosen.
personobject | nullrequirednull once erased.
2 fields
idstringrequirednamestringrequired
status"waiting" | "notified" | "signed" | "declined" | "error"requiredwaiting: not their turn yet (or not sent); notified: the tool emailed them; signed; declined; error.
signed_atstring | nullrequired
remindersobject | nullrequired2 fields
interval_daysintegerrequiredmaxintegerrequired
expires_onstringrequiredsent_atstring | nullrequiredcompleted_atstring | nullrequiredsigned_document_idstring | nullrequiredThe signed copy, a document of the person (same category and visibility).
audit_document_idstring | nullrequiredThe signature audit trail (HR only); null for anyone else.
errorstring | nullrequiredcancel_requestedbooleanrequiredlast_reminded_atstring | nullrequiredcreated_atstringrequiredto_sign_document_idstring | nullSigning outside Bizisy (autenticacao_gov): the document the next signer downloads and signs: the original, or the partly signed copy once someone signed. null for the e-signature tools and once done.
checksobject[] | nullSigning outside Bizisy: what Bizisy checked in each signed upload (the EU DSS validation against the EU trusted lists). HR only; null for anyone else.
6 fields
atstringrequiredby"hr" | "self"requiredhr: uploaded by HR; self: by the signer in My workspace.
addedobject[]required7 fields
role"person" | "manager" | "me" | "other"requirednamestringrequiredThe name on the signing certificate.
levelstringrequiredETSI qualification: QESig is a qualified electronic signature.
qualifiedbooleanrequiredqscdbooleanrequiredMade on a qualified signature creation device (the citizen card chip, or the CMD remote HSM).
indicationstringrequiredsigning_timestring | nullrequired
signaturesintegerrequireddocument_timestampsintegerrequiredextendedbooleanrequiredThe signed copy was extended to PAdES-B-LTA (long-term validation data and a timestamp).
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/signatures.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"document_id":"d1"}'const res = await fetch('https://api.bizisy.com/v1/documents/signatures.list', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
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
import requests
res = requests.post(
"https://api.bizisy.com/v1/documents/signatures.list",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"document_id": "d1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"signatures": [
{
"id": "sig_1",
"provider": "yousign",
"document_id": "d1",
"person_id": "p1",
"status": "ongoing",
"level": "advanced",
"ordered": true,
"signers": [
{
"role": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
},
"status": "signed",
"signed_at": "2026-10-06T09:00:00.000Z"
},
{
"role": "manager",
"person": {
"id": "p2",
"name": "Rui Costa"
},
"status": "notified",
"signed_at": null
}
],
"reminders": {
"interval_days": 2,
"max": 5
},
"expires_on": "2026-11-05",
"sent_at": "2026-10-05T10:01:00.000Z",
"completed_at": null,
"signed_document_id": null,
"audit_document_id": null,
"error": null,
"cancel_requested": false,
"last_reminded_at": null,
"created_at": "2026-10-05T10:00:00.000Z"
},
{
"id": "sig_2",
"provider": "yousign",
"document_id": "d1",
"person_id": "p1",
"status": "done",
"level": "advanced",
"ordered": true,
"signers": [
{
"role": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
},
"status": "signed",
"signed_at": "2026-10-06T09:00:00.000Z"
},
{
"role": "manager",
"person": {
"id": "p2",
"name": "Rui Costa"
},
"status": "notified",
"signed_at": null
}
],
"reminders": {
"interval_days": 2,
"max": 5
},
"expires_on": "2026-11-05",
"sent_at": "2026-10-05T10:01:00.000Z",
"completed_at": "2026-10-07T09:00:00.000Z",
"signed_document_id": "sig_2-signed",
"audit_document_id": "sig_2-audit",
"error": null,
"cancel_requested": false,
"last_reminded_at": null,
"created_at": "2026-10-05T10:00:00.000Z"
}
]
}
}Cancel a signature request#
POST/v1/documents/signatures.cancelWrite
Cancels an open signature request: the e-signature tool it went through stops it and tells the signers. Signatures already given stay in that tool but no signed copy comes back. Owners, admins and HR (and custom roles with Documents at Edit, for the people they cover).
- Who can call it
- Manage key owner admin hr
- MCP tool
documents_signatures_cancelon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
signature_idstringrequired
Returns
21 fields
idstringrequiredproviderstring (enum)requiredHow it is signed: through the e-signature tool yousign, docusign, dropbox_sign, signaturit or skribble; autenticacao_gov: each signer signs the PDF in Autenticação.gov (Cartão de Cidadão or Chave Móvel Digital) and the signed file is uploaded to Bizisy, which checks it; bizisy_accept: Bizisy click-to-accept (the person accepts in Bizisy by typing their name).
One of:
yousign,docusign,dropbox_sign,signaturit,skribble,autenticacao_gov,bizisy_accept.document_idstringrequiredperson_idstring | nullrequiredpurpose"sign" | "receipt"receipt: the person confirms they received a written statement or change notice (proof of delivery), not a signature; sign (default): a signature.
statusstring (enum)requiredqueued: about to go to the e-signature tool; sending; ongoing: out for signature; done: everyone signed; declined; expired; canceled; failed: could not be sent (error says why; try again).
One of:
queued,sending,ongoing,done,declined,expired,canceled,failed.level"simple" | "advanced" | "qualified"requiredeIDAS level: simple (SES), advanced (AdES: the signer is uniquely identified, e.g. a code by SMS), qualified (QES: identity verified, e.g. by video; equivalent to a handwritten signature in every EU country).
orderedbooleanrequiredSigners sign one after the other, in the order listed.
signersobject[]required4 fields
role"person" | "manager" | "me" | "other"requiredperson: the person the document is about; manager: their manager; me: the HR member who sent it; other: anyone else chosen.
personobject | nullrequirednull once erased.
2 fields
idstringrequirednamestringrequired
status"waiting" | "notified" | "signed" | "declined" | "error"requiredwaiting: not their turn yet (or not sent); notified: the tool emailed them; signed; declined; error.
signed_atstring | nullrequired
remindersobject | nullrequired2 fields
interval_daysintegerrequiredmaxintegerrequired
expires_onstringrequiredsent_atstring | nullrequiredcompleted_atstring | nullrequiredsigned_document_idstring | nullrequiredThe signed copy, a document of the person (same category and visibility).
audit_document_idstring | nullrequiredThe signature audit trail (HR only); null for anyone else.
errorstring | nullrequiredcancel_requestedbooleanrequiredlast_reminded_atstring | nullrequiredcreated_atstringrequiredto_sign_document_idstring | nullSigning outside Bizisy (autenticacao_gov): the document the next signer downloads and signs: the original, or the partly signed copy once someone signed. null for the e-signature tools and once done.
checksobject[] | nullSigning outside Bizisy: what Bizisy checked in each signed upload (the EU DSS validation against the EU trusted lists). HR only; null for anyone else.
6 fields
atstringrequiredby"hr" | "self"requiredhr: uploaded by HR; self: by the signer in My workspace.
addedobject[]required7 fields
role"person" | "manager" | "me" | "other"requirednamestringrequiredThe name on the signing certificate.
levelstringrequiredETSI qualification: QESig is a qualified electronic signature.
qualifiedbooleanrequiredqscdbooleanrequiredMade on a qualified signature creation device (the citizen card chip, or the CMD remote HSM).
indicationstringrequiredsigning_timestring | nullrequired
signaturesintegerrequireddocument_timestampsintegerrequiredextendedbooleanrequiredThe signed copy was extended to PAdES-B-LTA (long-term validation data and a timestamp).
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/signatures.cancel \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"signature_id":"sig_1"}'const res = await fetch('https://api.bizisy.com/v1/documents/signatures.cancel', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"signature_id": "sig_1"
}),
});
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/signatures.cancel",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"signature_id": "sig_1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "sig_1",
"provider": "yousign",
"document_id": "d1",
"person_id": "p1",
"status": "ongoing",
"level": "advanced",
"ordered": true,
"signers": [
{
"role": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
},
"status": "signed",
"signed_at": "2026-10-06T09:00:00.000Z"
},
{
"role": "manager",
"person": {
"id": "p2",
"name": "Rui Costa"
},
"status": "notified",
"signed_at": null
}
],
"reminders": {
"interval_days": 2,
"max": 5
},
"expires_on": "2026-11-05",
"sent_at": "2026-10-05T10:01:00.000Z",
"completed_at": null,
"signed_document_id": null,
"audit_document_id": null,
"error": null,
"cancel_requested": true,
"last_reminded_at": null,
"created_at": "2026-10-05T10:00:00.000Z"
}
}Remind signers#
POST/v1/documents/signatures.remindWrite
Asks the e-signature tool to email the signer whose turn it is again (everyone who has not signed, when the order does not matter). Only for a request out for signature, at most once a day. Requests with reminders are also reminded automatically (by the tool, or by Bizisy asking it on schedule). Owners, admins and HR (and custom roles with Documents at Edit, for the people they cover).
- Who can call it
- Manage key owner admin hr
- MCP tool
documents_signatures_remindon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
signature_idstringrequired
Returns
21 fields
idstringrequiredproviderstring (enum)requiredHow it is signed: through the e-signature tool yousign, docusign, dropbox_sign, signaturit or skribble; autenticacao_gov: each signer signs the PDF in Autenticação.gov (Cartão de Cidadão or Chave Móvel Digital) and the signed file is uploaded to Bizisy, which checks it; bizisy_accept: Bizisy click-to-accept (the person accepts in Bizisy by typing their name).
One of:
yousign,docusign,dropbox_sign,signaturit,skribble,autenticacao_gov,bizisy_accept.document_idstringrequiredperson_idstring | nullrequiredpurpose"sign" | "receipt"receipt: the person confirms they received a written statement or change notice (proof of delivery), not a signature; sign (default): a signature.
statusstring (enum)requiredqueued: about to go to the e-signature tool; sending; ongoing: out for signature; done: everyone signed; declined; expired; canceled; failed: could not be sent (error says why; try again).
One of:
queued,sending,ongoing,done,declined,expired,canceled,failed.level"simple" | "advanced" | "qualified"requiredeIDAS level: simple (SES), advanced (AdES: the signer is uniquely identified, e.g. a code by SMS), qualified (QES: identity verified, e.g. by video; equivalent to a handwritten signature in every EU country).
orderedbooleanrequiredSigners sign one after the other, in the order listed.
signersobject[]required4 fields
role"person" | "manager" | "me" | "other"requiredperson: the person the document is about; manager: their manager; me: the HR member who sent it; other: anyone else chosen.
personobject | nullrequirednull once erased.
2 fields
idstringrequirednamestringrequired
status"waiting" | "notified" | "signed" | "declined" | "error"requiredwaiting: not their turn yet (or not sent); notified: the tool emailed them; signed; declined; error.
signed_atstring | nullrequired
remindersobject | nullrequired2 fields
interval_daysintegerrequiredmaxintegerrequired
expires_onstringrequiredsent_atstring | nullrequiredcompleted_atstring | nullrequiredsigned_document_idstring | nullrequiredThe signed copy, a document of the person (same category and visibility).
audit_document_idstring | nullrequiredThe signature audit trail (HR only); null for anyone else.
errorstring | nullrequiredcancel_requestedbooleanrequiredlast_reminded_atstring | nullrequiredcreated_atstringrequiredto_sign_document_idstring | nullSigning outside Bizisy (autenticacao_gov): the document the next signer downloads and signs: the original, or the partly signed copy once someone signed. null for the e-signature tools and once done.
checksobject[] | nullSigning outside Bizisy: what Bizisy checked in each signed upload (the EU DSS validation against the EU trusted lists). HR only; null for anyone else.
6 fields
atstringrequiredby"hr" | "self"requiredhr: uploaded by HR; self: by the signer in My workspace.
addedobject[]required7 fields
role"person" | "manager" | "me" | "other"requirednamestringrequiredThe name on the signing certificate.
levelstringrequiredETSI qualification: QESig is a qualified electronic signature.
qualifiedbooleanrequiredqscdbooleanrequiredMade on a qualified signature creation device (the citizen card chip, or the CMD remote HSM).
indicationstringrequiredsigning_timestring | nullrequired
signaturesintegerrequireddocument_timestampsintegerrequiredextendedbooleanrequiredThe signed copy was extended to PAdES-B-LTA (long-term validation data and a timestamp).
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/signatures.remind \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"signature_id":"sig_1"}'const res = await fetch('https://api.bizisy.com/v1/documents/signatures.remind', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"signature_id": "sig_1"
}),
});
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/signatures.remind",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"signature_id": "sig_1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "sig_1",
"provider": "yousign",
"document_id": "d1",
"person_id": "p1",
"status": "ongoing",
"level": "advanced",
"ordered": true,
"signers": [
{
"role": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
},
"status": "signed",
"signed_at": "2026-10-06T09:00:00.000Z"
},
{
"role": "manager",
"person": {
"id": "p2",
"name": "Rui Costa"
},
"status": "notified",
"signed_at": null
}
],
"reminders": {
"interval_days": 2,
"max": 5
},
"expires_on": "2026-11-05",
"sent_at": "2026-10-05T10:01:00.000Z",
"completed_at": null,
"signed_document_id": null,
"audit_document_id": null,
"error": null,
"cancel_requested": false,
"last_reminded_at": null,
"created_at": "2026-10-05T10:00:00.000Z"
}
}Send a signature request again#
POST/v1/documents/signatures.retryWrite
Tries again to send a request that could not be sent (status failed; error says why: fix that first, e.g. a signer's phone number). It goes through the e-signature tool in use now, which must be able to make its level. Owners, admins and HR (and custom roles with Documents at Edit, for the people they cover).
- Who can call it
- Manage key owner admin hr
- MCP tool
documents_signatures_retryon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
signature_idstringrequired
Returns
21 fields
idstringrequiredproviderstring (enum)requiredHow it is signed: through the e-signature tool yousign, docusign, dropbox_sign, signaturit or skribble; autenticacao_gov: each signer signs the PDF in Autenticação.gov (Cartão de Cidadão or Chave Móvel Digital) and the signed file is uploaded to Bizisy, which checks it; bizisy_accept: Bizisy click-to-accept (the person accepts in Bizisy by typing their name).
One of:
yousign,docusign,dropbox_sign,signaturit,skribble,autenticacao_gov,bizisy_accept.document_idstringrequiredperson_idstring | nullrequiredpurpose"sign" | "receipt"receipt: the person confirms they received a written statement or change notice (proof of delivery), not a signature; sign (default): a signature.
statusstring (enum)requiredqueued: about to go to the e-signature tool; sending; ongoing: out for signature; done: everyone signed; declined; expired; canceled; failed: could not be sent (error says why; try again).
One of:
queued,sending,ongoing,done,declined,expired,canceled,failed.level"simple" | "advanced" | "qualified"requiredeIDAS level: simple (SES), advanced (AdES: the signer is uniquely identified, e.g. a code by SMS), qualified (QES: identity verified, e.g. by video; equivalent to a handwritten signature in every EU country).
orderedbooleanrequiredSigners sign one after the other, in the order listed.
signersobject[]required4 fields
role"person" | "manager" | "me" | "other"requiredperson: the person the document is about; manager: their manager; me: the HR member who sent it; other: anyone else chosen.
personobject | nullrequirednull once erased.
2 fields
idstringrequirednamestringrequired
status"waiting" | "notified" | "signed" | "declined" | "error"requiredwaiting: not their turn yet (or not sent); notified: the tool emailed them; signed; declined; error.
signed_atstring | nullrequired
remindersobject | nullrequired2 fields
interval_daysintegerrequiredmaxintegerrequired
expires_onstringrequiredsent_atstring | nullrequiredcompleted_atstring | nullrequiredsigned_document_idstring | nullrequiredThe signed copy, a document of the person (same category and visibility).
audit_document_idstring | nullrequiredThe signature audit trail (HR only); null for anyone else.
errorstring | nullrequiredcancel_requestedbooleanrequiredlast_reminded_atstring | nullrequiredcreated_atstringrequiredto_sign_document_idstring | nullSigning outside Bizisy (autenticacao_gov): the document the next signer downloads and signs: the original, or the partly signed copy once someone signed. null for the e-signature tools and once done.
checksobject[] | nullSigning outside Bizisy: what Bizisy checked in each signed upload (the EU DSS validation against the EU trusted lists). HR only; null for anyone else.
6 fields
atstringrequiredby"hr" | "self"requiredhr: uploaded by HR; self: by the signer in My workspace.
addedobject[]required7 fields
role"person" | "manager" | "me" | "other"requirednamestringrequiredThe name on the signing certificate.
levelstringrequiredETSI qualification: QESig is a qualified electronic signature.
qualifiedbooleanrequiredqscdbooleanrequiredMade on a qualified signature creation device (the citizen card chip, or the CMD remote HSM).
indicationstringrequiredsigning_timestring | nullrequired
signaturesintegerrequireddocument_timestampsintegerrequiredextendedbooleanrequiredThe signed copy was extended to PAdES-B-LTA (long-term validation data and a timestamp).
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/signatures.retry \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"signature_id":"sig_1"}'const res = await fetch('https://api.bizisy.com/v1/documents/signatures.retry', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"signature_id": "sig_1"
}),
});
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/signatures.retry",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"signature_id": "sig_1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "sig_1",
"provider": "yousign",
"document_id": "d1",
"person_id": "p1",
"status": "queued",
"level": "advanced",
"ordered": true,
"signers": [
{
"role": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
},
"status": "signed",
"signed_at": "2026-10-06T09:00:00.000Z"
},
{
"role": "manager",
"person": {
"id": "p2",
"name": "Rui Costa"
},
"status": "notified",
"signed_at": null
}
],
"reminders": {
"interval_days": 2,
"max": 5
},
"expires_on": "2026-11-05",
"sent_at": "2026-10-05T10:01:00.000Z",
"completed_at": null,
"signed_document_id": null,
"audit_document_id": null,
"error": null,
"cancel_requested": false,
"last_reminded_at": null,
"created_at": "2026-10-05T10:00:00.000Z"
}
}See signature levels#
POST/v1/documents/signatures.levels.getRead
The eIDAS signature level each document category is sent with by default: simple (SES), advanced (AdES) or qualified (QES). Contract and Addendum start as advanced, the rest as simple. Also the e-signature tool new requests go through (provider: its levels, which levels need a phone, file types, order, reminders, where signatures go), the one chosen, and each tool this server offers with whether it is connected.
- Who can call it
- Manage key any Manage role
- MCP tool
documents_signatures_levels_geton HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
levelsobject[]required3 fields
categorystringrequiredlevel"simple" | "advanced" | "qualified"requiredis_defaultbooleanrequired
connectedbooleanrequiredAn e-signature tool is connected and working, so documents can be sent for signature.
providerobject | nullrequiredThe tool new requests go through (the chosen one, else the one connected first); null when none is connected.
11 fields
id"yousign" | "docusign" | "dropbox_sign" | "signaturit" | "skribble"requirednamestringrequiredlevels"simple" | "advanced" | "qualified"[]requiredThe eIDAS levels this tool makes.
phone_levels"simple" | "advanced" | "qualified"[]requiredLevels for which it texts the signer a code: each signer needs a phone number in international format.
typesstring[]requiredFile types it signs.
max_bytesintegerrequiredparallelbooleanrequiredfalse: signers always sign one after the other.
reminders"tool" | "bizisy"requiredtool: its own automatic reminders; bizisy: Bizisy asks it to remind on schedule.
placement"last_page" | "signature_page" | "signer"requiredlast_page: boxes at the bottom of the last page; signature_page: the tool adds a page at the end; signer: each signer places their signature.
auditbooleanrequiredIt hands back an audit trail of its own (else the audit trail is part of the signed PDF).
testbooleanrequiredA sandbox, demo or test-mode account: its signatures have no legal value.
chosen"yousign" | "docusign" | "dropbox_sign" | "signaturit" | "skribble"requiredThe tool chosen in Settings → Documents (null: automatic).
providersobject[]requiredEach e-signature tool this server offers, and whether the company connected it.
3 fields
id"yousign" | "docusign" | "dropbox_sign" | "signaturit" | "skribble"requirednamestringrequiredstatus"connected" | "error" | "off"required
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/signatures.levels.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/documents/signatures.levels.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/signatures.levels.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": {
"levels": [
{
"category": "Contract",
"level": "advanced",
"is_default": true
},
{
"category": "Policy",
"level": "simple",
"is_default": true
}
],
"connected": true,
"provider": {
"id": "yousign",
"name": "Yousign",
"levels": [
"simple",
"advanced",
"qualified"
],
"phone_levels": [
"advanced",
"qualified"
],
"types": [
"application/pdf"
],
"max_bytes": 25000000,
"parallel": true,
"reminders": "tool",
"placement": "last_page",
"audit": true,
"test": false
},
"chosen": null,
"providers": [
{
"id": "yousign",
"name": "Yousign",
"status": "connected"
},
{
"id": "dropbox_sign",
"name": "Dropbox Sign",
"status": "off"
}
]
}
}Change signature levels#
POST/v1/documents/signatures.levels.setWrite
Sets the signature level per document category (levels: { "Contract": "qualified", … }); send only the categories that change, null puts one back to its default. The levels are the same whatever tool signs; advanced and qualified usually need an add-on on your e-signature tool's plan, and Dropbox Sign makes simple signatures only. Some contracts need a written form that only a qualified signature replaces in some countries: check the rules of the country of employment. Owners, admins and HR.
- Who can call it
- Manage key owner admin hr
- MCP tool
documents_signatures_levels_seton HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
levelsobjectrequired
Returns
levelsobject[]required3 fields
categorystringrequiredlevel"simple" | "advanced" | "qualified"requiredis_defaultbooleanrequired
connectedbooleanrequiredAn e-signature tool is connected and working, so documents can be sent for signature.
providerobject | nullrequiredThe tool new requests go through (the chosen one, else the one connected first); null when none is connected.
11 fields
id"yousign" | "docusign" | "dropbox_sign" | "signaturit" | "skribble"requirednamestringrequiredlevels"simple" | "advanced" | "qualified"[]requiredThe eIDAS levels this tool makes.
phone_levels"simple" | "advanced" | "qualified"[]requiredLevels for which it texts the signer a code: each signer needs a phone number in international format.
typesstring[]requiredFile types it signs.
max_bytesintegerrequiredparallelbooleanrequiredfalse: signers always sign one after the other.
reminders"tool" | "bizisy"requiredtool: its own automatic reminders; bizisy: Bizisy asks it to remind on schedule.
placement"last_page" | "signature_page" | "signer"requiredlast_page: boxes at the bottom of the last page; signature_page: the tool adds a page at the end; signer: each signer places their signature.
auditbooleanrequiredIt hands back an audit trail of its own (else the audit trail is part of the signed PDF).
testbooleanrequiredA sandbox, demo or test-mode account: its signatures have no legal value.
chosen"yousign" | "docusign" | "dropbox_sign" | "signaturit" | "skribble"requiredThe tool chosen in Settings → Documents (null: automatic).
providersobject[]requiredEach e-signature tool this server offers, and whether the company connected it.
3 fields
id"yousign" | "docusign" | "dropbox_sign" | "signaturit" | "skribble"requirednamestringrequiredstatus"connected" | "error" | "off"required
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/signatures.levels.set \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"levels":{"Contract":"qualified","Policy":null}}'const res = await fetch('https://api.bizisy.com/v1/documents/signatures.levels.set', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"levels": {
"Contract": "qualified",
"Policy": null
}
}),
});
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/signatures.levels.set",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"levels": {
"Contract": "qualified",
"Policy": None,
},
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"levels": [
{
"category": "Contract",
"level": "advanced",
"is_default": true
},
{
"category": "Policy",
"level": "simple",
"is_default": true
}
],
"connected": true,
"provider": {
"id": "yousign",
"name": "Yousign",
"levels": [
"simple",
"advanced",
"qualified"
],
"phone_levels": [
"advanced",
"qualified"
],
"types": [
"application/pdf"
],
"max_bytes": 25000000,
"parallel": true,
"reminders": "tool",
"placement": "last_page",
"audit": true,
"test": false
},
"chosen": null,
"providers": [
{
"id": "yousign",
"name": "Yousign",
"status": "connected"
},
{
"id": "dropbox_sign",
"name": "Dropbox Sign",
"status": "off"
}
]
}
}Choose the e-signature tool#
POST/v1/documents/signatures.provider.setWrite
Chooses which connected e-signature tool new signature requests go through: yousign, docusign, dropbox_sign, signaturit or skribble (it must be connected: Integrations → Documents & signature); null: automatic (the tool connected first). Requests already out stay with their tool until they end. Owners, admins and HR.
- Who can call it
- Manage key owner admin hr
- MCP tool
documents_signatures_provider_seton HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
provider"yousign" | "docusign" | "dropbox_sign" | "signaturit" | "skribble"required
Returns
levelsobject[]required3 fields
categorystringrequiredlevel"simple" | "advanced" | "qualified"requiredis_defaultbooleanrequired
connectedbooleanrequiredAn e-signature tool is connected and working, so documents can be sent for signature.
providerobject | nullrequiredThe tool new requests go through (the chosen one, else the one connected first); null when none is connected.
11 fields
id"yousign" | "docusign" | "dropbox_sign" | "signaturit" | "skribble"requirednamestringrequiredlevels"simple" | "advanced" | "qualified"[]requiredThe eIDAS levels this tool makes.
phone_levels"simple" | "advanced" | "qualified"[]requiredLevels for which it texts the signer a code: each signer needs a phone number in international format.
typesstring[]requiredFile types it signs.
max_bytesintegerrequiredparallelbooleanrequiredfalse: signers always sign one after the other.
reminders"tool" | "bizisy"requiredtool: its own automatic reminders; bizisy: Bizisy asks it to remind on schedule.
placement"last_page" | "signature_page" | "signer"requiredlast_page: boxes at the bottom of the last page; signature_page: the tool adds a page at the end; signer: each signer places their signature.
auditbooleanrequiredIt hands back an audit trail of its own (else the audit trail is part of the signed PDF).
testbooleanrequiredA sandbox, demo or test-mode account: its signatures have no legal value.
chosen"yousign" | "docusign" | "dropbox_sign" | "signaturit" | "skribble"requiredThe tool chosen in Settings → Documents (null: automatic).
providersobject[]requiredEach e-signature tool this server offers, and whether the company connected it.
3 fields
id"yousign" | "docusign" | "dropbox_sign" | "signaturit" | "skribble"requirednamestringrequiredstatus"connected" | "error" | "off"required
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/signatures.provider.set \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"provider":"yousign"}'const res = await fetch('https://api.bizisy.com/v1/documents/signatures.provider.set', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"provider": "yousign"
}),
});
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/signatures.provider.set",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"provider": "yousign",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"levels": [
{
"category": "Contract",
"level": "advanced",
"is_default": true
},
{
"category": "Policy",
"level": "simple",
"is_default": true
}
],
"connected": true,
"provider": {
"id": "yousign",
"name": "Yousign",
"levels": [
"simple",
"advanced",
"qualified"
],
"phone_levels": [
"advanced",
"qualified"
],
"types": [
"application/pdf"
],
"max_bytes": 25000000,
"parallel": true,
"reminders": "tool",
"placement": "last_page",
"audit": true,
"test": false
},
"chosen": "yousign",
"providers": [
{
"id": "yousign",
"name": "Yousign",
"status": "connected"
},
{
"id": "dropbox_sign",
"name": "Dropbox Sign",
"status": "off"
}
]
}
}Documents waiting for my signature#
POST/v1/documents/me.signaturesRead
The signature requests you are a signer of that are still open (newest first), and whether it is your turn: the e-signature tool (provider) emails you a link when it is. Only requests for documents you can see.
- Who can call it
- Me key anyone
- MCP tool
documents_me_signatureson My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
signaturesobject[]required23 fields
idstringrequiredproviderstring (enum)requiredHow it is signed: through the e-signature tool yousign, docusign, dropbox_sign, signaturit or skribble; autenticacao_gov: each signer signs the PDF in Autenticação.gov (Cartão de Cidadão or Chave Móvel Digital) and the signed file is uploaded to Bizisy, which checks it; bizisy_accept: Bizisy click-to-accept (the person accepts in Bizisy by typing their name).
One of:
yousign,docusign,dropbox_sign,signaturit,skribble,autenticacao_gov,bizisy_accept.document_idstringrequiredperson_idstring | nullrequiredpurpose"sign" | "receipt"receipt: the person confirms they received a written statement or change notice (proof of delivery), not a signature; sign (default): a signature.
statusstring (enum)requiredqueued: about to go to the e-signature tool; sending; ongoing: out for signature; done: everyone signed; declined; expired; canceled; failed: could not be sent (error says why; try again).
One of:
queued,sending,ongoing,done,declined,expired,canceled,failed.level"simple" | "advanced" | "qualified"requiredeIDAS level: simple (SES), advanced (AdES: the signer is uniquely identified, e.g. a code by SMS), qualified (QES: identity verified, e.g. by video; equivalent to a handwritten signature in every EU country).
orderedbooleanrequiredSigners sign one after the other, in the order listed.
signersobject[]required4 fields
role"person" | "manager" | "me" | "other"requiredperson: the person the document is about; manager: their manager; me: the HR member who sent it; other: anyone else chosen.
personobject | nullrequirednull once erased.
2 fields
idstringrequirednamestringrequired
status"waiting" | "notified" | "signed" | "declined" | "error"requiredwaiting: not their turn yet (or not sent); notified: the tool emailed them; signed; declined; error.
signed_atstring | nullrequired
remindersobject | nullrequired2 fields
interval_daysintegerrequiredmaxintegerrequired
expires_onstringrequiredsent_atstring | nullrequiredcompleted_atstring | nullrequiredsigned_document_idstring | nullrequiredThe signed copy, a document of the person (same category and visibility).
audit_document_idstring | nullrequiredThe signature audit trail (HR only); null for anyone else.
errorstring | nullrequiredcancel_requestedbooleanrequiredlast_reminded_atstring | nullrequiredcreated_atstringrequiredto_sign_document_idstring | nullSigning outside Bizisy (autenticacao_gov): the document the next signer downloads and signs: the original, or the partly signed copy once someone signed. null for the e-signature tools and once done.
checksobject[] | nullSigning outside Bizisy: what Bizisy checked in each signed upload (the EU DSS validation against the EU trusted lists). HR only; null for anyone else.
6 fields
atstringrequiredby"hr" | "self"requiredhr: uploaded by HR; self: by the signer in My workspace.
addedobject[]required7 fields
role"person" | "manager" | "me" | "other"requirednamestringrequiredThe name on the signing certificate.
levelstringrequiredETSI qualification: QESig is a qualified electronic signature.
qualifiedbooleanrequiredqscdbooleanrequiredMade on a qualified signature creation device (the citizen card chip, or the CMD remote HSM).
indicationstringrequiredsigning_timestring | nullrequired
signaturesintegerrequireddocument_timestampsintegerrequiredextendedbooleanrequiredThe signed copy was extended to PAdES-B-LTA (long-term validation data and a timestamp).
your_turnbooleanrequireddocument_titlestringrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.signatures \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/documents/me.signatures', {
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.signatures",
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": {
"signatures": [
{
"id": "sig_1",
"provider": "yousign",
"document_id": "d1",
"person_id": "p1",
"status": "ongoing",
"level": "advanced",
"ordered": true,
"signers": [
{
"role": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
},
"status": "signed",
"signed_at": "2026-10-06T09:00:00.000Z"
},
{
"role": "manager",
"person": {
"id": "p2",
"name": "Rui Costa"
},
"status": "notified",
"signed_at": null
}
],
"reminders": {
"interval_days": 2,
"max": 5
},
"expires_on": "2026-11-05",
"sent_at": "2026-10-05T10:01:00.000Z",
"completed_at": null,
"signed_document_id": null,
"audit_document_id": null,
"error": null,
"cancel_requested": false,
"last_reminded_at": null,
"created_at": "2026-10-05T10:00:00.000Z",
"your_turn": true,
"document_title": "Contract 2026"
},
{
"id": "sig_2",
"provider": "autenticacao_gov",
"document_id": "d1",
"person_id": "p1",
"status": "ongoing",
"level": "qualified",
"ordered": false,
"signers": [
{
"role": "other",
"person": {
"id": "p2",
"name": "Rui Costa"
},
"status": "signed",
"signed_at": "2026-10-06T09:00:00.000Z"
},
{
"role": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
},
"status": "notified",
"signed_at": null
}
],
"reminders": null,
"expires_on": "2026-11-05",
"sent_at": "2026-10-05T10:01:00.000Z",
"completed_at": null,
"signed_document_id": null,
"audit_document_id": null,
"error": null,
"cancel_requested": false,
"last_reminded_at": null,
"created_at": "2026-10-05T10:00:00.000Z",
"to_sign_document_id": "sig_2-signed",
"checks": null,
"your_turn": true,
"document_title": "Contract 2026"
}
]
}
}Upload a signed copy#
POST/v1/documents/signatures.upload_signed.startWrite
For a person's document out for signature in Autenticação.gov (documents_signatures_send with method autenticacao_gov): starts the upload of the PDF a signer signed there with their Cartão de Cidadão or Chave Móvel Digital (HR uploads it for any signer, e.g. one who emailed it). Then PUT the bytes to the signed URL within 15 minutes with exactly the returned headers, and call documents_signatures_upload_signed_finish with upload_id. PDF only, at most 20 MB. The file must be the document as Bizisy has it (or the latest partly signed copy, to_sign_document_id), signed without changes. Owners, admins and HR, only in the app (never through an API key or MCP).
- Web app only
- Refused for API keys and connected apps. Signed copies are uploaded by HR in the app.
- MCP tool
documents_signatures_upload_signed_starton HR Assistant- 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_idstringrequiredfileobjectrequired4 fields
namestringrequiredThe file name, e.g. "Contract 2026.pdf" (kept as metadata only).
1–500 characters.
sizeintegerrequiredBytes, at most 20 MB.
From 0 to 20000000.
content_type"application/pdf"requiredapplication/pdf: the file Autenticação.gov saved.
sha256stringrequiredLowercase hex SHA-256 of the file; checked against the upload.
Pattern
^[0-9a-f]{64}$.
Returns
signatureobjectrequired21 fields
idstringrequiredproviderstring (enum)requiredHow it is signed: through the e-signature tool yousign, docusign, dropbox_sign, signaturit or skribble; autenticacao_gov: each signer signs the PDF in Autenticação.gov (Cartão de Cidadão or Chave Móvel Digital) and the signed file is uploaded to Bizisy, which checks it; bizisy_accept: Bizisy click-to-accept (the person accepts in Bizisy by typing their name).
One of:
yousign,docusign,dropbox_sign,signaturit,skribble,autenticacao_gov,bizisy_accept.document_idstringrequiredperson_idstring | nullrequiredpurpose"sign" | "receipt"receipt: the person confirms they received a written statement or change notice (proof of delivery), not a signature; sign (default): a signature.
statusstring (enum)requiredqueued: about to go to the e-signature tool; sending; ongoing: out for signature; done: everyone signed; declined; expired; canceled; failed: could not be sent (error says why; try again).
One of:
queued,sending,ongoing,done,declined,expired,canceled,failed.level"simple" | "advanced" | "qualified"requiredeIDAS level: simple (SES), advanced (AdES: the signer is uniquely identified, e.g. a code by SMS), qualified (QES: identity verified, e.g. by video; equivalent to a handwritten signature in every EU country).
orderedbooleanrequiredSigners sign one after the other, in the order listed.
signersobject[]required4 fields
role"person" | "manager" | "me" | "other"requiredperson: the person the document is about; manager: their manager; me: the HR member who sent it; other: anyone else chosen.
personobject | nullrequirednull once erased.
2 fields
idstringrequirednamestringrequired
status"waiting" | "notified" | "signed" | "declined" | "error"requiredwaiting: not their turn yet (or not sent); notified: the tool emailed them; signed; declined; error.
signed_atstring | nullrequired
remindersobject | nullrequired2 fields
interval_daysintegerrequiredmaxintegerrequired
expires_onstringrequiredsent_atstring | nullrequiredcompleted_atstring | nullrequiredsigned_document_idstring | nullrequiredThe signed copy, a document of the person (same category and visibility).
audit_document_idstring | nullrequiredThe signature audit trail (HR only); null for anyone else.
errorstring | nullrequiredcancel_requestedbooleanrequiredlast_reminded_atstring | nullrequiredcreated_atstringrequiredto_sign_document_idstring | nullSigning outside Bizisy (autenticacao_gov): the document the next signer downloads and signs: the original, or the partly signed copy once someone signed. null for the e-signature tools and once done.
checksobject[] | nullSigning outside Bizisy: what Bizisy checked in each signed upload (the EU DSS validation against the EU trusted lists). HR only; null for anyone else.
6 fields
atstringrequiredby"hr" | "self"requiredhr: uploaded by HR; self: by the signer in My workspace.
addedobject[]required7 fields
role"person" | "manager" | "me" | "other"requirednamestringrequiredThe name on the signing certificate.
levelstringrequiredETSI qualification: QESig is a qualified electronic signature.
qualifiedbooleanrequiredqscdbooleanrequiredMade on a qualified signature creation device (the citizen card chip, or the CMD remote HSM).
indicationstringrequiredsigning_timestring | nullrequired
signaturesintegerrequireddocument_timestampsintegerrequiredextendedbooleanrequiredThe signed copy was extended to PAdES-B-LTA (long-term validation data and a timestamp).
upload_idstringrequiredSend it to the finish call.
uploadobject | nullrequirednull on a dry run.
4 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/signatures.upload_signed.start \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"signature_id": "sig_2",
"file": {
"name": "Contract 2026_signed.pdf",
"size": 214000,
"content_type": "application/pdf",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
}'const res = await fetch('https://api.bizisy.com/v1/documents/signatures.upload_signed.start', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"signature_id": "sig_2",
"file": {
"name": "Contract 2026_signed.pdf",
"size": 214000,
"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/signatures.upload_signed.start",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"signature_id": "sig_2",
"file": {
"name": "Contract 2026_signed.pdf",
"size": 214000,
"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": {
"signature": {
"id": "sig_2",
"provider": "autenticacao_gov",
"document_id": "d1",
"person_id": "p1",
"status": "ongoing",
"level": "qualified",
"ordered": false,
"signers": [
{
"role": "other",
"person": {
"id": "p2",
"name": "Rui Costa"
},
"status": "signed",
"signed_at": "2026-10-06T09:00:00.000Z"
},
{
"role": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
},
"status": "notified",
"signed_at": null
}
],
"reminders": null,
"expires_on": "2026-11-05",
"sent_at": "2026-10-05T10:01:00.000Z",
"completed_at": null,
"signed_document_id": null,
"audit_document_id": null,
"error": null,
"cancel_requested": false,
"last_reminded_at": null,
"created_at": "2026-10-05T10:00:00.000Z",
"to_sign_document_id": "sig_2-signed",
"checks": [
{
"at": "2026-10-06T09:05:00.000Z",
"by": "hr",
"signatures": 1,
"document_timestamps": 0,
"extended": false,
"added": [
{
"role": "other",
"name": "RUI MANUEL COSTA",
"level": "QESig",
"qualified": true,
"qscd": true,
"indication": "TOTAL_PASSED",
"signing_time": "2026-10-06T09:00:00Z"
}
]
}
]
},
"upload_id": "f9",
"upload": {
"url": "https://storage.example/upload",
"method": "PUT",
"headers": {
"content-type": "application/pdf"
},
"resumable": false
},
"upload_expires_at": "2026-10-06T09:20:00.000Z"
}
}Check and keep a signed copy#
POST/v1/documents/signatures.upload_signed.finishWrite
Finishes an upload started with documents_signatures_upload_signed_start: Bizisy checks the file with the EU DSS validation (against the EU trusted lists) and keeps it only if (a) it is this document, byte for byte, with every signature given before still in it; (b) each new signature is a valid qualified electronic signature (QES); (c) each new signature is from a signer who still has to sign (the name on the certificate matches the name in Bizisy; in turn when the request is ordered). The signed copy becomes a document of the person (the original's category and visibility), replaced by each newer copy; when everyone has signed it is extended to PAdES-B-LTA and the request is done. Errors say what to do: no signature (often "Print → Save as PDF", which drops it), not qualified, not this document, not the right person, changed after signing. A dry run checks only that the request and upload are open. Owners, admins and HR, only in the app (never through an API key or MCP).
- Web app only
- Refused for API keys and connected apps. Signed copies are uploaded by HR in the app.
- MCP tool
documents_signatures_upload_signed_finishon HR Assistant- 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_idstringrequiredupload_idstringrequired1–64 characters.
Returns
signatureobjectrequired21 fields
idstringrequiredproviderstring (enum)requiredHow it is signed: through the e-signature tool yousign, docusign, dropbox_sign, signaturit or skribble; autenticacao_gov: each signer signs the PDF in Autenticação.gov (Cartão de Cidadão or Chave Móvel Digital) and the signed file is uploaded to Bizisy, which checks it; bizisy_accept: Bizisy click-to-accept (the person accepts in Bizisy by typing their name).
One of:
yousign,docusign,dropbox_sign,signaturit,skribble,autenticacao_gov,bizisy_accept.document_idstringrequiredperson_idstring | nullrequiredpurpose"sign" | "receipt"receipt: the person confirms they received a written statement or change notice (proof of delivery), not a signature; sign (default): a signature.
statusstring (enum)requiredqueued: about to go to the e-signature tool; sending; ongoing: out for signature; done: everyone signed; declined; expired; canceled; failed: could not be sent (error says why; try again).
One of:
queued,sending,ongoing,done,declined,expired,canceled,failed.level"simple" | "advanced" | "qualified"requiredeIDAS level: simple (SES), advanced (AdES: the signer is uniquely identified, e.g. a code by SMS), qualified (QES: identity verified, e.g. by video; equivalent to a handwritten signature in every EU country).
orderedbooleanrequiredSigners sign one after the other, in the order listed.
signersobject[]required4 fields
role"person" | "manager" | "me" | "other"requiredperson: the person the document is about; manager: their manager; me: the HR member who sent it; other: anyone else chosen.
personobject | nullrequirednull once erased.
2 fields
idstringrequirednamestringrequired
status"waiting" | "notified" | "signed" | "declined" | "error"requiredwaiting: not their turn yet (or not sent); notified: the tool emailed them; signed; declined; error.
signed_atstring | nullrequired
remindersobject | nullrequired2 fields
interval_daysintegerrequiredmaxintegerrequired
expires_onstringrequiredsent_atstring | nullrequiredcompleted_atstring | nullrequiredsigned_document_idstring | nullrequiredThe signed copy, a document of the person (same category and visibility).
audit_document_idstring | nullrequiredThe signature audit trail (HR only); null for anyone else.
errorstring | nullrequiredcancel_requestedbooleanrequiredlast_reminded_atstring | nullrequiredcreated_atstringrequiredto_sign_document_idstring | nullSigning outside Bizisy (autenticacao_gov): the document the next signer downloads and signs: the original, or the partly signed copy once someone signed. null for the e-signature tools and once done.
checksobject[] | nullSigning outside Bizisy: what Bizisy checked in each signed upload (the EU DSS validation against the EU trusted lists). HR only; null for anyone else.
6 fields
atstringrequiredby"hr" | "self"requiredhr: uploaded by HR; self: by the signer in My workspace.
addedobject[]required7 fields
role"person" | "manager" | "me" | "other"requirednamestringrequiredThe name on the signing certificate.
levelstringrequiredETSI qualification: QESig is a qualified electronic signature.
qualifiedbooleanrequiredqscdbooleanrequiredMade on a qualified signature creation device (the citizen card chip, or the CMD remote HSM).
indicationstringrequiredsigning_timestring | nullrequired
signaturesintegerrequireddocument_timestampsintegerrequiredextendedbooleanrequiredThe signed copy was extended to PAdES-B-LTA (long-term validation data and a timestamp).
documentobjectrequiredThe signed copy (a document of the person: the original's category and visibility). It carries every signature given so far.
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
addedintegerrequiredSignatures this upload added.
completebooleanrequiredEvery signer has signed: the request is done and the copy was extended for long-term validation.
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/signatures.upload_signed.finish \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"signature_id":"sig_2","upload_id":"f9"}'const res = await fetch('https://api.bizisy.com/v1/documents/signatures.upload_signed.finish', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"signature_id": "sig_2",
"upload_id": "f9"
}),
});
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/signatures.upload_signed.finish",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"signature_id": "sig_2",
"upload_id": "f9",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"signature": {
"id": "sig_2",
"provider": "autenticacao_gov",
"document_id": "d1",
"person_id": "p1",
"status": "ongoing",
"level": "qualified",
"ordered": false,
"signers": [
{
"role": "other",
"person": {
"id": "p2",
"name": "Rui Costa"
},
"status": "signed",
"signed_at": "2026-10-06T09:00:00.000Z"
},
{
"role": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
},
"status": "notified",
"signed_at": null
}
],
"reminders": null,
"expires_on": "2026-11-05",
"sent_at": "2026-10-05T10:01:00.000Z",
"completed_at": null,
"signed_document_id": null,
"audit_document_id": null,
"error": null,
"cancel_requested": false,
"last_reminded_at": null,
"created_at": "2026-10-05T10:00:00.000Z",
"to_sign_document_id": "sig_2-signed",
"checks": [
{
"at": "2026-10-06T09:05:00.000Z",
"by": "hr",
"signatures": 1,
"document_timestamps": 0,
"extended": false,
"added": [
{
"role": "other",
"name": "RUI MANUEL COSTA",
"level": "QESig",
"qualified": true,
"qscd": true,
"indication": "TOTAL_PASSED",
"signing_time": "2026-10-06T09:00:00Z"
}
]
}
]
},
"document": {
"id": "sig_2-signed",
"title": "Contract 2026 (partly signed)",
"category": "Contract",
"subject": {
"kind": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
}
},
"visibility": "hr_person",
"uploaded_by": "hr",
"field": null,
"expires_on": null,
"notes": null,
"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": {
"document_id": "d1",
"kind": "signed"
}
},
"added": 1,
"complete": false
}
}Upload my signed document#
POST/v1/documents/me.signatures.upload_signed.startWrite
For a document you are asked to sign in Autenticação.gov: after signing the PDF there with your Cartão de Cidadão or Chave Móvel Digital, starts the upload of the file it saved. Then PUT the bytes to the signed URL within 15 minutes with exactly the returned headers, and call documents_me_signatures_upload_signed_finish with upload_id. PDF only, at most 20 MB. Only in the app (never through an API key or MCP).
- Web app only
- Refused for API keys and connected apps. People upload what they signed in the app.
- MCP tool
documents_me_signatures_upload_signed_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
signature_idstringrequiredfileobjectrequired4 fields
namestringrequiredThe file name, e.g. "Contract 2026.pdf" (kept as metadata only).
1–500 characters.
sizeintegerrequiredBytes, at most 20 MB.
From 0 to 20000000.
content_type"application/pdf"requiredapplication/pdf: the file Autenticação.gov saved.
sha256stringrequiredLowercase hex SHA-256 of the file; checked against the upload.
Pattern
^[0-9a-f]{64}$.
Returns
signatureobjectrequired21 fields
idstringrequiredproviderstring (enum)requiredHow it is signed: through the e-signature tool yousign, docusign, dropbox_sign, signaturit or skribble; autenticacao_gov: each signer signs the PDF in Autenticação.gov (Cartão de Cidadão or Chave Móvel Digital) and the signed file is uploaded to Bizisy, which checks it; bizisy_accept: Bizisy click-to-accept (the person accepts in Bizisy by typing their name).
One of:
yousign,docusign,dropbox_sign,signaturit,skribble,autenticacao_gov,bizisy_accept.document_idstringrequiredperson_idstring | nullrequiredpurpose"sign" | "receipt"receipt: the person confirms they received a written statement or change notice (proof of delivery), not a signature; sign (default): a signature.
statusstring (enum)requiredqueued: about to go to the e-signature tool; sending; ongoing: out for signature; done: everyone signed; declined; expired; canceled; failed: could not be sent (error says why; try again).
One of:
queued,sending,ongoing,done,declined,expired,canceled,failed.level"simple" | "advanced" | "qualified"requiredeIDAS level: simple (SES), advanced (AdES: the signer is uniquely identified, e.g. a code by SMS), qualified (QES: identity verified, e.g. by video; equivalent to a handwritten signature in every EU country).
orderedbooleanrequiredSigners sign one after the other, in the order listed.
signersobject[]required4 fields
role"person" | "manager" | "me" | "other"requiredperson: the person the document is about; manager: their manager; me: the HR member who sent it; other: anyone else chosen.
personobject | nullrequirednull once erased.
2 fields
idstringrequirednamestringrequired
status"waiting" | "notified" | "signed" | "declined" | "error"requiredwaiting: not their turn yet (or not sent); notified: the tool emailed them; signed; declined; error.
signed_atstring | nullrequired
remindersobject | nullrequired2 fields
interval_daysintegerrequiredmaxintegerrequired
expires_onstringrequiredsent_atstring | nullrequiredcompleted_atstring | nullrequiredsigned_document_idstring | nullrequiredThe signed copy, a document of the person (same category and visibility).
audit_document_idstring | nullrequiredThe signature audit trail (HR only); null for anyone else.
errorstring | nullrequiredcancel_requestedbooleanrequiredlast_reminded_atstring | nullrequiredcreated_atstringrequiredto_sign_document_idstring | nullSigning outside Bizisy (autenticacao_gov): the document the next signer downloads and signs: the original, or the partly signed copy once someone signed. null for the e-signature tools and once done.
checksobject[] | nullSigning outside Bizisy: what Bizisy checked in each signed upload (the EU DSS validation against the EU trusted lists). HR only; null for anyone else.
6 fields
atstringrequiredby"hr" | "self"requiredhr: uploaded by HR; self: by the signer in My workspace.
addedobject[]required7 fields
role"person" | "manager" | "me" | "other"requirednamestringrequiredThe name on the signing certificate.
levelstringrequiredETSI qualification: QESig is a qualified electronic signature.
qualifiedbooleanrequiredqscdbooleanrequiredMade on a qualified signature creation device (the citizen card chip, or the CMD remote HSM).
indicationstringrequiredsigning_timestring | nullrequired
signaturesintegerrequireddocument_timestampsintegerrequiredextendedbooleanrequiredThe signed copy was extended to PAdES-B-LTA (long-term validation data and a timestamp).
upload_idstringrequiredSend it to the finish call.
uploadobject | nullrequirednull on a dry run.
4 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.signatures.upload_signed.start \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"signature_id": "sig_2",
"file": {
"name": "Contract 2026_signed.pdf",
"size": 214000,
"content_type": "application/pdf",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
}'const res = await fetch('https://api.bizisy.com/v1/documents/me.signatures.upload_signed.start', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"signature_id": "sig_2",
"file": {
"name": "Contract 2026_signed.pdf",
"size": 214000,
"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.signatures.upload_signed.start",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"signature_id": "sig_2",
"file": {
"name": "Contract 2026_signed.pdf",
"size": 214000,
"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": {
"signature": {
"id": "sig_2",
"provider": "autenticacao_gov",
"document_id": "d1",
"person_id": "p1",
"status": "ongoing",
"level": "qualified",
"ordered": false,
"signers": [
{
"role": "other",
"person": {
"id": "p2",
"name": "Rui Costa"
},
"status": "signed",
"signed_at": "2026-10-06T09:00:00.000Z"
},
{
"role": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
},
"status": "notified",
"signed_at": null
}
],
"reminders": null,
"expires_on": "2026-11-05",
"sent_at": "2026-10-05T10:01:00.000Z",
"completed_at": null,
"signed_document_id": null,
"audit_document_id": null,
"error": null,
"cancel_requested": false,
"last_reminded_at": null,
"created_at": "2026-10-05T10:00:00.000Z",
"to_sign_document_id": "sig_2-signed",
"checks": null
},
"upload_id": "f9",
"upload": {
"url": "https://storage.example/upload",
"method": "PUT",
"headers": {
"content-type": "application/pdf"
},
"resumable": false
},
"upload_expires_at": "2026-10-06T09:20:00.000Z"
}
}Check and keep my signed document#
POST/v1/documents/me.signatures.upload_signed.finishWrite
Finishes your upload: Bizisy checks that the file is the document you were asked to sign, with your own qualified signature (the name on your certificate must match your name in Bizisy) and every earlier signature still in it, then keeps it as the signed copy in your documents and tells HR's view. When everyone has signed the request is done. Errors say what to do (for example, "Print → Save as PDF" removes the signature: upload the file Autenticação.gov saved). Only in the app (never through an API key or MCP).
- Web app only
- Refused for API keys and connected apps. People upload what they signed in the app.
- MCP tool
documents_me_signatures_upload_signed_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
signature_idstringrequiredupload_idstringrequired1–64 characters.
Returns
signatureobjectrequired21 fields
idstringrequiredproviderstring (enum)requiredHow it is signed: through the e-signature tool yousign, docusign, dropbox_sign, signaturit or skribble; autenticacao_gov: each signer signs the PDF in Autenticação.gov (Cartão de Cidadão or Chave Móvel Digital) and the signed file is uploaded to Bizisy, which checks it; bizisy_accept: Bizisy click-to-accept (the person accepts in Bizisy by typing their name).
One of:
yousign,docusign,dropbox_sign,signaturit,skribble,autenticacao_gov,bizisy_accept.document_idstringrequiredperson_idstring | nullrequiredpurpose"sign" | "receipt"receipt: the person confirms they received a written statement or change notice (proof of delivery), not a signature; sign (default): a signature.
statusstring (enum)requiredqueued: about to go to the e-signature tool; sending; ongoing: out for signature; done: everyone signed; declined; expired; canceled; failed: could not be sent (error says why; try again).
One of:
queued,sending,ongoing,done,declined,expired,canceled,failed.level"simple" | "advanced" | "qualified"requiredeIDAS level: simple (SES), advanced (AdES: the signer is uniquely identified, e.g. a code by SMS), qualified (QES: identity verified, e.g. by video; equivalent to a handwritten signature in every EU country).
orderedbooleanrequiredSigners sign one after the other, in the order listed.
signersobject[]required4 fields
role"person" | "manager" | "me" | "other"requiredperson: the person the document is about; manager: their manager; me: the HR member who sent it; other: anyone else chosen.
personobject | nullrequirednull once erased.
2 fields
idstringrequirednamestringrequired
status"waiting" | "notified" | "signed" | "declined" | "error"requiredwaiting: not their turn yet (or not sent); notified: the tool emailed them; signed; declined; error.
signed_atstring | nullrequired
remindersobject | nullrequired2 fields
interval_daysintegerrequiredmaxintegerrequired
expires_onstringrequiredsent_atstring | nullrequiredcompleted_atstring | nullrequiredsigned_document_idstring | nullrequiredThe signed copy, a document of the person (same category and visibility).
audit_document_idstring | nullrequiredThe signature audit trail (HR only); null for anyone else.
errorstring | nullrequiredcancel_requestedbooleanrequiredlast_reminded_atstring | nullrequiredcreated_atstringrequiredto_sign_document_idstring | nullSigning outside Bizisy (autenticacao_gov): the document the next signer downloads and signs: the original, or the partly signed copy once someone signed. null for the e-signature tools and once done.
checksobject[] | nullSigning outside Bizisy: what Bizisy checked in each signed upload (the EU DSS validation against the EU trusted lists). HR only; null for anyone else.
6 fields
atstringrequiredby"hr" | "self"requiredhr: uploaded by HR; self: by the signer in My workspace.
addedobject[]required7 fields
role"person" | "manager" | "me" | "other"requirednamestringrequiredThe name on the signing certificate.
levelstringrequiredETSI qualification: QESig is a qualified electronic signature.
qualifiedbooleanrequiredqscdbooleanrequiredMade on a qualified signature creation device (the citizen card chip, or the CMD remote HSM).
indicationstringrequiredsigning_timestring | nullrequired
signaturesintegerrequireddocument_timestampsintegerrequiredextendedbooleanrequiredThe signed copy was extended to PAdES-B-LTA (long-term validation data and a timestamp).
documentobjectrequiredThe signed copy (a document of the person: the original's category and visibility). It carries every signature given so far.
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
addedintegerrequiredSignatures this upload added.
completebooleanrequiredEvery signer has signed: the request is done and the copy was extended for long-term validation.
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/documents/me.signatures.upload_signed.finish \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"signature_id":"sig_2","upload_id":"f9"}'const res = await fetch('https://api.bizisy.com/v1/documents/me.signatures.upload_signed.finish', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"signature_id": "sig_2",
"upload_id": "f9"
}),
});
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.signatures.upload_signed.finish",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"signature_id": "sig_2",
"upload_id": "f9",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"signature": {
"id": "sig_2",
"provider": "autenticacao_gov",
"document_id": "d1",
"person_id": "p1",
"status": "done",
"level": "qualified",
"ordered": false,
"signers": [
{
"role": "other",
"person": {
"id": "p2",
"name": "Rui Costa"
},
"status": "signed",
"signed_at": "2026-10-07T10:00:00.000Z"
},
{
"role": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
},
"status": "signed",
"signed_at": "2026-10-07T10:00:00.000Z"
}
],
"reminders": null,
"expires_on": "2026-11-05",
"sent_at": "2026-10-05T10:01:00.000Z",
"completed_at": null,
"signed_document_id": "sig_2-signed",
"audit_document_id": null,
"error": null,
"cancel_requested": false,
"last_reminded_at": null,
"created_at": "2026-10-05T10:00:00.000Z",
"to_sign_document_id": null,
"checks": null
},
"document": {
"id": "sig_2-signed",
"title": "Contract 2026 (signed)",
"category": "Contract",
"subject": {
"kind": "person",
"person": {
"id": "p1",
"name": "Ana Ferreira"
}
},
"visibility": "hr_person",
"uploaded_by": "hr",
"field": null,
"expires_on": null,
"notes": null,
"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": {
"document_id": "d1",
"kind": "signed"
}
},
"added": 1,
"complete": true
}
}Something missing or wrong on this page? Write to hello@bizisy.com.