boldsign.DocumentApi

All URIs are relative to https://api.boldsign.com

Method	HTTP request	Description
add_authentication	PATCH /v1/document/addAuthentication	The add authentication to recipient.
add_tag	PATCH /v1/document/addTags	Add the Tags in Documents.
behalf_documents	GET /v1/document/behalfList	Gets the behalf documents.
change_access_code	PATCH /v1/document/changeAccessCode	Changes the access code for the given document signer.
change_recipient	PATCH /v1/document/changeRecipient	Change recipient details of a document.
create_embedded_edit_url	POST /v1/document/createEmbeddedEditUrl	Generates an embedded edit URL that allows the document editing process to be integrated into your application.
create_embedded_request_url_document	POST /v1/document/createEmbeddedRequestUrl	Generates a send URL which embeds document sending process into your application.
delete_document	DELETE /v1/document/delete	Delete the document.
delete_tag	DELETE /v1/document/deleteTags	Delete the Tags in Documents.
download_attachment	GET /v1/document/downloadAttachment	Download the Attachment.
download_audit_log	GET /v1/document/downloadAuditLog	Download the audit trail document.
download_document	GET /v1/document/download	Download the document.
draft_send	POST /v1/document/draftSend	Sends a draft-status document out for signature.
edit_document	PUT /v1/document/edit	Edit and updates an existing document.
extend_expiry	PATCH /v1/document/extendExpiry	Extends the expiration date of the document.
get_properties	GET /v1/document/properties	Get summary of the document.
get_embedded_sign_link	GET /v1/document/getEmbeddedSignLink	Get sign link for Embedded Sign.
list_documents	GET /v1/document/list	List user documents.
prefill_fields	PATCH /v1/document/prefillFields	Updates the value (prefill) of the fields in the document.
remind_document	POST /v1/document/remind	Send reminder to pending signers.
remove_authentication	PATCH /v1/document/RemoveAuthentication	Remove the access code for the given document signer.
revoke_document	POST /v1/document/revoke	Revoke the document.
send_document	POST /v1/document/send	Sends the document for sign.
team_documents	GET /v1/document/teamlist	Get user Team documents.

add_authentication

add_authentication(document_id, access_code_detail=access_code_detail)

