signer-python-client

Authentication

In order to call this APIs, you will need an API key. Set the API key in the header X-Api-Key:

X-Api-Key: your-app|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

HTTP Codes

The APIs will return the following HTTP codes:

Code	Description
200 (OK)	Request processed successfully. The response is different for each API, please refer to the operation's documentation
400 (Bad Request)	Syntax error. For instance, when a required field was not provided
401 (Unauthorized)	API key not provided or invalid
403 (Forbidden)	API key is valid, but the application has insufficient permissions to complete the requested operation
422 (Unprocessable Entity)	API error. The response is as defined in ErrorModel

Error Codes

Some of the error codes returned in a 422 response are provided bellow*:

• CertificateNotFound
• DocumentNotFound
• FolderNotFound
• CpfMismatch
• CpfNotExpected
• InvalidFlowAction
• DocumentInvalidKey

*The codes shown above are the main error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.

Webhooks

It is recomended to subscribe to Webhook events instead of polling APIs. To do so, enable webhooks and register an URL that will receive a POST request whenever one of the events bellow occur.

All requests have the format described in Webhooks.WebhookModel. The data field varies according to the webhook event type:

Event type	Description	Payload
DocumentSigned	Triggered when a document is signed.	Webhooks.DocumentSignedModel
DocumentApproved	Triggered when a document is approved.	Webhooks.DocumentApprovedModel
DocumentRefused	Triggered when a document is refused.	Webhooks.DocumentRefusedModel
DocumentConcluded	Triggered when the flow of a document is concluded.	Webhooks.DocumentConcludedModel
DocumentCanceled	Triggered when the document is canceled.	Webhooks.DocumentCanceledModel
DocumentExpired (v1.33.0)	Triggered when the document is expired.	Webhooks.DocumentExpiredModel
DocumentsCreated (v1.50.0)	Triggered when one or more documents are created.	Webhooks.DocumentsCreatedModel
DocumentsDeleted (v1.78.0)	Triggered when one or more documents are deleted.	Webhooks.DocumentsDeletedModel

To register your application URL and enable Webhooks, access the integrations section in your organization's details page.

This Python package is automatically generated by the Swagger Codegen project:

• API version: 2.1.1
• Package version: 0.9.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import signer_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import signer_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import signer_client
from signer_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
body = signer_client.DocumentsMoveDocumentBatchRequest() # DocumentsMoveDocumentBatchRequest |  (optional)

try:
    # Moves a batch of documents to a folder.
    api_response = api_instance.api_documents_batch_folder_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_batch_folder_post: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
is_concluded = true # bool | (DEPRECATED) Please use \"Status\" parameter instead. Set to true to list concluded documents, false to list pending documents. (optional)
status = signer_client.DocumentFilterStatus() # DocumentFilterStatus | Filters by document status. Will override the \"IsConcluded\" property. (optional)
folder_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
folder_type = signer_client.FolderType() # FolderType |  (optional)
document_type = signer_client.DocumentTypes() # DocumentTypes |  (optional)
filter_by_document_type = true # bool | True if the documents should be filtered by type, use documentType to specify the document type.  If you want to filter only documents without a type, set this parameter to true and the documentType to null. (optional)
filter_by_pending_signature = true # bool | True if documents should be filtered only for those that have FlowAction of the type Signer or SignRule (optional)
query_type = signer_client.DocumentQueryTypes() # DocumentQueryTypes |  (optional)
participant_q = 'participant_q_example' # str | Query to filter by participant (optional)
participant_query_type = signer_client.ParticipantQueryTypes() # ParticipantQueryTypes |  (optional)
tags = 'tags_example' # str | Label/value pairs are separated by \"|\" (optional) and Tags separated by \",\". Only the first 10 pairs will be considered.  To search by tag value only, do not use the \"|\". (optional)
is_deleted = true # bool | Returns deleted documents that had the specified document status when deleted. (optional)
q = 'q_example' # str | Query to filter items. (optional)
limit = 56 # int | Number of items to return. (optional)
offset = 56 # int | The offset of the searched page (starting with 0). (optional)
order = signer_client.PaginationOrders() # PaginationOrders |  (optional)

