API Documentation


Download complete Swagger file here.

Endpoints

About

Save to temporary directory the file with bytes sent in request.

Request Body
Name

document *required

(body)

Description

Document data to be uploaded.

Example Value


            {
                "fileName": "PDF-Teste.pdf",
                "bytes": [
                    37,
                    80,
                    68,
                    70,
                    45,
                    49,
                    46,
                    52,
                    10,
                    37,
                    226,
                    227,
                    207,
                    211,
                    10,
                    50,
                    32,
                    48,
                    32,
                    111,
                    98,
                    106,
                    10,
                    60,
                    60,
                    47,
                    76,
                    101,
                    110,
                    103,
                    116,
                    104,
                    32,
                    55,
                    49,
                    47,
                    70,
                    105,
                    108,
                    116,
                    101,
                    114,
                    47,
                    70,
                    108,
                    97,
                    116,
                    101,
                    68,
                    101,
                    99,
                    111,
                    100,
                    101,
                    62,
                    62,
                    115,
                    116,
                    114,
                    101,
                    97,
                    109,
                    10,
                    120,
                    156,
                    43,
                    228,
                    114,
                    10,
                    225,
                    50,
                    54,
                    83,
                    176,
                    48,
                    48,
                    83,
                    8,
                    73,
                    225,
                    50,
                    80,
                    208,
                    53,
                    180,
                    0,
                    49,
                    244,
                    221,
                    12,
                    21,
                    12,
                    141,
                    20,
                    66,
                    210,
                    184,
                    52,
                    156,
                    83,
                    243,
                    30,
                    22,
                    101,
                    230,
                    43,
                    24,
                    42,
                    232,
                    42,
                    184,
                    36,
                    166,
                    228,
                    23,
                    107,
                    134,
                    100,
                    1,
                    21,
                    26,
                    128,
                    148,
                    185,
                    134,
                    112,
                    5,
                    114,
                    1,
                    0,
                    34,
                    4,
                    16,
                    93,
                    10,
                    101,
                    110,
                    100,
                    115,
                    116,
                    114,
                    101,
                    97,
                    109,
                    10,
                    101,
                    110,
                    100,
                    111,
                    98,
                    106,
                    10,
                    52,
                    32,
                    48,
                    32,
                    111,
                    98,
                    106,
                    10,
                    60,
                    60,
                    47,
                    80,
                    97,
                    114,
                    101,
                    110,
                    116,
                    32,
                    51,
                    32,
                    48,
                    32,
                    82,
                    47,
                    67,
                    111,
                    110,
                    116,
                    101,
                    110,
                    116,
                    115,
                    32,
                    50,
                    32,
                    48,
                    32,
                    82,
                    47,
                    84,
                    121,
                    112,
                    101,
                    47,
                    80,
                    97,
                    103,
                    101,
                    47,
                    82,
                    101,
                    115,
                    111,
                    117,
                    114,
                    99,
                    101,
                    115,
                    60,
                    60,
                    47,
                    70,
                    111,
                    110,
                    116,
                    60,
                    60,
                    47,
                    70,
                    49,
                    32,
                    49,
                    32,
                    48,
                    32,
                    82,
                    62,
                    62,
                    62,
                    62,
                    47,
                    77,
                    101,
                    100,
                    105,
                    97,
                    66,
                    111,
                    120,
                    91,
                    48,
                    32,
                    48,
                    32,
                    53,
                    57,
                    53,
                    32,
                    56,
                    52,
                    50,
                    93,
                    62,
                    62,
                    10,
                    101,
                    110,
                    100,
                    111,
                    98,
                    106,
                    10,
                    49,
                    32,
                    48,
                    32,
                    111,
                    98,
                    106,
                    10,
                    60,
                    60,
                    47,
                    66,
                    97,
                    115,
                    101,
                    70,
                    111,
                    110,
                    116,
                    47,
                    72,
                    101,
                    108,
                    118,
                    101,
                    116,
                    105,
                    99,
                    97,
                    47,
                    84,
                    121,
                    112,
                    101,
                    47,
                    70,
                    111,
                    110,
                    116,
                    47,
                    69,
                    110,
                    99,
                    111,
                    100,
                    105,
                    110,
                    103,
                    47,
                    87,
                    105,
                    110,
                    65,
                    110,
                    115,
                    105,
                    69,
                    110,
                    99,
                    111,
                    100,
                    105,
                    110,
                    103,
                    47,
                    83,
                    117,
                    98,
                    116,
                    121,
                    112,
                    101,
                    47,
                    84,
                    121,
                    112,
                    101,
                    49,
                    62,
                    62,
                    10,
                    101,
                    110,
                    100,
                    111,
                    98,
                    106,
                    10,
                    51,
                    32,
                    48,
                    32,
                    111,
                    98,
                    106,
                    10,
                    60,
                    60,
                    47,
                    84,
                    121,
                    112,
                    101,
                    47,
                    80,
                    97,
                    103,
                    101,
                    115,
                    47,
                    67,
                    111,
                    117,
                    110,
                    116,
                    32,
                    49,
                    47,
                    75,
                    105,
                    100,
                    115,
                    91,
                    52,
                    32,
                    48,
                    32,
                    82,
                    93,
                    62,
                    62,
                    10,
                    101,
                    110,
                    100,
                    111,
                    98,
                    106,
                    10,
                    53,
                    32,
                    48,
                    32,
                    111,
                    98,
                    106,
                    10,
                    60,
                    60,
                    47,
                    84,
                    121,
                    112,
                    101,
                    47,
                    67,
                    97,
                    116,
                    97,
                    108,
                    111,
                    103,
                    47,
                    80,
                    97,
                    103,
                    101,
                    115,
                    32,
                    51,
                    32,
                    48,
                    32,
                    82,
                    62,
                    62,
                    10,
                    101,
                    110,
                    100,
                    111,
                    98,
                    106,
                    10,
                    54,
                    32,
                    48,
                    32,
                    111,
                    98,
                    106,
                    10,
                    60,
                    60,
                    47,
                    80,
                    114,
                    111,
                    100,
                    117,
                    99,
                    101,
                    114,
                    40,
                    105,
                    84,
                    101,
                    120,
                    116,
                    174,
                    32,
                    53,
                    46,
                    53,
                    46,
                    50,
                    32,
                    169,
                    50,
                    48,
                    48,
                    48,
                    45,
                    50,
                    48,
                    49,
                    52,
                    32,
                    105,
                    84,
                    101,
                    120,
                    116,
                    32,
                    71,
                    114,
                    111,
                    117,
                    112,
                    32,
                    78,
                    86,
                    32,
                    92,
                    40,
                    65,
                    71,
                    80,
                    76,
                    45,
                    118,
                    101,
                    114,
                    115,
                    105,
                    111,
                    110,
                    92,
                    41,
                    41,
                    47,
                    77,
                    111,
                    100,
                    68,
                    97,
                    116,
                    101,
                    40,
                    68,
                    58,
                    50,
                    48,
                    49,
                    52,
                    49,
                    49,
                    49,
                    55,
                    49,
                    53,
                    51,
                    48,
                    49,
                    55,
                    45,
                    48,
                    50,
                    39,
                    48,
                    48,
                    39,
                    41,
                    47,
                    67,
                    114,
                    101,
                    97,
                    116,
                    105,
                    111,
                    110,
                    68,
                    97,
                    116,
                    101,
                    40,
                    68,
                    58,
                    50,
                    48,
                    49,
                    52,
                    49,
                    49,
                    49,
                    55,
                    49,
                    53,
                    51,
                    48,
                    49,
                    55,
                    45,
                    48,
                    50,
                    39,
                    48,
                    48,
                    39,
                    41,
                    62,
                    62,
                    10,
                    101,
                    110,
                    100,
                    111,
                    98,
                    106,
                    10,
                    120,
                    114,
                    101,
                    102,
                    10,
                    48,
                    32,
                    55,
                    10,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    32,
                    54,
                    53,
                    53,
                    51,
                    53,
                    32,
                    102,
                    32,
                    10,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    50,
                    54,
                    52,
                    32,
                    48,
                    48,
                    48,
                    48,
                    48,
                    32,
                    110,
                    32,
                    10,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    49,
                    53,
                    32,
                    48,
                    48,
                    48,
                    48,
                    48,
                    32,
                    110,
                    32,
                    10,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    51,
                    53,
                    50,
                    32,
                    48,
                    48,
                    48,
                    48,
                    48,
                    32,
                    110,
                    32,
                    10,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    49,
                    53,
                    50,
                    32,
                    48,
                    48,
                    48,
                    48,
                    48,
                    32,
                    110,
                    32,
                    10,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    52,
                    48,
                    51,
                    32,
                    48,
                    48,
                    48,
                    48,
                    48,
                    32,
                    110,
                    32,
                    10,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    48,
                    52,
                    52,
                    56,
                    32,
                    48,
                    48,
                    48,
                    48,
                    48,
                    32,
                    110,
                    32,
                    10,
                    116,
                    114,
                    97,
                    105,
                    108,
                    101,
                    114,
                    10,
                    60,
                    60,
                    47,
                    82,
                    111,
                    111,
                    116,
                    32,
                    53,
                    32,
                    48,
                    32,
                    82,
                    47,
                    73,
                    68,
                    32,
                    91,
                    60,
                    52,
                    49,
                    55,
                    102,
                    50,
                    51,
                    51,
                    102,
                    102,
                    100,
                    51,
                    55,
                    54,
                    48,
                    48,
                    99,
                    54,
                    57,
                    51,
                    97,
                    48,
                    51,
                    51,
                    101,
                    49,
                    52,
                    50,
                    57,
                    51,
                    48,
                    100,
                    102,
                    62,
                    60,
                    52,
                    49,
                    55,
                    102,
                    50,
                    51,
                    51,
                    102,
                    102,
                    100,
                    51,
                    55,
                    54,
                    48,
                    48,
                    99,
                    54,
                    57,
                    51,
                    97,
                    48,
                    51,
                    51,
                    101,
                    49,
                    52,
                    50,
                    57,
                    51,
                    48,
                    100,
                    102,
                    62,
                    93,
                    47,
                    73,
                    110,
                    102,
                    111,
                    32,
                    54,
                    32,
                    48,
                    32,
                    82,
                    47,
                    83,
                    105,
                    122,
                    101,
                    32,
                    55,
                    62,
                    62,
                    10,
                    37,
                    105,
                    84,
                    101,
                    120,
                    116,
                    45,
                    53,
                    46,
                    53,
                    46,
                    50,
                    10,
                    115,
                    116,
                    97,
                    114,
                    116,
                    120,
                    114,
                    101,
                    102,
                    10,
                    54,
                    48,
                    53,
                    10,
                    37,
                    37,
                    69,
                    79,
                    70,
                    10
                ]
            }
