GetAccept provides a sales enablement platform for sales to design, send, promote, track, and e-sign sales documents, leveraging sales collateral, contract management, proposals, and electronic signatures in one place.
Status: Preview |
Tier: Premium |
Version: 1.6 |
Name |
Summary |
List attachments |
|
List contacts |
|
Create contact |
|
List documents |
|
Create and send document or template |
|
Get document details |
|
DownloadDocument (string documentId, [Optional]string direct) |
Download document |
Get document fields |
|
Get document recipients |
|
SealDocument (string documentId, [Optional]SealDocumentParameterBody body) |
Seal document |
SendDocument (string documentId, [Optional]SendDocumentParameterBody body) |
Send existing document |
Refresh an access token |
|
List available subscription events |
|
Delete subscription |
|
Get subscription details |
|
ListTemplates ([Optional]string showall, [Optional]string folder_id) |
List templates |
Get template fields |
|
Get template roles |
|
UploadDocument ([Optional]string file, [Optional]string file_name) |
Upload a document file |
UploadAttachment ([Optional]string file, [Optional]string file_name) |
Upload an attachment |
UploadVideo ([Optional]string file, [Optional]string file_name) |
Upload a video |
List users |
|
Create user |
|
Get user details |
|
List videos |
|
Authentication by token |
Name |
Summary |
Subscribe to document events |
|
CreateRejectedSubscription (CreateRejectedSubscriptionParameterBody body) |
When a document has been rejected |
CreateReviewedSubscription (CreateReviewedSubscriptionParameterBody body) |
When a document has been reviewed |
CreateSignedSubscription (CreateSignedSubscriptionParameterBody body) |
When a document has been signed |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Document |
|
|
|
Field |
|
Fields |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Recipient |
|
Recipients |
|
|
|
|
|
|
|
Subscription |
|
|
|
|
|
|
|
User |
|
Users |
Summary: List attachments
Description: Receive a list of available attachments. You can add new attachments in GetAccept using a new document.
Syntax:
GetAccept.ListAttachments ()
Returns:
Summary: List contacts
Description: Receive a list of available contact for the current entity. All contacts added as a recipient are saved as a contact and is available for later use on that entity.
Syntax:
GetAccept.ListContacts ()
Returns:
Type:ListContactsResponse
Summary: Create contact
Description: This will create a new contact in the database for the current entity
Syntax:
GetAccept.CreateContact (CreateContactParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Summary: List documents
Description: Get a list of available documents
Syntax:
GetAccept.ListDocuments ([Optional]string filter, [Optional]string sort_by, [Optional]string sort_order, [Optional]boolean showteam, [Optional]boolean showall, [Optional]string external_id, [Optional]number offset, [Optional]number limit)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
filter |
string (Filter list on status)Values: [draft, sent, viewed, reviewed, signed, rejected, recalled] |
Filter list on status |
False |
|
sort_by |
string (How to sort results)Values: [name, value, created, recipient, status, owner] |
How to sort results |
False |
|
sort_order |
string (Sort order of results)Values: [asc, desc] |
Sort order of results |
False |
|
showteam |
boolean (Include documents from team members)Values: [, ] |
Include documents from team members |
False |
|
showall |
boolean (Include all documents from entity)Values: [, ] |
Include all documents from entity |
False |
|
external_id |
string (External ID) |
An external ID is a custom field which can contain a unique record identifier from a system outside of GetAccept |
False |
|
offset |
number (Offset) |
Start list from record x until limit |
False |
|
limit |
number (Limit) |
Number of records to list |
False |
Returns:
Type:array of (ListDocumentsResponseItem)Documents
Title: Documents
Summary: Documents
Description: Document list
Summary: Create and send document or template
Description: You must create a document to be able to send it to a recipient. When creating a document you can refer to previously uploaded files with file_id or you can choose to create a document and upload the files in on API post. You can only upload ONE file when including a file in the create document POST. Use either file_ids parameter to use existing uploaded file(s), file_content to send the document as base64 encoded string or do a multipart post with file parameter. All recipients must have either a valid e-mail or a mobile number. All events are recorded using requestor IP address. You can override this using header CLIENT_IP containing the end-users public IP address.
Syntax:
GetAccept.CreateDocument (CreateDocumentParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:DocumentDocument
Title: Document
Summary: Document
Description: A document is one or multiple uploaded file(s) that is to be sent to one or many recipients created by a user.
Summary: Get document details
Description: Get document details by specifying a document id.
Syntax:
GetAccept.GetDocumentDetails (string documentId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
documentId |
string (Document ID) |
Document ID |
True |
Returns:
Type:DocumentDocument
Title: Document
Summary: Document
Description: A document is one or multiple uploaded file(s) that is to be sent to one or many recipients created by a user.
Summary: Download document
Description: Document file can always be downloaded but most likely you want to download it when it has status Signed. You can select to receive a download-url or get the binary file. The download URL is accessable 10 minutes after a request has been made.
Syntax:
GetAccept.DownloadDocument (string documentId, [Optional]string direct)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
documentId |
string (Document ID) |
Document ID |
True |
|
direct |
string (Return the binary file directly)Values: [true, false] |
Return the binary file directly |
False |
Returns:
Summary: Get document fields
Description: Get a list of fields for a document or template. Can be used both before and after a document has been signed.
Syntax:
GetAccept.ListDocumentFields (string documentId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
documentId |
string (Document ID) |
Document ID |
True |
Returns:
Type:FieldsFields
Title: Fields
Summary: Fields
Description: Field list
Summary: Get document recipients
Description: Get a list of recipients for a specific document.
Syntax:
GetAccept.ListRecipients (string documentId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
documentId |
string (Document ID) |
Document ID |
True |
Returns:
Type:RecipientsRecipients
Title: Recipients
Summary: Recipients
Description: Recipient list
Summary: Seal document
Description: If you prefer to send the document manually you can use this method to seal the document. Do not use this method if you send the document automatically or if you use the send document method above. This API call triggers the document seal action and can only be performed on documents with document_status = draft. The method will return individual access/signing links for each recipient. If document was created using self-sign option it will also be self-signed by the authenticated or specified user before sealing.
Syntax:
GetAccept.SealDocument (string documentId, [Optional]SealDocumentParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
documentId |
string (Document ID) |
Document ID |
True |
|
body |
|
|
False |
Returns:
Summary: Send existing document
Description: When you send a document via GetAccept, we deliver an email to all recipients, each containing a unique, secured link. This API call triggers the document send action and can only be performed on documents with document_status = draft. The document will be sent to recipients you provided when it was created. If document was created using self-sign option it will also be self-signed by the authenticated or specified user before sending.
Syntax:
GetAccept.SendDocument (string documentId, [Optional]SendDocumentParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
documentId |
string (Document ID) |
Document ID |
True |
|
body |
|
|
False |
Returns:
Type:DocumentDocument
Title: Document
Summary: Document
Description: A document is one or multiple uploaded file(s) that is to be sent to one or many recipients created by a user.
Summary: Refresh an access token
Description: You can request a refreshed of the access token before the original token has expired.
Syntax:
GetAccept.RefreshToken ()
Returns:
Type:RefreshTokenResponse
Summary: List available subscription events
Description: This call will return a list of available subscription events
Syntax:
GetAccept.ListSubscriptionEvents ()
Returns:
Type:array of (ListSubscriptionEventsResponseItem)
Summary: Delete subscription
Description: Delete a single subscription.
Syntax:
GetAccept.DeleteSubscription (string subscriptionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
subscriptionId |
string (Subscription ID) |
Subscription ID |
True |
Returns:
Summary: Get subscription details
Description: This call will return details of a single subscription
Syntax:
GetAccept.GetSubscriptionDetails (string subscriptionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
subscriptionId |
string (Subscription ID) |
Subscription ID |
True |
Returns:
Type:SubscriptionSubscription
Title: Subscription
Summary: Subscription
Description: Subscription details
Summary: List templates
Description: Receive a list of available document templates. You can add new templates under the Templates-section in GetAccept.
Syntax:
GetAccept.ListTemplates ([Optional]string showall, [Optional]string folder_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
showall |
string (Show all) |
Show all templates for entity |
False |
|
folder_id |
string (Folder ID) |
Show templates in a specific folder |
False |
Returns:
Summary: Get template fields
Description: Receive a list of fields for a specific template.
Syntax:
GetAccept.ListFields (string templateId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
templateId |
string (Template ID) |
Template ID |
True |
Returns:
Type:FieldsFields
Title: Fields
Summary: Fields
Description: Field list
Summary: Get template roles
Description: Receive a list of roles for a specific template.
Syntax:
GetAccept.ListRoles (string templateId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
templateId |
string (Template ID) |
Template ID |
True |
Returns:
Type:ListRolesResponse
Summary: Upload a document file
Description: You can upload one file at a time and get a file id. The file id is used to connect a file with a GetAccept document which is sent to recipients. If you want to upload mutliple files you run multiple POST. We only accept files up to 10 MB as default. Uploaded file need to be imported/added to a document within 48 hours after uploading. We recommended you to upload PDF files in order to guarantee the same look when sent. Other file types can be converted, such as: Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv
Syntax:
GetAccept.UploadDocument ([Optional]string file, [Optional]string file_name)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
file |
string(binary) (Binary File) |
Binary File |
False |
|
file_name |
string (File name) |
Filename of the document, with the extension. This will be helpful for converting different file-types. |
False |
Returns:
Summary: Upload an attachment
Description: You can upload attachment files to include with documents you send. Successful request will return the attachment_id. Use attachment_id to assign an attachment to a document.
Syntax:
GetAccept.UploadAttachment ([Optional]string file, [Optional]string file_name)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
file |
string(binary) (Binary File) |
Binary File |
False |
|
file_name |
string (File name) |
Filename of the document, with the extension. This will be helpful for converting different file-types. |
False |
Returns:
Summary: Upload a video
Description: You can upload attachment files to include with documents you send. Successful request will return the attachment_id. Use attachment_id to assign an attachment to a document.
Syntax:
GetAccept.UploadVideo ([Optional]string file, [Optional]string file_name)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
file |
string(binary) (Binary File) |
Binary File |
False |
|
file_name |
string (File name) |
Filename of the video, with the extension. This will be helpful for converting different file-types. |
False |
Returns:
Type:UploadVideoResponse
Summary: List users
Description: Fetch a list of active users for the current authenticated entity
Syntax:
GetAccept.ListUsers ()
Returns:
Type:UsersUsers
Title: Users
Summary: Users
Description: User list
Summary: Create user
Description: This will create a new contact in the database for the current entity
Syntax:
GetAccept.CreateUser (CreateUserParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:UserUser
Title: User
Summary: User
Description: A user is defined by it´s e-mail address and is connected to one or many entities. ### User Roles #### Administrator: - View all documents - Edit all documents - Change entity settings, info and billing - Add new users to the entity - Assign entity roles #### Manager: - View team documents - Edit all documents - Add new users to the entity ## Entity An entity is the top node and all users and corresponding documents are connected to an entity. An entity is often the same as a company, a country or a department in a large organization.
Summary: Get user details
Description: This call will return details of a single user. Receive details and available entities of the current authenticated user using user-id *me*
Syntax:
GetAccept.GetUserDetails (string userId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
userId |
string (User ID) |
User ID |
True |
Returns:
Type:UserUser
Title: User
Summary: User
Description: A user is defined by it´s e-mail address and is connected to one or many entities. ### User Roles #### Administrator: - View all documents - Edit all documents - Change entity settings, info and billing - Add new users to the entity - Assign entity roles #### Manager: - View team documents - Edit all documents - Add new users to the entity ## Entity An entity is the top node and all users and corresponding documents are connected to an entity. An entity is often the same as a company, a country or a department in a large organization.
Summary: List videos
Description: Receive a list of available videos on the entity. You can add new videos in the mobile app or inside GetAccept.
Syntax:
GetAccept.ListVideos ()
Returns:
Type:ListVideosResponse
Summary: Authentication by token
Description: Token based authentication is recommended for server-based access or access from clients where OAuth is not suitable. Access tokens has to be requested using an administrators login credentials. Requests should include the header Content-Type with value application/json
Syntax:
GetAccept.Authenticate (AuthenticateParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Authentication model |
True |
Returns:
Type:AuthenticateResponse
Summary: Subscribe to document events
Description: This call will create a new subscription. The response will be wrapped in an array even for single object according to REST hook standards. >Events * `document.created` - Document is created * `document.sent` - Document is sent * `document.viewed` - Document is sent * `document.signed` - Document is signed * `document.approved` - Document is approved * `document.expired` - Document has expired * `document.rejected` - Document is rejected * `document.downloaded` - Document is downloaded * `document.printed` - Document is printed * `document.forwarded` - Document is forwarded * `document.partially_signed` - Document has been partially signed * `document.commented` - Document is commented * `document.hardbounced` - Document is hardbounced * `document.imported` - Document is imported
Syntax:
GetAccept.CreateSubscription (CreateSubscriptionParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
CreateSubscriptionParameterBody
|
|
True |
Returns:
Type:SubscriptionSubscription
Title: Subscription
Summary: Subscription
Description: Subscription details
Summary: When a document has been rejected
Description: Triggers when a document has been rejected by any of the recipients
Syntax:
GetAccept.CreateRejectedSubscription (CreateRejectedSubscriptionParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
CreateRejectedSubscriptionParameterBody
|
|
True |
Returns:
Type:SubscriptionSubscription
Title: Subscription
Summary: Subscription
Description: Subscription details
Summary: When a document has been reviewed
Description: Triggers when a document has been reviewed by any of the recipients
Syntax:
GetAccept.CreateReviewedSubscription (CreateReviewedSubscriptionParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
CreateReviewedSubscriptionParameterBody
|
|
True |
Returns:
Type:SubscriptionSubscription
Title: Subscription
Summary: Subscription
Description: Subscription details
Summary: When a document has been signed
Description: Triggers when a document has been signed by all signing parties
Syntax:
GetAccept.CreateSignedSubscription (CreateSignedSubscriptionParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
CreateSignedSubscriptionParameterBody
|
|
True |
Returns:
Type:SubscriptionSubscription
Title: Subscription
Summary: Subscription
Description: Subscription details
Summary:
Description: Authentication model
Properties:
Name |
Type |
Summary |
client_id |
string
|
The client id of your app if you received one from our API team |
|
string(email)
|
This is the email of the user in GetAccept |
entity_id |
string
|
This specifies what entity to select if multiple entities are available for a user. If no value is specified the default entity will be selected. |
password |
string(password)
|
This is the password of the user in GetAccept |
Summary:
Description:
Properties:
Name |
Type |
Summary |
access_token |
string
|
Token to be used in consequtive requests using bearer header |
expires_in |
integer(int64)
|
Seconds until the access token expires |
Summary:
Description:
Properties:
Name |
Type |
Summary |
company_name |
string
|
Associated company name |
company_number |
string
|
Associated company number |
|
string
|
Email address of the contact |
first_name |
string
|
First name of the contact |
fullname |
string
|
Use to specify full name instead of first/last name |
last_name |
string
|
Last name of the contact |
mobile |
string
|
Mobile number in international format |
note |
string
|
Optional internal note for contact |
phone |
string
|
Phone number in international format |
title |
string
|
The title of the contact, ex. CEO, Sales manager |
Summary:
Description:
Properties:
Name |
Type |
Summary |
contact_id |
string Contact ID |
ID of the created contact |
Summary:
Description:
Properties:
Name |
Type |
Summary |
attachments |
array of (AttachmentsItem) Attachment |
Attachments |
custom_fields |
array of (Custom_fieldsItem) Custom |
Custom field |
expiration_date |
string(date-time) Expiration date |
Date and time when the document should expire |
external_id |
string External ID |
External system ID for identification |
file_content |
string File content |
Base64 encoded file content |
file_ids |
string File IDs |
Comma-separated, unique file-ids received when uploading files |
file_url |
string File URL |
Url to document file. Documents must be public available for download |
is_automatic_sending |
boolean Send automatically |
If the document should be sent after creation Values: [, ] |
is_reminder_sending |
boolean Send reminders |
Should automatic reminders be sent Values: [, ] |
is_scheduled_sending |
boolean Schedule sending |
Should the sending be scheduled for sending in the future Values: [, ] |
is_signing |
boolean Sign document |
Should the document be sent for signing Values: [, ] |
is_signing_biometric |
boolean Handwritten signature |
Use handwritten signature Values: [, ] |
is_signing_forward |
boolean Allow signature transfer |
Should recipients be able to transfer signature rights Values: [, ] |
is_signing_initials |
boolean Sign with initials |
Sign document using recipient initials Values: [, ] |
is_sms_sending |
boolean Send SMS |
Should the document be sent to recipient mobile by text Values: [, ] |
name |
string Document name |
Enter a name of the document |
recipients |
array of (RecipientsItem) Recipient |
|
scheduled_sending_time |
string(date-time) Schedule send date |
Date and time when the document should be sent out |
sender_email |
string Sender email override |
Send from other email than authenticated user |
sender_id |
string Sender user override |
Send from other user than authenticated |
template_id |
string Template ID |
Select a template to use for the sending |
type |
string Document type |
Set the type/category of the document Values: [sales, introduction, hr, other] |
value |
integer(int32) Document value |
Value of deal or document |
video_id |
string Video ID |
Select a video to use for the sending |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string ID |
Attachment ID received from list or after upload |
require_view |
boolean Require view |
Require that recipient view the attachment Values: [, ] |
type |
string Type |
file or external where file is an uploaded file and external is a link to an external file Values: [file, external] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Field ID |
ID of custom template field |
name |
string Field Name |
Name of custom template field |
value |
string Field Value |
Value of custom template field |
Summary:
Description:
Properties:
Name |
Type |
Summary |
company_name |
string Company name |
Company name of the recipient |
company_number |
string Company number |
Company number of the recipient |
|
string |
Email address of the recipient |
first_name |
string First name |
Recipient first name |
last_name |
string Last name |
Last name of recipient |
mobile |
string Mobile |
Mobile phone in international format |
note |
string Note |
Additional note for a recipient |
order_num |
integer(int32) Signing order |
If signing order is enabled |
role |
string Recipient type |
The kind of recipient in the document Values: [signer, approver, cc] |
role_name |
string Template role |
The name of the role in a template |
verify_eid |
boolean Verify EID |
Verify using EID Values: [, ] |
verify_eid_type |
string EID type |
EID type to be used for personal verification |
verify_qna |
boolean Enable question |
Should a question be asked Values: [, ] |
verify_qna_answer |
string Verification answer |
The answer to question |
verify_qna_open |
boolean Question on open |
Should question be asked before opening document Values: [, ] |
verify_qna_question |
string Verification question |
Question to ask for verification |
verify_qna_sign |
boolean Sign question |
Should a question be asked before signing Values: [, ] |
verify_sms |
boolean Verify SMS |
Verify recipient by SMS Values: [, ] |
verify_sms_open |
boolean Verify SMS on open |
Verify SMS on open Values: [, ] |
verify_sms_sign |
boolean Verify by SMS |
Should a SMS verify the recipient before signing Values: [, ] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
host |
string
|
The host name to send the post to |
event |
string Event trigger |
Event trigger |
global |
boolean All entity users |
If the webhook should catch events for all entity users. Values: [, ] |
notification_email |
string Error email |
If the event fails, send a notification to this email instead of the sender |
payload |
string Payload |
Additional payload data to post |
target_url |
string
|
The URL to post payload to on event |
Summary:
Description:
Properties:
Name |
Type |
Summary |
host |
string
|
The host name to send the post to |
event |
string Event trigger |
Event trigger |
global |
boolean All entity users |
If the webhook should catch events for all entity users. Values: [, ] |
notification_email |
string Error email |
If the event fails, send a notification to this email instead of the sender |
payload |
string Payload |
Additional payload data to post |
target_url |
string
|
The URL to post payload to on event |
Summary:
Description:
Properties:
Name |
Type |
Summary |
host |
string
|
The host name to send the post to |
event |
string Event trigger |
Event trigger |
global |
boolean All entity users |
If the webhook should catch events for all entity users. Values: [, ] |
notification_email |
string Error email |
If the event fails, send a notification to this email instead of the sender |
payload |
string Payload |
Additional payload data to post |
target_url |
string
|
The URL to post payload to on event |
Summary:
Description:
Properties:
Name |
Type |
Summary |
host |
string
|
The host name to send the post to |
event |
string Select event |
Event trigger Values: [document.created, document.sent, document.viewed, document.reviewed, document.signed, document.approved, document.expired, document.rejected, document.downloaded, document.printed, document.forwarded, document.partially_signed, document.commented, document.hardbounced, document.imported] |
global |
boolean All entity users |
If the webhook should catch events for all entity users. Values: [, ] |
notification_email |
string Error email |
If the event fails, send a notification to this email instead of the sender |
payload |
string Payload |
Additional payload data to post |
target_url |
string
|
The URL to post payload to on event |
Summary:
Description:
Properties:
Name |
Type |
Summary |
company_name |
string
|
Associated company name |
company_number |
string
|
Associated company number |
|
string
|
Email address of the contact |
first_name |
string
|
First name of the contact |
fullname |
string
|
Use to specify full name instead of first/last name |
last_name |
string
|
Last name of the contact |
mobile |
string
|
Mobile number in international format |
note |
string
|
Optional internal note for contact |
phone |
string
|
Phone number in international format |
title |
string
|
The title of the contact, ex. CEO, Sales manager |
Summary: Document
Description: A document is one or multiple uploaded file(s) that is to be sent to one or many recipients created by a user.
Properties:
Name |
Type |
Summary |
tags |
string Tags |
|
auto_comment_email |
string
|
|
auto_comment_text |
string Automatic chat text |
|
company_id |
string
|
|
company_logo_url |
string
|
|
company_name |
string
|
|
company_number |
string
|
|
created_at |
string Created at |
|
download_url |
string Download URL |
|
email_send_message |
string Email message |
|
email_send_subject |
string Email Subject |
|
email_send_template_id |
string Email send template ID |
|
entity_auto_comment_text |
string
|
|
expiration_date |
string Expiration date |
|
external_client_id |
string External Client ID |
|
external_editor_id |
string
|
|
external_editor_type |
string
|
|
external_id |
string External ID |
|
field_count |
integer(int32) Field count |
|
id |
string ID |
|
is_auto_comment |
boolean Auto comment |
|
is_auto_comment_email |
boolean
|
|
is_identify_recipient |
boolean
|
|
is_private |
boolean Is private |
|
is_reminder_sending |
boolean Send reminders |
|
is_scheduled_sending |
boolean Scheduled sending |
|
is_selfsign |
boolean Is Self-signing |
|
is_signed |
boolean Is signed |
|
is_signing |
boolean
|
|
is_signing_biometric |
boolean Handwritten signature |
|
is_signing_forward |
boolean Allow signature transfer |
|
is_signing_initials |
boolean
|
|
is_signing_order |
boolean Signature order |
|
is_video |
boolean
|
|
name |
string Name |
|
parent_id |
string Parent ID |
|
preview_url |
string Preview URL |
|
recipients |
array of (Recipient)
|
|
scheduled_sending_time |
string Scheduled sending time |
|
send_date |
string Send date |
|
sender_email |
string Sender email |
|
sender_name |
string Sender name |
|
sender_thumb_url |
string Sender thumb URL |
|
sign_date |
string Sign date |
|
status |
string Status |
|
thumb_url |
string Thumb URL |
|
type |
string Type |
|
unique_id |
integer(int32) Unique ID |
|
user_id |
string User ID |
|
value |
integer(int32) Value |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
document_url |
string
|
|
file |
string
|
|
Summary: Field
Description: Field details
Properties:
Name |
Type |
Summary |
field_height |
integer(int32)
|
|
field_id |
string
|
|
field_label |
string
|
|
field_left |
integer(int32)
|
|
field_top |
integer(int32)
|
|
field_type |
string
|
|
field_value |
string
|
|
field_width |
integer(int32)
|
|
is_collectable |
boolean
|
|
is_editable |
boolean
|
|
is_required |
boolean
|
|
page_id |
string
|
|
recipient_id |
string
|
|
recipient_name |
string
|
|
validation_regex |
string
|
|
validation_warning |
string
|
|
Summary: Fields
Description: Field list
Properties:
Name |
Type |
Summary |
fields |
array of (Field)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
attachments |
array of (AttachmentsItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
attachment_id |
string
|
|
attachment_title |
string
|
|
attachment_type |
string
|
|
attachment_url |
string
|
|
library |
boolean
|
|
published |
boolean
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
tags |
string
|
|
company_name |
string
|
|
created_at |
string
|
|
expiration_date |
string
|
|
id |
string
|
|
is_private |
boolean
|
|
is_signing |
boolean
|
|
name |
string
|
|
sender_name |
string
|
|
sender_thumb |
string
|
|
status |
string
|
|
type |
string
|
|
value |
integer(int32)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
roles |
array of (RolesItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
|
string
|
|
first_name |
string
|
|
last_name |
string
|
|
mobile |
string
|
|
role |
string
|
|
role_id |
string
|
|
role_name |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
|
value |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
templates |
array of (TemplatesItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
tags |
string
|
|
created_at |
string
|
|
external_editor_type |
string
|
|
field_count |
integer(int32)
|
|
id |
string
|
|
is_editable |
boolean
|
|
is_private |
boolean
|
|
name |
string
|
|
page_count |
integer(int32)
|
|
role_count |
integer(int32)
|
|
sender_name |
string
|
|
sender_thumb_url |
string
|
|
thumb_url |
string
|
|
type |
string
|
|
user_id |
string
|
|
video_id |
string
|
|
video_thumb_url |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
videos |
array of (VideosItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
editable |
boolean
|
|
published |
boolean
|
|
saved |
boolean
|
|
thumb_url |
string
|
|
video_id |
string
|
|
video_title |
string
|
|
video_type |
string
|
|
video_url |
string
|
|
Summary: Recipient
Description: Every unique e-mail address (or mobile number) that is connected to a document is a recipient.
Properties:
Name |
Type |
Summary |
company_name |
string Company name |
Company name of the recipient |
company_number |
string Company number |
Company number of the recipient |
document_url |
string Document URL |
Unique URL for the recipient to view/sign |
|
string Recipient email |
Name of the created document |
first_name |
string First name |
First name of the recipient |
fullname |
string Full name |
Full name of the recipient |
gender |
string Gender |
Gender of the recipient |
id |
string ID |
ID of the recipient |
last_name |
string Last name |
Last name of the recipient |
mobile |
string Mobile |
Mobile number of the recipient |
note |
string Note |
Note of the recipient |
order_num |
string Signing order num |
Signing order of the recipient |
role |
string
|
|
status |
string Status |
Status of the recipient |
thumb_url |
string Thumb URL |
Thumb URL of the recipient |
title |
string Title |
Title of the recipient |
Summary: Recipients
Description: Recipient list
Properties:
Name |
Type |
Summary |
recipients |
array of (Recipient)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
access_token |
string
|
|
expires_in |
integer(int64)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
sender_email |
string
|
Use this to specify the sender user/owner by email address to be used for self-signing the document. |
sender_id |
string
|
Use this to specify the sender user/owner by id to be used for self-signing the document. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
sender_email |
string(email)
|
Use this to specify the sender user/owner by email address to be used for self-signing the document. |
sender_id |
string
|
Use this to specify the sender user/owner by id to be used for self-signing the document. |
Summary: Subscription
Description: Subscription details
Properties:
Name |
Type |
Summary |
host |
string
|
|
created_at |
string
|
|
event |
string
|
|
global |
boolean
|
|
id |
string
|
|
notification_email |
string
|
|
payload |
string
|
|
status |
integer(int32)
|
|
subscription_id |
string
|
|
target_url |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
filename |
string File name |
File name of the attachment |
id |
string Attachment ID |
ID of the uploaded attachment to be used in attachment_id when creating a document |
title |
string Attachment title |
Title of the attachment |
type |
string Attachment type |
Type of the attachment |
Summary:
Description:
Properties:
Name |
Type |
Summary |
file_id |
string
|
ID of the uploaded file to be used in file_ids when creating a document |
file_status |
string
|
Status of the uploaded file |
Summary:
Description:
Properties:
Name |
Type |
Summary |
file_status |
string File status |
Status of the video |
filename |
string File name |
File name of the video |
job_id |
string Job ID |
Id of the processing job converting and compressing the video. Poll for job status updates using /video/job/<ID>. |
video_id |
string Video ID |
ID of the uploaded video to be used in video_id when creating a document |
Summary: User
Description: A user is defined by it´s e-mail address and is connected to one or many entities. ### User Roles #### Administrator: - View all documents - Edit all documents - Change entity settings, info and billing - Add new users to the entity - Assign entity roles #### Manager: - View team documents - Edit all documents - Add new users to the entity ## Entity An entity is the top node and all users and corresponding documents are connected to an entity. An entity is often the same as a company, a country or a department in a large organization.
Properties:
Name |
Type |
Summary |
app_mode |
string App Mode |
|
disallow_create |
boolean
|
|
|
string |
Email address of the user |
entity_id |
string Entity ID |
|
entity_name |
string Entity Name |
|
first_name |
string First name |
First name of the user |
id |
string ID |
ID of the user |
language |
string Language |
|
last_name |
string Last name |
Last name of the user |
mobile |
string mobile |
Mobile number in international format |
note |
string Note |
Optional internal note for user |
phone |
string Phone |
Phone number in international format |
role |
string Role |
Values: [user, manager, admin] |
skip_invitation |
boolean Skip sending invitation |
Values: [, ] |
status |
string Status |
|
team_id |
string Team ID |
|
thumb_url |
string Thumb URL |
|
timezone |
string Timezone |
|
title |
string Title |
The title of the user, ex. CEO, Sales manager |
Summary: Users
Description: User list
Properties:
Name |
Type |
Summary |
users |
array of (UsersItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
|
string
|
|
first_name |
string
|
|
last_login |
string
|
|
last_name |
string
|
|
name |
string
|
|
role |
string
|
|
status |
string
|
|
team_name |
string
|
|
user_id |
string
|
|