Skip to main content

Create a Signature Package

POST /document/many

This service allows you to generate a package of documents from an Auco template or a PDF file. Once the process is completed, you will receive each document with its own signature certificate.

info

Before integrating this endpoint, you may need to see how to define signature positions and identity validation settings.

warning

The documents array must contain at least 2 elements. If you only need a single document, use the POST /document/upload endpoint.

Steps to create a document package through an automated template:

  1. Query available templates or custom documents.
  2. Obtain the _id of the base document.
  3. Query required variables of the selected document.
  4. Construct and send the creation request.
info

If you want to do it using a PDF, it is not necessary to send the file in the initial request. At the end, a signed URL will be returned for each document in the package.

Below are the required parameters for this service, along with examples and possible system responses.


Authentication

Include your private key in the Authorization header.

Authorization: prk_xxx...

Creation Parameters

NameTypeRequiredDescription
emailStringRequiredEmail address of the process creator.
documentStringConditionalID of the custom document or Auco template. Only required if you want to use a template.
nameStringRequiredName of the document signing process. Required if the process includes document signing.
messageStringRequiredMessage that will be sent in the body of the email notifying signers or approvers of the document.
subjectStringRequiredSubject with which the notification email will be sent to signers or approvers.
folderStringConditionalIf you want to save this process in a specific folder, specify the path here. The folder must exist and belong to the process creator.
rememberNumberConditionalEnables automatic reminders with the time interval (in hours) between each notification. Must be a multiple of 3.
expiredDateDateOptionalExpiration date of the document. Must be at least 3 days after the process creation date and is sent in JSON Date format.
cameraBooleanOptionalIndicates if photo validation is required. Default is false.
otpCodeBooleanOptionalIndicates if OTP code validation is required. Default is false.
optionsObjectOptionalSpecifies identity validation settings. See more
notificationBooleanOptionalDefines whether Auco notifies participants once the process is created. Default is true. If set to false, the response includes an id for each signer (grouped by email across all documents) that lets the integrator handle notifications externally.
customObjectOptionalFree-form object to send integrator-defined parameters (for example, internal identifiers or metadata). Auco stores it as-is and forwards it in webhook notifications and in the GET /document response, without interpreting or validating its contents. Applies to the whole package.
dataArrayConditionalContains all the data required by the template to generate the document. Only required if using a template.
data[x].keyStringRequiredName of the parameter registered in the template.
data[x].valueStringRequiredValue assigned to the parameter.
documents *ArrayRequiredList of objects, each representing a document in the package.
documents[0].nameStringRequiredName of the document.
documents[0].readersArrayOptionalList of objects defining participants who are not part of the signing process but should observe each phase of the signing process.
documents[0].readers[x].nameStringRequiredName of the reader.
documents[0].readers[x].emailStringRequiredEmail address of the reader.
documents[0].signProfileArrayRequiredList of objects containing information for each signer or approver for notification and signing.
documents[0].signProfile[x].nameStringRequiredName of the signer.
documents[0].signProfile[x].emailStringRequiredEmail address of the signer.
documents[0].signProfile[x].phoneStringRequiredPhone number of the signer.
documents[0].signProfile[x].roleStringConditionalDefines the participant's role, can be 'APPROVER' or 'SIGNER'.
documents[0].signProfile[x].orderStringConditionalDefines the order in which the notification process for signing or approval will occur.
documents[0].signProfile[x].positionArrayConditionalSignature positions for this signer on each page. Signature positions can be preloaded in templates. See more in how to define signature positions.
documents[0].signProfile[x].typeArrayConditionalName used to identify the signer type if pre-saved in a template, e.g.: 'co-signer'.
documents[0].signProfile[x].labelBooleanConditionalIndicates if signature positioning will be done using labels in the PDF.
documents[0].signProfile[x].optionsObjectOptionalAllows defining custom validations for a specific signer. To apply validations individually per signer, see more.
documents[0].signProfile[x].cameraBooleanOptionalIf you want individual validations per signer and require photo or video validation, set this parameter to true. Default is false.
documents[0].signProfile[x].otpCodeBooleanOptionalIf you want individual validations per signer and require OTP validation, set this parameter to true. Default is false.
documents[0].signProfile[x].bothBooleanOptionalIf you want individual validations per signer and require the signing process to be possible via WhatsApp and/or email, set this parameter to true. Default is false.
documents[0].signProfile[x].notificationBooleanOptionalOnly applies when the global notification parameter is false. If a signer is sent with notification: true, Auco takes care of notifying them and no id will be assigned in the response.