Response
Code

200

Description

Ok

Example Value


            {
                "uploadId": "string"
            }

About

Submits a document whose upload was conducted previously. It's possible submit a document to Digital, Electronic or Server signature, using the respective attributes signers, electronicSigners or serverSigners.

Request Body
Name

document *required

(body)

Description

Example Value


            {
                "typeId": 0,
                "document": {
                    "name": "string",
                    "upload": {
                    "id": "string",
                    "name": "string"
                    }
                },
                "fields": [
                    {
                    "valueId": 0,
                    "value": "string",
                    "id": 0,
                    "name": "string"
                    }
                ],
                "attachments": [
                    {
                    "associatedAttachmentId": 0,
                    "description": "string",
                    "upload": {
                        "id": "string",
                        "name": "string"
                    },
                    "bytes": [
                        0
                    ]
                    }
                ],
                "accountId": 0,
                "folderId": 0,
                "signatureFormatId": 0,
                "callback": true,
                "sender": {
                    "name": "string",
                    "email": "string",
                    "individualIdentificationCode": "string"
                },
                "signers": [
                    {
                    "id": 0,
                    "title": "string",
                    "step": 0,
                    "uid": "string",
                    "name": "string",
                    "email": "string",
                    "individualIdentificationCode": "string"
                    }
                ],
                "electronicSigners": [
                    {
                    "id": 0,
                    "title": "string",
                    "step": 0,
                    "uid": "string",
                    "name": "string",
                    "email": "string",
                    "individualIdentificationCode": "string",
                    "inPerson": true,
                    "identificationType": {
                        "accessCode": true
                    },
                    "accessCode": "string"
                    }
                ],
                "serverSigners": [
                    {
                    "step": 0,
                    "certificateId": 0
                    }
                ],
                "observers": [
                    {
                    "id": 0,
                    "title": "string",
                    "step": 0,
                    "uid": "string",
                    "name": "string",
                    "email": "string",
                    "individualIdentificationCode": "string"
                    }
                ],
                "finishers": [
                    {
                    "id": 0,
                    "title": "string",
                    "step": 0,
                    "uid": "string",
                    "name": "string",
                    "email": "string",
                    "individualIdentificationCode": "string"
                    }
                ],
                "representatives": [
                    {
                    "id": 0,
                    "title": "string",
                    "step": 0,
                    "signatureDeadlineInWorkdays": "string",
                    "signatureDeadlineDate": "string"
                    }
                ],
                "globalObservers": [
                    {
                    "id": 0,
                    "uid": "string",
                    "name": "string",
                    "email": "string",
                    "individualIdentificationCode": "string"
                    }
                ],
                "recipients": {
                    "emails": "string",
                    "attached": true
                },
                "notifiedList": {
                    "emails": "string",
                    "message": "string"
                },
                "tags": [
                    "string"
                ]
            }