The add authentication to recipient.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.access_code_detail import AccessCodeDetail
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | The DocumentId.
    access_code_detail = boldsign.AccessCodeDetail() # AccessCodeDetail | Access code details. (optional)

    try:
        # The add authentication to recipient.
        api_instance.add_authentication(document_id, access_code_detail=access_code_detail)
    except Exception as e:
        print("Exception when calling DocumentApi->add_authentication: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	The DocumentId.
access_code_detail	AccessCodeDetail	Access code details.	[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_tag

add_tag(document_tags=document_tags)

Add the Tags in Documents.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.document_tags import DocumentTags
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_tags = boldsign.DocumentTags() # DocumentTags | Contains DocumentId and LabelNames for Adding Tags. (optional)

    try:
        # Add the Tags in Documents.
        api_instance.add_tag(document_tags=document_tags)
    except Exception as e:
        print("Exception when calling DocumentApi->add_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_tags	DocumentTags	Contains DocumentId and LabelNames for Adding Tags.	[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

behalf_documents

BehalfDocumentRecords behalf_documents(page, page_type=page_type, email_address=email_address, signers=signers, page_size=page_size, start_date=start_date, status=status, end_date=end_date, search_key=search_key, labels=labels, next_cursor=next_cursor, brand_ids=brand_ids)

Gets the behalf documents.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.behalf_document_records import BehalfDocumentRecords
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    page = 1 # int | Page index specified in get document list request. (default to 1)
    page_type = 'page_type_example' # str | The filter used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. (optional)
    email_address = ['email_address_example'] # List[str] | The sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. (optional)
    signers = ['signers_example'] # List[str] | A list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list (optional)
    page_size = 10 # int | Page size specified in get document list request. (optional) (default to 10)
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date of the document (optional)
    status = ['status_example'] # List[str] | Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date of the document (optional)
    search_key = 'search_key_example' # str | Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
    labels = ['labels_example'] # List[str] | Labels of the document. (optional)
    next_cursor = 56 # int | Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
    brand_ids = ['brand_ids_example'] # List[str] | BrandId(s) of the document. (optional)

    try:
        # Gets the behalf documents.
        api_response = api_instance.behalf_documents(page, page_type=page_type, email_address=email_address, signers=signers, page_size=page_size, start_date=start_date, status=status, end_date=end_date, search_key=search_key, labels=labels, next_cursor=next_cursor, brand_ids=brand_ids)
        print("The response of DocumentApi->behalf_documents:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentApi->behalf_documents: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int	Page index specified in get document list request.	[default to 1]
page_type	str	The filter used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value.	[optional]
email_address	List[str]	The sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address.	[optional]
signers	List[str]	A list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list	[optional]
page_size	int	Page size specified in get document list request.	[optional] [default to 10]
start_date	datetime	Start date of the document	[optional]
status	List[str]	Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft.	[optional]
end_date	datetime	End date of the document	[optional]
search_key	str	Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,	[optional]
labels	List[str]	Labels of the document.	[optional]
next_cursor	int	Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.	[optional]
brand_ids	List[str]	BrandId(s) of the document.	[optional]

Return type

BehalfDocumentRecords

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_access_code

change_access_code(document_id, access_code_details, email_id=email_id, z_order=z_order)

Changes the access code for the given document signer.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.access_code_details import AccessCodeDetails
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | 
    access_code_details = boldsign.AccessCodeDetails() # AccessCodeDetails | The new access code.
    email_id = 'email_id_example' # str |  (optional)
    z_order = 56 # int |  (optional)

    try:
        # Changes the access code for the given document signer.
        api_instance.change_access_code(document_id, access_code_details, email_id=email_id, z_order=z_order)
    except Exception as e:
        print("Exception when calling DocumentApi->change_access_code: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str
access_code_details	AccessCodeDetails	The new access code.
email_id	str		[optional]
z_order	int		[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_recipient

change_recipient(document_id, change_recipient)

Change recipient details of a document.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.change_recipient import ChangeRecipient
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | The documentID details.
    change_recipient = boldsign.ChangeRecipient() # ChangeRecipient | The new recipient details.

    try:
        # Change recipient details of a document.
        api_instance.change_recipient(document_id, change_recipient)
    except Exception as e:
        print("Exception when calling DocumentApi->change_recipient: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	The documentID details.
change_recipient	ChangeRecipient	The new recipient details.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_embedded_edit_url

EmbeddedDocumentEdited create_embedded_edit_url(document_id, embedded_document_edit_json_request=embedded_document_edit_json_request)

Generates an embedded edit URL that allows the document editing process to be integrated into your application.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.embedded_document_edit_json_request import EmbeddedDocumentEditJsonRequest
from boldsign.models.embedded_document_edited import EmbeddedDocumentEdited
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | The document id.
    embedded_document_edit_json_request = boldsign.EmbeddedDocumentEditJsonRequest() # EmbeddedDocumentEditJsonRequest | The embedded edit document request body. (optional)

    try:
        # Generates an embedded edit URL that allows the document editing process to be integrated into your application.
        api_response = api_instance.create_embedded_edit_url(document_id, embedded_document_edit_json_request=embedded_document_edit_json_request)
        print("The response of DocumentApi->create_embedded_edit_url:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentApi->create_embedded_edit_url: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	The document id.
embedded_document_edit_json_request	EmbeddedDocumentEditJsonRequest	The embedded edit document request body.	[optional]

Return type

EmbeddedDocumentEdited

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Content	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_embedded_request_url_document

EmbeddedSendCreated create_embedded_request_url_document(embedded_document_request=embedded_document_request)

Generates a send URL which embeds document sending process into your application.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.embedded_document_request import EmbeddedDocumentRequest
from boldsign.models.embedded_send_created import EmbeddedSendCreated
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    embedded_document_request = boldsign.EmbeddedDocumentRequest() # EmbeddedDocumentRequest | The embedded send document request body. (optional)

    try:
        # Generates a send URL which embeds document sending process into your application.
        api_response = api_instance.create_embedded_request_url_document(embedded_document_request=embedded_document_request)
        print("The response of DocumentApi->create_embedded_request_url_document:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentApi->create_embedded_request_url_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
embedded_document_request	EmbeddedDocumentRequest	The embedded send document request body.	[optional]

Return type

EmbeddedSendCreated

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-
422	Unprocessable Content	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_document

delete_document(document_id, delete_permanently=delete_permanently)

Delete the document.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | Document Id.
    delete_permanently = False # bool | Delete Permanently. (optional) (default to False)

    try:
        # Delete the document.
        api_instance.delete_document(document_id, delete_permanently=delete_permanently)
    except Exception as e:
        print("Exception when calling DocumentApi->delete_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Id.
delete_permanently	bool	Delete Permanently.	[optional] [default to False]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_tag

delete_tag(document_tags=document_tags)

Delete the Tags in Documents.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.document_tags import DocumentTags
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_tags = boldsign.DocumentTags() # DocumentTags | Contains DocumentId and LabelNames for Adding Tags. (optional)

    try:
        # Delete the Tags in Documents.
        api_instance.delete_tag(document_tags=document_tags)
    except Exception as e:
        print("Exception when calling DocumentApi->delete_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_tags	DocumentTags	Contains DocumentId and LabelNames for Adding Tags.	[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
400	Bad Request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_attachment

io.IOBase download_attachment(document_id, attachment_id, on_behalf_of=on_behalf_of)

Download the Attachment.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | Document Id.
    attachment_id = 'attachment_id_example' # str | Attachment Id(Get attachment ID from Properties API).
    on_behalf_of = 'on_behalf_of_example' # str | The on behalfof email address. (optional)

    try:
        # Download the Attachment.
        api_response = api_instance.download_attachment(document_id, attachment_id, on_behalf_of=on_behalf_of)
        print("The response of DocumentApi->download_attachment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentApi->download_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Id.
attachment_id	str	Attachment Id(Get attachment ID from Properties API).
on_behalf_of	str	The on behalfof email address.	[optional]

Return type

io.IOBase

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_audit_log

io.IOBase download_audit_log(document_id, on_behalf_of=on_behalf_of)

Download the audit trail document.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | Document Id.
    on_behalf_of = 'on_behalf_of_example' # str | The on behalfof email address. (optional)

    try:
        # Download the audit trail document.
        api_response = api_instance.download_audit_log(document_id, on_behalf_of=on_behalf_of)
        print("The response of DocumentApi->download_audit_log:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentApi->download_audit_log: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Id.
on_behalf_of	str	The on behalfof email address.	[optional]

Return type

io.IOBase

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_document

io.IOBase download_document(document_id, on_behalf_of=on_behalf_of)

Download the document.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | Document Id.
    on_behalf_of = 'on_behalf_of_example' # str | The on behalfof email address. (optional)

    try:
        # Download the document.
        api_response = api_instance.download_document(document_id, on_behalf_of=on_behalf_of)
        print("The response of DocumentApi->download_document:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentApi->download_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Id.
on_behalf_of	str	The on behalfof email address.	[optional]

Return type

io.IOBase

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

draft_send

draft_send(document_id)

Sends a draft-status document out for signature.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | The ID of the document to be sent.

    try:
        # Sends a draft-status document out for signature.
        api_instance.draft_send(document_id)
    except Exception as e:
        print("Exception when calling DocumentApi->draft_send: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	The ID of the document to be sent.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_document

DocumentEdited edit_document(document_id, edit_document_request=edit_document_request)

Edit and updates an existing document.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.document_edited import DocumentEdited
from boldsign.models.edit_document_request import EditDocumentRequest
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | Document Id.
    edit_document_request = boldsign.EditDocumentRequest() # EditDocumentRequest | Edit document JSON request. (optional)

    try:
        # Edit and updates an existing document.
        api_response = api_instance.edit_document(document_id, edit_document_request=edit_document_request)
        print("The response of DocumentApi->edit_document:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentApi->edit_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Id.
edit_document_request	EditDocumentRequest	Edit document JSON request.	[optional]

Return type

DocumentEdited

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-
422	Unprocessable Content	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extend_expiry

extend_expiry(document_id, extend_expiry=extend_expiry)

Extends the expiration date of the document.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.extend_expiry import ExtendExpiry
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | Document Id.
    extend_expiry = boldsign.ExtendExpiry() # ExtendExpiry | The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type. (optional)

    try:
        # Extends the expiration date of the document.
        api_instance.extend_expiry(document_id, extend_expiry=extend_expiry)
    except Exception as e:
        print("Exception when calling DocumentApi->extend_expiry: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Id.
extend_expiry	ExtendExpiry	The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type.	[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_properties

DocumentProperties get_properties(document_id)

Get summary of the document.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.document_properties import DocumentProperties
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | Document Id.

    try:
        # Get summary of the document.
        api_response = api_instance.get_properties(document_id)
        print("The response of DocumentApi->get_properties:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentApi->get_properties: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Id.

Return type

DocumentProperties

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_sign_link

EmbeddedSigningLink get_embedded_sign_link(document_id, signer_email=signer_email, country_code=country_code, phone_number=phone_number, sign_link_valid_till=sign_link_valid_till, redirect_url=redirect_url)

Get sign link for Embedded Sign.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.embedded_signing_link import EmbeddedSigningLink
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | 
    signer_email = 'signer_email_example' # str |  (optional)
    country_code = 'country_code_example' # str |  (optional)
    phone_number = 'phone_number_example' # str |  (optional)
    sign_link_valid_till = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    redirect_url = 'redirect_url_example' # str |  (optional)

    try:
        # Get sign link for Embedded Sign.
        api_response = api_instance.get_embedded_sign_link(document_id, signer_email=signer_email, country_code=country_code, phone_number=phone_number, sign_link_valid_till=sign_link_valid_till, redirect_url=redirect_url)
        print("The response of DocumentApi->get_embedded_sign_link:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentApi->get_embedded_sign_link: %s\n" % e)

Parameters

Name	Type	Notes
document_id	str
signer_email	str	[optional]
country_code	str	[optional]
phone_number	str	[optional]
sign_link_valid_till	datetime	[optional]
redirect_url	str	[optional]

Return type

EmbeddedSigningLink

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_documents

DocumentRecords list_documents(page, sent_by=sent_by, recipients=recipients, transmit_type=transmit_type, date_filter_type=date_filter_type, page_size=page_size, start_date=start_date, status=status, end_date=end_date, search_key=search_key, labels=labels, next_cursor=next_cursor, brand_ids=brand_ids)

List user documents.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.document_records import DocumentRecords
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    page = 1 # int | Page index specified in get document list request. (default to 1)
    sent_by = ['sent_by_example'] # List[str] |  (optional)
    recipients = ['recipients_example'] # List[str] |  (optional)
    transmit_type = 'transmit_type_example' # str |  (optional)
    date_filter_type = 'date_filter_type_example' # str | Date Filter as SentBetween and ExpiresOn. (optional)
    page_size = 10 # int | Page size specified in get document list request. (optional) (default to 10)
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date of the document (optional)
    status = ['status_example'] # List[str] | Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date of the document (optional)
    search_key = 'search_key_example' # str | Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
    labels = ['labels_example'] # List[str] | Labels of the document. (optional)
    next_cursor = 56 # int | Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
    brand_ids = ['brand_ids_example'] # List[str] | BrandId(s) of the document. (optional)

    try:
        # List user documents.
        api_response = api_instance.list_documents(page, sent_by=sent_by, recipients=recipients, transmit_type=transmit_type, date_filter_type=date_filter_type, page_size=page_size, start_date=start_date, status=status, end_date=end_date, search_key=search_key, labels=labels, next_cursor=next_cursor, brand_ids=brand_ids)
        print("The response of DocumentApi->list_documents:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentApi->list_documents: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int	Page index specified in get document list request.	[default to 1]
sent_by	List[str]		[optional]
recipients	List[str]		[optional]
transmit_type	str		[optional]
date_filter_type	str	Date Filter as SentBetween and ExpiresOn.	[optional]
page_size	int	Page size specified in get document list request.	[optional] [default to 10]
start_date	datetime	Start date of the document	[optional]
status	List[str]	Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft.	[optional]
end_date	datetime	End date of the document	[optional]
search_key	str	Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,	[optional]
labels	List[str]	Labels of the document.	[optional]
next_cursor	int	Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.	[optional]
brand_ids	List[str]	BrandId(s) of the document.	[optional]

Return type

DocumentRecords

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

prefill_fields

prefill_fields(document_id, prefill_field_request)

Updates the value (prefill) of the fields in the document.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.prefill_field_request import PrefillFieldRequest
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | The DocumentId.
    prefill_field_request = boldsign.PrefillFieldRequest() # PrefillFieldRequest | The prefill field request.

    try:
        # Updates the value (prefill) of the fields in the document.
        api_instance.prefill_fields(document_id, prefill_field_request)
    except Exception as e:
        print("Exception when calling DocumentApi->prefill_fields: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	The DocumentId.
prefill_field_request	PrefillFieldRequest	The prefill field request.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remind_document

remind_document(document_id, receiver_emails=receiver_emails, reminder_message=reminder_message)

Send reminder to pending signers.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.reminder_message import ReminderMessage
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | Document Id.
    receiver_emails = ['receiver_emails_example'] # List[str] | Signer emails. (optional)
    reminder_message = boldsign.ReminderMessage() # ReminderMessage | Reminder Message for signers. (optional)

    try:
        # Send reminder to pending signers.
        api_instance.remind_document(document_id, receiver_emails=receiver_emails, reminder_message=reminder_message)
    except Exception as e:
        print("Exception when calling DocumentApi->remind_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Id.
receiver_emails	List[str]	Signer emails.	[optional]
reminder_message	ReminderMessage	Reminder Message for signers.	[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_authentication

remove_authentication(document_id, remove_authentication=remove_authentication)

Remove the access code for the given document signer.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.remove_authentication import RemoveAuthentication
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | Document ID of the signature request
    remove_authentication = boldsign.RemoveAuthentication() # RemoveAuthentication | To remove access code. (optional)

    try:
        # Remove the access code for the given document signer.
        api_instance.remove_authentication(document_id, remove_authentication=remove_authentication)
    except Exception as e:
        print("Exception when calling DocumentApi->remove_authentication: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document ID of the signature request
remove_authentication	RemoveAuthentication	To remove access code.	[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

revoke_document

revoke_document(document_id, revoke_document)

Revoke the document.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.revoke_document import RevokeDocument
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    document_id = 'document_id_example' # str | Document Id.
    revoke_document = boldsign.RevokeDocument() # RevokeDocument | RevokeDetails.

    try:
        # Revoke the document.
        api_instance.revoke_document(document_id, revoke_document)
    except Exception as e:
        print("Exception when calling DocumentApi->revoke_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Id.
revoke_document	RevokeDocument	RevokeDetails.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

send_document

DocumentCreated send_document(send_for_sign=send_for_sign)

Sends the document for sign.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.document_created import DocumentCreated
from boldsign.models.send_for_sign import SendForSign
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    send_for_sign = boldsign.SendForSign() # SendForSign | The send for sign request body. (optional)

    try:
        # Sends the document for sign.
        api_response = api_instance.send_document(send_for_sign=send_for_sign)
        print("The response of DocumentApi->send_document:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentApi->send_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
send_for_sign	SendForSign	The send for sign request body.	[optional]

Return type

DocumentCreated

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-
422	Unprocessable Content	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

team_documents

TeamDocumentRecords team_documents(page, user_id=user_id, team_id=team_id, transmit_type=transmit_type, date_filter_type=date_filter_type, page_size=page_size, start_date=start_date, status=status, end_date=end_date, search_key=search_key, labels=labels, next_cursor=next_cursor, brand_ids=brand_ids)

Get user Team documents.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.team_document_records import TeamDocumentRecords
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.DocumentApi(api_client)
    page = 1 # int | Page index specified in get document list request. (default to 1)
    user_id = ['user_id_example'] # List[str] | UserId of the  Team document. (optional)
    team_id = ['team_id_example'] # List[str] | TeamId  of the  Team document. (optional)
    transmit_type = 'transmit_type_example' # str | Transmit type as Sent, Received and Both. (optional)
    date_filter_type = 'date_filter_type_example' # str | Date Filter as SentBetween and Expiring. (optional)
    page_size = 10 # int | Page size specified in get document list request. (optional) (default to 10)
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date of the document (optional)
    status = ['status_example'] # List[str] | Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date of the document (optional)
    search_key = 'search_key_example' # str | Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
    labels = ['labels_example'] # List[str] | Labels of the document. (optional)
    next_cursor = 56 # int | Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
    brand_ids = ['brand_ids_example'] # List[str] | BrandId(s) of the document. (optional)

    try:
        # Get user Team documents.
        api_response = api_instance.team_documents(page, user_id=user_id, team_id=team_id, transmit_type=transmit_type, date_filter_type=date_filter_type, page_size=page_size, start_date=start_date, status=status, end_date=end_date, search_key=search_key, labels=labels, next_cursor=next_cursor, brand_ids=brand_ids)
        print("The response of DocumentApi->team_documents:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentApi->team_documents: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int	Page index specified in get document list request.	[default to 1]
user_id	List[str]	UserId of the Team document.	[optional]
team_id	List[str]	TeamId of the Team document.	[optional]
transmit_type	str	Transmit type as Sent, Received and Both.	[optional]
date_filter_type	str	Date Filter as SentBetween and Expiring.	[optional]
page_size	int	Page size specified in get document list request.	[optional] [default to 10]
start_date	datetime	Start date of the document	[optional]
status	List[str]	Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft.	[optional]
end_date	datetime	End date of the document	[optional]
search_key	str	Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,	[optional]
labels	List[str]	Labels of the document.	[optional]
next_cursor	int	Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.	[optional]
brand_ids	List[str]	BrandId(s) of the document.	[optional]

Return type

TeamDocumentRecords

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

DocumentApi.md

Latest commit

History

DocumentApi.md

File metadata and controls

boldsign.DocumentApi

add_authentication

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_tag

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

behalf_documents

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

change_access_code

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

change_recipient

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_embedded_edit_url

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_embedded_request_url_document

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_document

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_tag

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_attachment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_audit_log

Example

Parameters