🧪 Usage Examples

tip

You can copy any of the examples according to your preferred programming language.

  • Email addresses and phone numbers among signers must not repeat.
  • Readers will receive notifications for every update in the signature process.
  • Date format: 'DD/MM/YYYY'
  • Phone numbers must include the country code, e.g.: +57, +1, +52...

Document Package via PDF

curl --location 'https://dev.auco.ai/v1/ext/document/many' \
--header 'Authorization: prk_e1cd6a01ecdb4b4ea72ec118e33b18de' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Prueba paquete 2 documentos",
"email": "example@auco.ai",
"message": "Hola a todos, les comparto el paquete de documentos para la firma",
"options": {
"camera": "identification",
"whatsapp": true
},
"camera": true,
"otpCode": false,
"documents": [
{
"name": "Documento 1",
"signProfile": [
{
"type": "solicitante",
"name": "Firmante 1",
"phone": "+573000000000",
"email": "example1@auco.ai"
}
]
},
{
"name": "Documento 2",
"signProfile": [
{
"type": "solicitante",
"name": "Firmante 1",
"phone": "+573000000000",
"email": "example2@auco.ai"
}
]
}
]
}

Document Package via Custom Templates

curl --location 'https://dev.auco.ai/v1/ext/document/many' \
--header 'Authorization: prk_e1cd6a01ecdb4b4ea72ec118e33b18de' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Prueba notification2",
"email": "example@auco.ai",
"message": "Hola a todos, les comparto el paquete de documentos para la firma",
"options": {
"camera": "identification",
"whatsapp": true
},
"camera": true,
"otpCode": false,
"documents": [
{
"name": "Documento 1",
"document": "documentId",
"data": [
{"key": "signer_nombre", "value":"firmante 1"},
{"key": "signer_identification", "value":"cc"},
{"key": "signer_phone", "value":"+573000000000"},
{"key": "manager_name", "value":"manager 1"}
]
},
{
"name": "Documento 2",
"document": "documentId",
"data": [
{"key": "signer_nombre", "value":"firmante 1"},
{"key": "signer_identification", "value":"cc"},
{"key": "signer_phone", "value":"+573000000000"},
{"key": "manager_name", "value":"manager 1"}
]
}
]
}'

📥 Response Examples

Document Package via PDF

{
"id": "packageId",
"documents": [
{
"url": "https://signed_url_to_upload_PDF",
"name": "Documento 1",
"code": "CODEDOC1"
},
{
"url": "https://signed_url_to_upload_PDF",
"name": "Documento 2",
"code": "CODEDOC2"
}
]
}
info

The signed URL provided in the response is single-use and available only for 5 seconds. It must be used to upload the PDF document in binary format via an HTTP PUT request.

Via Custom Templates

{
"id": "packageId",
"documents": [
{
"name": "Documento 1",
"code": "CODEDOC1"
},
{
"name": "Documento 2",
"code": "CODEDOC2"
}
]
}

🔹 With notification: false

When notification: false is sent, each signer receives an id that the integrator can use to build their own notification flow. Signers are grouped by email: if the same email appears in multiple documents, it receives the same id in all of them.

If a specific signer inside signProfile is marked with notification: true, Auco takes care of notifying them and no id is assigned.

{
"id": "packageId",
"documents": [
{
"url": "https://signed_url_to_upload_PDF",
"name": "Documento 1",
"code": "GNAZED5HTR",
"signProfile": [
{ "id": "0Q", "name": "Alejandro", "email": "alejandro@auco.ai" },
{ "name": "Rector", "email": "rector@auco.ai" }
]
},
{
"url": "https://signed_url_to_upload_PDF",
"name": "Documento 2",
"code": "RC0OO75VL7",
"signProfile": [
{ "id": "0Q", "name": "Alejandro", "email": "alejandro@auco.ai" },
{ "name": "Rector", "email": "rector@auco.ai" }
]
}
]
}
FieldTypeDescription
documents[x].signProfileArrayList of signers for the document.
documents[x].signProfile[y].idStringUnique identifier of the signer. Only present when Auco will not notify that signer.
documents[x].signProfile[y].nameStringName of the signer.
documents[x].signProfile[y].emailStringEmail of the signer.

⚠️ Error Responses

CodeDescription
400Missing parameters, or one or more validations do not meet the applicability conditions.
400DOCUMENTS_MIN_TWO — The documents array must have at least 2 elements. Use /document/upload for a single document.
401Invalid or missing authentication.