Response
Code

200

Description

Ok

Example Value


            {
                "id": "string",
                "signUrl": "string",
                "inProcessing": true
            }

About

Submits a batch of documents.

Request Body
Name

documents *required

(body)

Description

Document batch to be created.

Example value

                                
    {
        "documents": [
            {
            "typeId": 0,
            "document": {
                "name": "string",
                "upload": {
                "id": "string",
                "name": "string"
                }
            },
            "fields": [
                {
                "valueId": 0,
                "value": "string",
                "id": 0,
                "name": "string"
                }
            ],
            "attachments": [
                {
                "associatedAttachmentId": 0,
                "description": "string",
                "upload": {
                    "id": "string",
                    "name": "string"
                },
                "bytes": [
                    0
                ]
                }
            ],
            "accountId": 0,
            "folderId": 0,
            "signatureFormatId": 0,
            "callback": true,
            "sender": {
                "name": "string",
                "email": "string",
                "individualIdentificationCode": "string"
            },
            "signers": [
                {
                "id": 0,
                "title": "string",
                "step": 0,
                "uid": "string",
                "name": "string",
                "email": "string",
                "individualIdentificationCode": "string"
                }
            ],
            "electronicSigners": [
                {
                "id": 0,
                "title": "string",
                "step": 0,
                "uid": "string",
                "name": "string",
                "email": "string",
                "individualIdentificationCode": "string",
                "inPerson": true,
                "identificationType": {
                    "accessCode": true
                },
                "accessCode": "string"
                }
            ],
            "serverSigners": [
                {
                "step": 0,
                "certificateId": 0
                }
            ],
            "observers": [
                {
                "id": 0,
                "title": "string",
                "step": 0,
                "uid": "string",
                "name": "string",
                "email": "string",
                "individualIdentificationCode": "string"
                }
            ],
            "finishers": [
                {
                "id": 0,
                "title": "string",
                "step": 0,
                "uid": "string",
                "name": "string",
                "email": "string",
                "individualIdentificationCode": "string"
                }
            ],
            "representatives": [
                {
                "id": 0,
                "title": "string",
                "step": 0,
                "signatureDeadlineInWorkdays": "string",
                "signatureDeadlineDate": "string"
                }
            ],
            "globalObservers": [
                {
                "id": 0,
                "uid": "string",
                "name": "string",
                "email": "string",
                "individualIdentificationCode": "string"
                }
            ],
            "recipients": {
                "emails": "string",
                "attached": true
            },
            "notifiedList": {
                "emails": "string",
                "message": "string"
            },
            "tags": [
                "string"
            ]
            }
        ]
        }
