Skip to main content

Document Workflow

For each document state, a request is generated with the following body, varying only in the status description.


Notified States

NameDescription
CREATENotified when a document is created or a PDF is uploaded to the platform.
FINISHNotified when all parties have signed the document.
NOTIFICATIONNotified when a document participant has completed the signing process.
REJECTNotified when at least one signer has rejected the document.
REJECTEDIndicates the details of the process cancellation.
BLOCKEDNotified when a signer exceeds the identity validation attempts (3), requiring manual validation.
EXPIREDNotified when a document expires, only if an expiration date was set during creation.

🧪 Notification Examples

tip

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

Response Parameters

NameTypeDescription
codeStringDocument code.
nameStringDocument name.
signerStringSigner information, present only when the status is NOTIFICATION, BLOCKED, or REJECTED.
urlStringDocument URL.
statusStringCurrent status of the signing process (e.g., SIGNED, REJECTED, BLOCKED, etc.)
messageStringText content associated with the signer’s status. If the status is REJECTED, contains the individual message written by the participant. For BLOCKED, see list of blocking states.
tagsArrayList of tags assigned to the document, if defined during creation.
customArrayList of custom fields registered in the document, if specified.

Process Creation

{
"code": "DOCUMENTCODE", //Código del documento
"name": "Contrato de prueba del API", //Nombre del documento
"status": "CREATE", //Estado del documento
"url": "https://test.auco.ai/contrato-de-prueba-id-98-DOCUMENTCODE.pdf" // url del documento
}

Process Completion

{
"code": "DOCUMENTCODE",
"name": "Contrato de prueba del API",
"status": "FINISH",
"url": "https://test.auco.ai/contrato-de-prueba-id-98-DOCUMENTCODE.pdf" // url del documento
}

Signer Blocked

{
"name": "document name",
"signer": {
"id": "participan_id",
"name": "participant name",
"email": "email",
"phone": "phone"
},
"status": "REJECTED",
"message": "OTP_CODE_INVALID",
"tags": ["document tag"],
"custom": ["{'info':'required', 'definition': 'urgent'}"]
}

Rejection Details

{
"name": "document name",
"signer": {
"id": "participan_id",
"name": "participant name",
"email": "email",
"phone": "phone"
},
"status": "REJECTED",
"message": "message",
"tags": ["document tags"]
}

Process Expiration

{
"code": "DOCUMENTCODE",
"name": "Contrato de prueba del API",
"status": "EXPIRED",
"url": "https://test.auco.ai/contrato-de-prueba-id-98-DOCUMENTCODE.pdf",
"tags": ["document tag"],
"custom": ["{'info':'required', 'definition': 'urgent'}"]
}