How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Dropbox Sign (HelloSign) Signature Request API

{'$ref': './markdown/en/tags/signature-request-tag-description.md'}

Dropbox Sign (HelloSign) Signature Request API is one of 13 APIs that Dropbox Sign (HelloSign) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Signature Request. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 20 operations across 20 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

Requests are made against a single base URL, https://api.hellosign.com/v3.

20 operations 20 paths 42 schemas 5 GET11 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Base URL
https://api.hellosign.com/v3
Authentication
HTTP Basic, HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Dropbox Sign (HelloSign) Signature Request API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (api_key). It accepts HTTP bearer tokens (JWT) (oauth2). By default, every request must be authenticated.

  • api_key — Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information. ✅ Supported by Try it…
  • oauth2 — You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are l…

Paths & Operations 20

Across 20 paths, the API surfaces 20 operations — 5 GET, 11 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Signature Request 20

{'$ref': './markdown/en/tags/signature-request-tag-description.md'}

POST
/signature_request/bulk_create_embedded_with_template
Embedded Bulk Send with Template
signatureRequestBulkCreateEmbeddedWithTemplate body → 2004XX
POST
/signature_request/bulk_send_with_template
Bulk Send with Template
signatureRequestBulkSendWithTemplate body → 2004XX
POST
/signature_request/cancel/{signature_request_id}
Cancel Incomplete Signature Request
signatureRequestCancel 1 param → 2004XX
POST
/signature_request/create_embedded
Create Embedded Signature Request
signatureRequestCreateEmbedded body → 2004XX
POST
/signature_request/create_embedded_with_template
Create Embedded Signature Request with Template
signatureRequestCreateEmbeddedWithTemplate body → 2004XX
PUT
/signature_request/edit/{signature_request_id}
Edit Signature Request
signatureRequestEdit 1 param body → 2004XX
PUT
/signature_request/edit_embedded/{signature_request_id}
Edit Embedded Signature Request
signatureRequestEditEmbedded 1 param body → 2004XX
PUT
/signature_request/edit_embedded_with_template/{signature_request_id}
Edit Embedded Signature Request with Template
signatureRequestEditEmbeddedWithTemplate 1 param body → 2004XX
PUT
/signature_request/edit_with_template/{signature_request_id}
Edit Signature Request With Template
signatureRequestEditWithTemplate 1 param body → 2004XX
GET
/signature_request/files/{signature_request_id}
Download Files
signatureRequestFiles 2 params → 2004XX
GET
/signature_request/files_as_data_uri/{signature_request_id}
Download Files as Data Uri
signatureRequestFilesAsDataUri 1 param → 2004XX
GET
/signature_request/files_as_file_url/{signature_request_id}
Download Files as File Url
signatureRequestFilesAsFileUrl 2 params → 2004XX
GET
/signature_request/{signature_request_id}
Get Signature Request
signatureRequestGet 1 param → 2004XX
GET
/signature_request/list
List Signature Requests
signatureRequestList 4 params → 2004XX
POST
/signature_request/release_hold/{signature_request_id}
Release On-Hold Signature Request
signatureRequestReleaseHold 1 param → 2004XX
POST
/signature_request/remind/{signature_request_id}
Send Request Reminder
signatureRequestRemind 1 param body → 2004XX
POST
/signature_request/remove/{signature_request_id}
Remove Signature Request Access
signatureRequestRemove 1 param → 2004XX
POST
/signature_request/send
Send Signature Request
signatureRequestSend body → 2004XX
POST
/signature_request/send_with_template
Send with Template
signatureRequestSendWithTemplate body → 2004XX
POST
/signature_request/update/{signature_request_id}
Update Signature Request
signatureRequestUpdate 1 param body → 2004XX

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are SignatureRequestEditRequest (25 properties), SignatureRequestResponse (25 properties), SignatureRequestSendRequest (25 properties), SignatureRequestEditEmbeddedRequest (24 properties). Each schema is shown below with its type and property counts.