Response
Code

200

Description

Ok

About

Retrieves a ZIP file containing: 1. If the file is PDF: the original document, the document with the manifesto of the collected signatures and the PKCS7 file. 2. Otherwise: the original document , a PDF document with the manifesto of the collected signatures and the PKCS7 file.

Parameters
Name

key *required
string (query)

includeOriginal *required
boolean (query)

Description

Document key.

Indicates whether the original document should be included if the filetype is PDF.

Response
Code

200

Description

Ok

Example Value

                                
    {
        "bytes": [
            0
        ],
        "name": "string",
        "mimeType": "string"
    }

Models

Name Type Description
fileName string Document name to be uploaded.
bytes [integer($int32)] Document bytes.

Name Type Description
type integer($int32) Document type. Use value 1.
document 
                                        
    {
        "name": {
            "type": "string",
            "description": "Document name."
        },
        "upload": {
            "id": {
                "type": "string",
                "description": "Document upload ID."
                },
            "name": {
                "type": "string",
                "description": "Document name to be uploaded."
            }
        }
    }
Document info.
fields 
                                        
    {
        "valueId": {
            "type": "integer",
            "format": "int32",
            "description": "Field value ID."
        },
        "value": {
            "type": "string",
            "description": "Field value."
        },
        "id": {
            "type": "integer",
            "format": "int32",
            "description": "Field ID."
        },
        "name": {
            "type": "string",
            "description": "Field name."
        }
    }
