Consultar URL

Para consultar os links de eventos de assinatura já criados é possível pelas requisições abaixo.

Consulta de URLs do Evento de Assinatura

Request

ENDPOINT

/batch_group/batch_group_key/url

MÉTODO

GET

Path Params

Campo	Descrição
batch_group_key	Chave única de identificação do evento de assinatura.

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

Campo	Tipo	Descrição
batch_group_key	string	Chave única de identificação do evento de assinatura.
all_files_url	string	URL do arquivo zip que contém o PDF original e p7s.
batches	string	Lista de diferentes tipos de documentos.
document_batch_key	string	Chave única de identificação do lote de documentos.
documents	Array	Lista de objetos dos documentos.
document_key	string	Chave única de identificação do documento.
original_file_url	string	URL do documento original.
signed_file_url	string	URL do documento com página de assinatura.
file_url	string	URL do arquivo p7s.
expiration_datetime	string	Data e hora do momento em que ocorrerá a expiração das urls.

Consulta de URLs de um Documento

Request

ENDPOINT

/document/document_key/url

MÉTODO

GET

Path Params

Campo	Descrição
document_key	Chave única de identificação do documento

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

Campo	Tipo	Descrição
document_key	string	Chave única de identificação do documento.
original_file_url	string	URL do documento original.
signed_file_url	string	URL do documento com página de assinatura.
file_url	string	URL do arquivo p7s.
expiration_datetime	string	Data e hora do momento em que ocorrerá a expiração das urls.

info

O campo expiration_datetime será preenchido somente para clientes que estiverem habilitado o bucket privado