Query Document URLs

You can query the links for already created signing events through the requests below.

Query Signing Event URLs

Request

ENDPOINT

/batch_group/batch_group_key/url

METHOD

GET

Path Params

Field	Description
batch_group_key	Unique key identifying the signing event.

Response Body

{
	"all_files_url": "https://google.com",
	"expiration_datetime": "2024-05-01T01:00:00.000Z",
	"batches": [
		{
			"document_batch_key": "121",
			"documents": [
				{
					"document_key": "222",
					"original_file_url": "https://google2.com",
					"signed_file_url": "https://google3.com",
					"file_url": "https://google4.com"
				}
			]
		}
	]
}

Body Params

Field	Type	Description
batch_group_key	string	Unique key identifying the signing event.
all_files_url	string	URL of the zip file containing the original PDF and signature files.
batches	string	List of different document types.
document_batch_key	string	Unique key identifying the document batch.
documents	Array	List of document objects.
document_key	string	Unique key identifying the document.
original_file_url	string	URL of the original document.
signed_file_url	string	URL of the document with signing page.
file_url	string	URL of the p7s file.
expiration_datetime	string	Date and time when the URLs will expire.

Query Document URLs

Request

ENDPOINT

/document/document_key/url

MÉTODO

GET

Path Params

Field	Description
document_key	Unique key identifying the document

Response Body

{
    "document_key": "222",
    "original_file_url": "https://google2.com",
    "signed_file_url": "https://google3.com",
    "file_url": "https://google4.com",
    "expiration_datetime": "2024-05-01T01:00:00.000Z"
}

Body Params

Field	Type	Description
document_key	string	Unique key identifying the document.
original_file_url	string	URL of the original document.
signed_file_url	string	URL of the document with signing page.
file_url	string	URL of the p7s file.
expiration_datetime	string	Date and time when the URLs will expire.

info

The expiration_datetime field will only be populated for clients who have private bucket enabled.