Document fields.
attachments 
                                        
    {
        "associatedAttachmentId": {
            "type": "integer",
            "format": "int32",
            "description": "Document name."
        },
        "description": {
            "type": "string",
            "description": "Document name."
        },
        "upload": {
            "id": {
                "type": "string",
                "description": "Document upload ID."
            },
            "name": {
                "type": "string",
                "description": "Document name to be uploaded."
            }
        },
        "bytes": {
            "type": "array",
            "items": {
                "type": "integer",
                "format": "int32"
            },
            "description": "Atachment byte array."
        }
    }
Document attachments.
accountId integer($int32) Account ID.
folderId integer($int32) Folder ID.
signatureFormatId integer($int32) Signature format ID.
callback boolean If document has a callback.
sender 
                                        
    {
        "name": {
            "type": "string",
            "description": "Sender name."
        },
        "email": {
            "type": "string",
            "description": "Sender e-mail."
        },
        "individualIdentificationCode": {
            "type": "string",
            "description": "Sender individual identification code."
        }
    }
Sender info.
signers 
                                        
    {
        "id": {
            "type": "integer",
            "format": "int64",
            "description": "Signer ID."
        },
        "title": {
            "type": "string",
            "description": "Signer title."
        },
        "step": {
            "type": "integer",
            "format": "int32",
            "description": "Step number."
        },
        "uid": {
            "type": "string",
            "description": "Signer UUID."
        },
        "name": {
            "type": "string",
            "description": "Signer name."
        },
        "email": {
            "type": "string",
            "description": "Signer e-mail."
        },
            "individualIdentificationCode": {
            "type": "string",
            "description": "Signer individual identification code."
        }
    }
Document signer list.
electronicSigners 
                                        
    {
        "id": {
        "type": "integer",
        "format": "int64",
        "description": "Signer ID."
        },
        "title": {
        "type": "string",
        "description": "Signer title."
        },
        "step": {
        "type": "integer",
        "format": "int32",
        "description": "Step number."
        },
        "uid": {
        "type": "string",
        "description": "Signer UUID."
        },
        "name": {
        "type": "string",
        "description": "Signer name."
        },
        "email": {
        "type": "string",
        "description": "Signer e-mail."
        },
        "individualIdentificationCode": {
        "type": "string",
        "description": "Signer individual identification code."
        },
        "inPerson": {
        "type": "boolean",
        "description": "Defines if the signature will be In Person or Remote"
        },
        "identificationType": {
        "accessCode": {
            "type": "boolean",
            "description": "Defines the kind of Identification"
            }
        },
        "accessCode": {
        "type": "string",
        "description": "Access Code to identification."
        }
    }
Document signer list.
serverSigners 
                                        
    {
        "step": {
            "type": "integer",
            "format": "int32",
            "description": "Step number."
        },
        "certificateId": {
            "type": "integer",
            "format": "int64",
            "description": "Certificate ID."
        }
    }
Document signer list.
observers 
                                        
    {
        "id": {
            "type": "integer",
            "format": "int64",
            "description": "Signer ID."
        },
        "title": {
            "type": "string",
            "description": "Signer title."
        },
        "step": {
            "type": "integer",
            "format": "int32",
            "description": "Step number."
        },
        "uid": {
            "type": "string",
            "description": "Signer UUID."
        },
        "name": {
            "type": "string",
            "description": "Signer name."
        },
        "email": {
            "type": "string",
            "description": "Signer e-mail."
        },
        "individualIdentificationCode": {
            "type": "string",
            "description": "Signer individual identification code."
        }
    }
Document observer list.
finishers 
                                        
    {
        "id": {
            "type": "integer",
            "format": "int64",
            "description": "Signer ID."
        },
        "title": {
            "type": "string",
            "description": "Signer title."
        },
        "step": {
            "type": "integer",
            "format": "int32",
            "description": "Step number."
        },
        "uid": {
            "type": "string",
            "description": "Signer UUID."
        },
        "name": {
            "type": "string",
            "description": "Signer name."
        },
        "email": {
            "type": "string",
            "description": "Signer e-mail."
        },
        "individualIdentificationCode": {
            "type": "string",
            "description": "Signer individual identification code."
        }
    }