ErrorResponseError
object
Contains information about an error that occurred.
3 properties 2 required
SignatureRequestBulkCreateEmbeddedWithTemplateRequest
object
13 properties 2 required
SubFormFieldRuleTrigger
object
4 properties 2 required
SubBulkSignerList
object
2 properties
SubSigningOptions
object
This allows the requester to specify the types allowed for creating a signature and specify another signing options. NOTE: If signingoptions are not defined in…
6 properties 1 required
SubFormFieldRule
object
4 properties 4 required
WarningResponse
object
A list of warnings.
2 properties 2 required
SubAttachment
object
4 properties 2 required
SubFormFieldsPerDocumentBase
object
The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document]…
11 properties 9 required
SignatureRequestResponseAttachment
object
Signer attachments.
6 properties 4 required
SignatureRequestEditEmbeddedRequest
object
24 properties 1 required
SubSignatureRequestTemplateSigner
object
6 properties 3 required
SignatureRequestSendWithTemplateRequest
object
16 properties 2 required
SignatureRequestGetResponse
object
2 properties 1 required
SignatureRequestUpdateRequest
object
4 properties 1 required
SignatureRequestEditWithTemplateRequest
object
16 properties 2 required
ErrorResponse
object
1 property 1 required
SignatureRequestCreateEmbeddedWithTemplateRequest
object
15 properties 3 required
SignatureRequestEditRequest
object
25 properties
SubSignatureRequestGroupedSigners
object
3 properties 2 required
FileResponseDataUri
object
1 property 1 required
SignatureRequestSendRequest
object
25 properties
SignatureRequestRemindRequest
object
2 properties 1 required
SubCC
object
2 properties 2 required
ListInfoResponse
object
Contains pagination information about the data returned.
4 properties
SignatureRequestResponseDataBase
object
An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
5 properties
SignatureRequestResponse
object
Contains information about a signature request.
25 properties
SignatureRequestListResponse
object
3 properties 2 required
SubSignatureRequestSigner
object
6 properties 2 required
BulkSendJobResponse
object
Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.
4 properties
SignatureRequestCreateEmbeddedRequest
object
24 properties 1 required
SignatureRequestEditEmbeddedWithTemplateRequest
object
15 properties 3 required
BulkSendJobSendResponse
object
2 properties 1 required
SubCustomField
object
When used together with merge fields, customfields allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once…
4 properties 1 required
SubFormFieldRuleAction
object
4 properties 2 required
SignatureRequestResponseCustomFieldBase
object
An array of Custom Field objects containing the name and type of each custom field. Text Field uses SignatureRequestResponseCustomFieldText Checkbox Field uses…
5 properties 2 required
SignatureRequestResponseSignatures
object
An array of signature objects, 1 for each signer.
19 properties
FileResponse
object
2 properties 2 required
SubFormFieldGroup
object
3 properties 3 required
SubFieldOptions
object
This allows the requester to specify field options for a signature request.
1 property 1 required
SubBulkSignerListCustomField
object
2 properties 2 required
SignatureRequestBulkSendWithTemplateRequest
object
13 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hellosign-signature-request-api-openapi.yml Raw ↑

Other APIs Dropbox Sign (HelloSign) publishes across the network.

Dropbox Sign (HelloSign) Account API
Dropbox Sign (HelloSign) Api App API
Dropbox Sign (HelloSign) Bulk Send Job API
Dropbox Sign (HelloSign) Embedded API
Dropbox Sign (HelloSign) Fax API
Dropbox Sign (HelloSign) Fax Line API
Dropbox Sign (HelloSign) OAuth API
Dropbox Sign (HelloSign) Report API
Dropbox Sign (HelloSign) Team API
Dropbox Sign (HelloSign) Template API
Dropbox Sign (HelloSign) Unclaimed Draft API
Dropbox Sign (HelloSign) Callbacks and Events API
Where this information came from

This is an independent, third-party profile of Dropbox Sign (HelloSign) Signature Request API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.