try:
    # Retrieves the documents of the organization paginating the response.
    api_response = api_instance.api_documents_get(is_concluded=is_concluded, status=status, folder_id=folder_id, folder_type=folder_type, document_type=document_type, filter_by_document_type=filter_by_document_type, filter_by_pending_signature=filter_by_pending_signature, query_type=query_type, participant_q=participant_q, participant_query_type=participant_query_type, tags=tags, is_deleted=is_deleted, q=q, limit=limit, offset=offset, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_get: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Document Id
body = signer_client.DocumentsActionUrlRequest() # DocumentsActionUrlRequest |  (optional)

try:
    # Retrieves an URL to redirect the user to the first pending action of the document.
    api_response = api_instance.api_documents_id_action_url_post(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_action_url_post: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
body = signer_client.DocumentsCancelDocumentRequest() # DocumentsCancelDocumentRequest |  (optional)

try:
    # Cancels the document by providing a reason for the cancellation.
    api_instance.api_documents_id_cancellation_post(id, body=body)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_cancellation_post: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Document id
type = signer_client.DocumentDownloadTypes() # DocumentDownloadTypes | The version type to download (optional)

try:
    # Downloads a specific version type of the document encoding the bytes in Base 64 format.
    api_response = api_instance.api_documents_id_content_b64_get(id, type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_content_b64_get: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Document id
type = signer_client.DocumentDownloadTypes() # DocumentDownloadTypes | The version type to download (optional)

try:
    # Downloads a specific version type of the document.
    api_instance.api_documents_id_content_get(id, type=type)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_content_get: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Document id

try:
    # Deletes a specific document using it's id.
    api_instance.api_documents_id_delete(id)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_delete: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
body = signer_client.DocumentsEnvelopeAddVersionRequest() # DocumentsEnvelopeAddVersionRequest |  (optional)

try:
    # Adds a new version for an envelope.
    api_instance.api_documents_id_envelope_versions_post(id, body=body)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_envelope_versions_post: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Id of the document
body = signer_client.DocumentsDocumentFlowEditRequest() # DocumentsDocumentFlowEditRequest |  (optional)

try:
    # Updates the document's flow.
    api_response = api_instance.api_documents_id_flow_post(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_flow_post: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
body = signer_client.DocumentsMoveDocumentRequest() # DocumentsMoveDocumentRequest |  (optional)

try:
    # Moves a document to a folder.
    api_instance.api_documents_id_folder_post(id, body=body)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_folder_post: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Document id

try:
    # Retrieves the document's details.
    api_response = api_instance.api_documents_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_get: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Id of the document
body = signer_client.DocumentsDocumentNotifiedEmailsEditRequest() # DocumentsDocumentNotifiedEmailsEditRequest |  (optional)

try:
    # Updates the document's notified emails
    api_instance.api_documents_id_notified_emails_put(id, body=body)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_notified_emails_put: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
body = signer_client.RefusalRefusalRequest() # RefusalRefusalRequest |  (optional)

try:
    # Refuses a document by providing a reason for the refusal.
    api_instance.api_documents_id_refusal_post(id, body=body)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_refusal_post: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The Id of the document

try:
    # Retrieves the details of the document's signatures.
    api_response = api_instance.api_documents_id_signatures_details_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_signatures_details_get: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Document id
type = signer_client.DocumentTicketType() # DocumentTicketType | The version type to download (optional)
preview = false # bool | If true, when downloading the document, the response will not include the name of the file (useful when embedding the document inside a web page for previewing) (optional) (default to false)

try:
    # Generates a URL (ticket) to download a specific version type of the document.
    api_response = api_instance.api_documents_id_ticket_get(id, type=type, preview=preview)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_ticket_get: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
body = signer_client.DocumentsDocumentAddVersionRequest() # DocumentsDocumentAddVersionRequest |  (optional)

try:
    # Adds a new version for the document.
    api_instance.api_documents_id_versions_post(id, body=body)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_id_versions_post: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
key = 'key_example' # str | The verification code presented in the document

try:
    # Validates each signature in a document using the verification code
    api_response = api_instance.api_documents_keys_key_signatures_get(key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_keys_key_signatures_get: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
body = signer_client.DocumentsCreateDocumentRequest() # DocumentsCreateDocumentRequest |  (optional)

try:
    # Creates one or multiple documents.
    api_response = api_instance.api_documents_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_post: %s\n" % e)

# Configure API key authorization: ApiKey
configuration = signer_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = signer_client.DocumentsApi(signer_client.ApiClient(configuration))
body = signer_client.SignatureSignaturesInfoRequest() # SignatureSignaturesInfoRequest |  (optional)

try:
    # Validates each signature in the uploaded document
    api_response = api_instance.api_documents_validate_signatures_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->api_documents_validate_signatures_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
DocumentsApi	api_documents_batch_folder_post	POST /api/documents/batch/folder	Moves a batch of documents to a folder.
DocumentsApi	api_documents_get	GET /api/documents	Retrieves the documents of the organization paginating the response.
DocumentsApi	api_documents_id_action_url_post	POST /api/documents/{id}/action-url	Retrieves an URL to redirect the user to the first pending action of the document.
DocumentsApi	api_documents_id_cancellation_post	POST /api/documents/{id}/cancellation	Cancels the document by providing a reason for the cancellation.
DocumentsApi	api_documents_id_content_b64_get	GET /api/documents/{id}/content-b64	Downloads a specific version type of the document encoding the bytes in Base 64 format.
DocumentsApi	api_documents_id_content_get	GET /api/documents/{id}/content	Downloads a specific version type of the document.
DocumentsApi	api_documents_id_delete	DELETE /api/documents/{id}	Deletes a specific document using it's id.
DocumentsApi	api_documents_id_envelope_versions_post	POST /api/documents/{id}/envelope/versions	Adds a new version for an envelope.
DocumentsApi	api_documents_id_flow_post	POST /api/documents/{id}/flow	Updates the document's flow.
DocumentsApi	api_documents_id_folder_post	POST /api/documents/{id}/folder	Moves a document to a folder.
DocumentsApi	api_documents_id_get	GET /api/documents/{id}	Retrieves the document's details.
DocumentsApi	api_documents_id_notified_emails_put	PUT /api/documents/{id}/notified-emails	Updates the document's notified emails
DocumentsApi	api_documents_id_refusal_post	POST /api/documents/{id}/refusal	Refuses a document by providing a reason for the refusal.
DocumentsApi	api_documents_id_signatures_details_get	GET /api/documents/{id}/signatures-details	Retrieves the details of the document's signatures.
DocumentsApi	api_documents_id_ticket_get	GET /api/documents/{id}/ticket	Generates a URL (ticket) to download a specific version type of the document.
DocumentsApi	api_documents_id_versions_post	POST /api/documents/{id}/versions	Adds a new version for the document.
DocumentsApi	api_documents_keys_key_signatures_get	GET /api/documents/keys/{key}/signatures	Validates each signature in a document using the verification code
DocumentsApi	api_documents_post	POST /api/documents	Creates one or multiple documents.
DocumentsApi	api_documents_validate_signatures_post	POST /api/documents/validate-signatures	Validates each signature in the uploaded document
FlowsApi	api_document_flows_get	GET /api/document-flows	List created flows.
FlowsApi	api_document_flows_id_delete	DELETE /api/document-flows/{id}	Deletes a flow.
FlowsApi	api_document_flows_id_get	GET /api/document-flows/{id}	Retrieves flow details
FlowsApi	api_document_flows_id_put	PUT /api/document-flows/{id}	Updates a flow.
FlowsApi	api_document_flows_post	POST /api/document-flows	Creates a flow that can be used to create documents
FoldersApi	api_folders_get	GET /api/folders	Retrieves all folders paginating the response
FoldersApi	api_folders_id_delete_post	POST /api/folders/{id}/delete	Deletes a folder.
FoldersApi	api_folders_id_get	GET /api/folders/{id}	Retrieves the folder's info.
FoldersApi	api_folders_post	POST /api/folders	Creates a folder.
MarksSessionsApi	api_marks_sessions_documents_post	POST /api/marks-sessions/documents	Creates a mark positioning session from a Document create request.
MarksSessionsApi	api_marks_sessions_id_get	GET /api/marks-sessions/{id}	Retrieves session information.
MarksSessionsApi	api_marks_sessions_post	POST /api/marks-sessions	Creates a mark positioning session by requiring only the necessary data.
NotificationsApi	api_notifications_flow_action_reminder_post	POST /api/notifications/flow-action-reminder	Sends a reminder email to the user of a flow action. (if the action is pending)
NotificationsApi	api_users_notify_pending_post	POST /api/users/notify-pending	Sends a reminder email to the e-mails provided on request. Should be used after creating a batch of documents.
OrganizationsApi	api_organizations_users_get	GET /api/organizations/users	List organization users
OrganizationsApi	api_organizations_users_post	POST /api/organizations/users	Adds a user to the organization
OrganizationsApi	api_organizations_users_user_id_delete	DELETE /api/organizations/users/{userId}	Deletes a user from organization
UploadApi	api_uploads_bytes_post	POST /api/uploads/bytes	Uploads a file by sending a JSON request with the bytes in Base 64 format.
UploadApi	api_uploads_post	POST /api/uploads	Uploads a file by sending a multipart/form-data request

Documentation For Models

• ActionStatus
• AgentTypes
• AgentsAgentModel
• ApiUploadsBody
• ApplicationsApplicationDisplayModel
• AttachmentsAttachmentModel
• AttachmentsAttachmentUploadModel
• AttachmentsCreateAttachmentResult
• AuthenticationTypes
• BatchItemResultModel
• BillingBillingInformationModel
• BillingCompanyBillingInformationModel
• BillingIndividualBillingInformationModel
• BillingInformationTypes
• CertificateHolderTypes
• CertificateTypes
• CertificatesAttributeCertificateInfoModel
• DeleteAction
• DocumentDownloadTypes
• DocumentFilterStatus
• DocumentFlowsDocumentFlowCreateRequest
• DocumentFlowsDocumentFlowData
• DocumentFlowsDocumentFlowDetailsModel
• DocumentFlowsDocumentFlowModel
• DocumentMarkDocumentMarkPositionModel
• DocumentMarkFlowActionPositionModel
• DocumentMarkMarksSessionCreateRequest
• DocumentMarkMarksSessionCreateResponse
• DocumentMarkMarksSessionModel
• DocumentMarkPrePositionedDocumentMarkModel
• DocumentMarkType
• DocumentMarkUploadTicketModel
• DocumentQueryTypes
• DocumentStatus
• DocumentTicketType
• DocumentTypes
• DocumentsActionUrlRequest
• DocumentsActionUrlResponse
• DocumentsCancelDocumentRequest
• DocumentsCreateDocumentRequest
• DocumentsCreateDocumentResult
• DocumentsCreatorModel
• DocumentsDocumentAddVersionRequest
• DocumentsDocumentAdditionalInfoData
• DocumentsDocumentContentModel
• DocumentsDocumentFileModel
• DocumentsDocumentFlowEditRequest
• DocumentsDocumentListModel
• DocumentsDocumentModel
• DocumentsDocumentNotifiedEmailsEditRequest
• DocumentsDocumentPermissionsModel
• DocumentsDocumentSignaturesInfoModel
• DocumentsDocumentTagData
• DocumentsDocumentTagModel
• DocumentsEnvelopeAddVersionRequest
• DocumentsFlowActionPendingModel
• DocumentsMoveDocumentBatchRequest
• DocumentsMoveDocumentRequest
• DocumentsPrePositionedMarkModel
• ErrorModel
• FileModel
• FileUploadModel
• FlowActionType
• FlowActionsApprovalModel
• FlowActionsDocumentFlowEditResponse
• FlowActionsFlowActionCreateModel
• FlowActionsFlowActionEditModel
• FlowActionsFlowActionModel
• FlowActionsPendingActionModel
• FlowActionsRectifiedParticipantModel
• FlowActionsSignRuleUserEditModel
• FlowActionsSignRuleUserModel
• FlowActionsSignatureModel
• FlowActionsXadesOptionsModel
• FolderType
• FoldersFolderCreateRequest
• FoldersFolderDeleteRequest
• FoldersFolderInfoModel
• FoldersFolderOrganizationModel
• HealthDocumentsHealthDocumentData
• HealthDocumentsHealthItemModel
• HealthDocumentsHealthProfessionalModel
• InvoicesInvoiceTotalModel
• InvoicesUpdateInvoicePaymentStatusRequest
• NotarizationStatus
• NotaryTypes
• NotificationsCreateFlowActionReminderRequest
• NotificationsEmailListNotificationRequest
• ObserversObserverCreateModel
• ObserversObserverEditModel
• ObserversObserverModel
• OrganizationType
• OrganizationsAccessProfileModel
• OrganizationsOrganizationInfoModel
• OrganizationsOrganizationOwnerInfoModel
• OrganizationsOrganizationUserModel
• OrganizationsOrganizationUserPostRequest
• PaginatedSearchResponseDocumentFlowsDocumentFlowModel
• PaginatedSearchResponseDocumentsDocumentListModel
• PaginatedSearchResponseFoldersFolderInfoModel
• PaginatedSearchResponseOrganizationsOrganizationUserModel
• PaginationOrders
• ParticipantQueryTypes
• Probability
• RefusalRefusalModel
• RefusalRefusalRequest
• SecurityContextsAuthenticationTypesModel
• SecurityContextsSecurityContextSimpleModel
• SignatureDatavalidSelfieValidationResponse
• SignatureEvidencesModel
• SignatureGeolocationModel
• SignatureInitialsModes
• SignatureLiveness3dAuthenticationModel
• SignaturePixAuthenticationModel
• SignatureSelfieModel
• SignatureSignaturesInfoRequest
• SignatureTypes
• SignerModel
• TicketModel
• TimestampModel
• TransactionPricingTypes
• TransactionTypes
• TransactionsPriceRangeModel
• TransactionsTransactionPriceModel
• UploadModel
• UploadsUploadBytesModel
• UploadsUploadBytesRequest
• UsersParticipantUserModel
• ValidationItemModel
• ValidationResultsModel
• WebhookTypes
• WebhooksDocumentApprovedModel
• WebhooksDocumentCanceledModel
• WebhooksDocumentConcludedModel
• WebhooksDocumentExpiredModel
• WebhooksDocumentInformationModel
• WebhooksDocumentRefusedModel
• WebhooksDocumentSignedModel
• WebhooksDocumentsCreatedModel
• WebhooksDocumentsDeletedAction
• WebhooksDocumentsDeletedModel
• WebhooksInvoiceClosedModel
• WebhooksWebhookModel
• XadesElementIdentifierTypes
• XadesInsertionOptions
• XadesSignatureTypes
• XmlNamespaceModel

Documentation For Authorization

ApiKey

• Type: API key
• API key parameter name: X-Api-Key
• Location: HTTP header

Author