Document finisher list.
representatives 
                                        
    {
        "id": {
            "type": "integer",
            "format": "int64",
            "description": "Signer ID."
        },
        "title": {
            "type": "string",
            "description": "Signer title."
        },
        "step": {
            "type": "integer",
            "format": "int32",
            "description": "Step number."
        },
        "signatureDeadlineInWorkdays": {
            "type": "string",
            "description": "Signer name."
        },
        "signatureDeadlineDate": {
            "type": "string",
            "description": "Signer e-mail."
        }
    }
Document representative list.
globalObservers 
                                        
    {
        "id": {
            "type": "integer",
            "format": "int64",
            "description": "Signer ID."
        },
        "uid": {
            "type": "string",
            "description": "Signer UUID."
        },
        "name": {
            "type": "string",
            "description": "Signer name."
        },
        "email": {
            "type": "string",
            "description": "Signer e-mail."
        },
        "individualIdentificationCode": {
            "type": "string",
            "description": "Signer individual identification code."
        }
    }
Global observers
recipients 
                                        
    {
        "emails": {
            "type": "string",
            "description": "Emails comma-separated."
        },
        "attached": {
            "type": "boolean",
            "description": "Attach the document."
        }
    }
Recipients
notifiedList 
                                        
    {
        "emails": {
            "type": "string",
            "description": "Emails comma-separated."
        },
        "message": {
            "type": "string",
            "description": "Notification message."
        }
    }
Notified list
tags [string] Document name to be uploaded

Name Type Description
documents 
                                            
 [   
    {
        "typeId": {
            "type": "integer",
            "format": "int32",
            "description": "Document type. Use value 1."
        },
        "document": {
            "name": {
                "type": "string",
                "description": "Document name."
            },
            "upload": {
                "id": {
                    "type": "string",
                    "description": "Document upload ID."
                },
                "name": {
                    "type": "string",
                    "description": "Document name to be uploaded."
                }
            }
        },
        "fields": {
            "type": "array",
        "items": {
            "valueId": {
                "type": "integer",
                "format": "int32",
                "description": "Field value ID."
            },
            "value": {
                "type": "string",
                "description": "Field value."
            },
            "id": {
                "type": "integer",
                "format": "int32",
                "description": "Field ID."
            },
            "name": {
                "type": "string",
                "description": "Field name."
            }
        },
        "description": "Document fields."
        },
        "attachments": {
            "type": "array",
        "items": {
            "associatedAttachmentId": {
                "type": "integer",
                "format": "int32",
                "description": "Document name."
            },
            "description": {
                "type": "string",
                "description": "Document name."
            },
            "upload": {
                "id": {
                    "type": "string",
                    "description": "Document upload ID."
                },
                "name": {
                    "type": "string",
                    "description": "Document name to be uploaded."
                }
            },
            "bytes": {
                "type": "array",
                "items": {
                  "type": "integer",
                  "format": "int32"
                },
                "description": "Atachment byte array."
            }
        },
        "description": "Document attachments."
        },
        "accountId": {
            "type": "integer",
            "format": "int32",
            "description": "Account ID."
        },
        "folderId": {
            "type": "integer",
            "format": "int32",
            "description": "Folder ID."
        },
        "signatureFormatId": {
            "type": "integer",
            "format": "int32",
            "description": "Signature format ID."
        },
        "callback": {
            "type": "boolean",
            "description": "If document has a callback."
        },
        "sender": {
            "name": {
                "type": "string",
                "description": "Sender name."
            },
            "email": {
                "type": "string",
                "description": "Sender e-mail."
            },
            "individualIdentificationCode": {
                "type": "string",
                "description": "Sender individual identification code."
            }
        },
        "signers": {
            "type": "array",
            "items": {
                "id": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Signer ID."
                },
                "title": {
                    "type": "string",
                    "description": "Signer title."
                },
                "step": {
                    "type": "integer",
                    "format": "int32",
                    "description": "Step number."
                },
                "uid": {
                    "type": "string",
                    "description": "Signer UUID."
                },
                "name": {
                    "type": "string",
                    "description": "Signer name."
                },
                "email": {
                    "type": "string",
                    "description": "Signer e-mail."
                },
                "individualIdentificationCode": {
                    "type": "string",
                    "description": "Signer individual identification code."
                }
            },
            "description": "Document signer list."
        },
        "electronicSigners": {
            "type": "array",
            "items": {
                "id": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Signer ID."
                },
                "title": {
                    "type": "string",
                    "description": "Signer title."
                },
                "step": {
                    "type": "integer",
                    "format": "int32",
                    "description": "Step number."
                },
                "uid": {
                    "type": "string",
                    "description": "Signer UUID."
                },
                "name": {
                    "type": "string",
                    "description": "Signer name."
                },
                "email": {
                    "type": "string",
                    "description": "Signer e-mail."
                },
                "individualIdentificationCode": {
                    "type": "string",
                    "description": "Signer individual identification code."
                },
                "inPerson": {
                    "type": "boolean",
                    "description": "Defines if the signature will be In Person or Remote"
                },
                "identificationType": {
                    "accessCode": {
                        "type": "boolean",
                        "description": "Defines the kind of Identification"
                    }
                },
                "accessCode": {
                    "type": "string",
                    "description": "Access Code to identification."
                }
            },
            "description": "Document signer list."
        },
        "serverSigners": {
            "type": "array",
            "items": {
                "step": {
                    "type": "integer",
                    "format": "int32",
                    "description": "Step number."
                },
                "certificateId": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Certificate ID."
                }
            },
            "description": "Document signer list."
        },
        "observers": {
            "type": "array",
            "items": {
                "id": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Signer ID."
                },
                "title": {
                    "type": "string",
                    "description": "Signer title."
                },
                "step": {
                    "type": "integer",
                    "format": "int32",
                    "description": "Step number."
                },
                "uid": {
                    "type": "string",
                    "description": "Signer UUID."
                },
                "name": {
                    "type": "string",
                    "description": "Signer name."
                },
                "email": {
                    "type": "string",
                    "description": "Signer e-mail."
                },
                "individualIdentificationCode": {
                    "type": "string",
                    "description": "Signer individual identification code."
                }
            },
            "description": "Document observer list."
        },
        "finishers": {
            "type": "array",
            "items": {
                "id": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Signer ID."
                },
                "title": {
                    "type": "string",
                    "description": "Signer title."
                },
                "step": {
                    "type": "integer",
                    "format": "int32",
                    "description": "Step number."
                },
                "uid": {
                    "type": "string",
                    "description": "Signer UUID."
                },
                "name": {
                    "type": "string",
                    "description": "Signer name."
                },
                "email": {
                    "type": "string",
                    "description": "Signer e-mail."
                },
                "individualIdentificationCode": {
                    "type": "string",
                    "description": "Signer individual identification code."
                }
            },
            "description": "Document finisher list."
        },
        "representatives": {
            "type": "array",
            "items": {
                "id": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Signer ID."
                },
                "title": {
                    "type": "string",
                    "description": "Signer title."
                },
                "step": {
                    "type": "integer",
                    "format": "int32",
                    "description": "Step number."
                },
                "signatureDeadlineInWorkdays": {
                    "type": "string",
                    "description": "Signer name."
                },
                "signatureDeadlineDate": {
                    "type": "string",
                    "description": "Signer e-mail."
                }
            },
            "description": "Document representative list."
        },
        "globalObservers": {
            "type": "array",
            "items": {
                "id": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Signer ID."
                },
                "uid": {
                    "type": "string",
                    "description": "Signer UUID."
                },
                "name": {
                    "type": "string",
                    "description": "Signer name."
                },
                "email": {
                    "type": "string",
                    "description": "Signer e-mail."
                },
                "individualIdentificationCode": {
                    "type": "string",
                    "description": "Signer individual identification code."
                }
            }
        },
        "recipients": {
            "emails": {
                "type": "string",
                "description": "Emails comma-separated."
            },
            "attached": {
                "type": "boolean",
                "description": "Attach the document."
            }
        },
        "notifiedList": {
            "emails": {
                "type": "string",
                "description": "Emails comma-separated."
            },
            "message": {
                "type": "string",
                "description": "Notification message."
            }
        },
        "tags": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "Document name to be uploaded"
        }
    }
]
List of documents.

Name Type Description
bytes [integer] Document package as byte array.
name string Document package name.
mimeType string Document multimedia type.