Nitro Software Sign API
The Sign API from Nitro Software — 22 operation(s) for sign.
Nitro Software Sign API is one of 3 APIs that Nitro Software publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Sign. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.
This API exposes 32 operations across 22 paths, and defines 72 schemas. It is described by OpenAPI 3.1.0, at version 0.1.
Requests are made against a single base URL, https://api.gonitro.dev.
32 operations
22 paths
72 schemas
4 DELETE13 GET4 PATCH9 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Nitro Software Sign API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 32
Across 22 paths, the API surfaces 32 operations — 4 DELETE, 13 GET, 4 PATCH, 9 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Sign 32
PUT
/sign/envelopes/{envelopeID}:cancel
Cancel Envelope by ID
PUT
/sign/envelopes/{envelopeID}/documents:reorder
Reorder Documents by Envelope ID
POST
/sign/envelopes/{envelopeID}:send-reminders
Send Reminders for Envelope
POST
/sign/envelopes/{envelopeID}:send-for-signing
Send Envelope for Signing
POST
/sign/envelopes/{envelopeID}/participants:batch-delete
Delete Participants by Participant IDs
GET
/sign/envelopes/{envelopeID}/participants
List Participants by Envelope ID
POST
/sign/envelopes/{envelopeID}/participants
Create Participant(s) by Envelope ID
POST
/sign/envelopes/{envelopeID}/documents/{documentID}/fields:batch-delete
Delete Fields by Field IDs
GET
/sign/envelopes/{envelopeID}/documents/{documentID}/fields
List Fields by Document ID
POST
/sign/envelopes/{envelopeID}/documents/{documentID}/fields
Create Field(s) by Document ID
GET
/sign/envelopes/{envelopeID}/documents
List Documents by Envelope ID
POST
/sign/envelopes/{envelopeID}/documents
Create Document by Envelope ID
GET
/sign/envelopes
List Envelopes
POST
/sign/envelopes
Create Envelope
POST
/sign/conversionsdeprecated
Convert File to PDF
DELETE
/sign/envelopes/{envelopeID}/participants/{participantID}
Delete Participant by ID
PATCH
/sign/envelopes/{envelopeID}/participants/{participantID}
Update Participant by ID
DELETE
/sign/envelopes/{envelopeID}/documents/{documentID}/fields/{fieldID}
Delete Field by ID
PATCH
/sign/envelopes/{envelopeID}/documents/{documentID}/fields/{fieldID}
Update Field by ID
GET
/sign/envelopes/{envelopeID}/documents/{documentID}
Get Document by ID
DELETE
/sign/envelopes/{envelopeID}/documents/{documentID}
Delete Document by ID
PATCH
/sign/envelopes/{envelopeID}/documents/{documentID}
Update Document by ID
GET
/sign/envelopes/{envelopeID}
Get Envelope by ID
DELETE
/sign/envelopes/{envelopeID}
Delete Envelope by ID
PATCH
/sign/envelopes/{envelopeID}
Update Envelope
GET
/sign/envelopes/{envelopeID}:download-sealed
Download Sealed Envelope
GET
/sign/envelopes/{envelopeID}:download-original
Download Original Envelope
GET
/sign/envelopes/{envelopeID}:download-audit-trail
Download Audit Trail of Envelope
GET
/sign/envelopes/{envelopeID}/participants/signing-urls
List Signer Signing URLs by Envelope ID
GET
/sign/envelopes/{envelopeID}/documents/{documentID}:download-sealed
Download Sealed Document by ID
GET
/sign/conversions/{jobID}:download-converteddeprecated
Get Converted File by Job ID
GET
/sign/conversions/{jobID}/statusdeprecated
Get Conversion Job Status
Schemas 72
The contract defines 72 schemas that model the data the API accepts and returns. The most detailed are CreateDateFieldResponse (9 properties), Date (9 properties), CreateCustomFieldResponse (8 properties), Custom (8 properties). Each schema is shown below with its type and property counts.
UpdateCustomField
object
Parameters to update a Custom field
6 properties
1 required
NotFoundProblemDetail
object
Not Found error details
6 properties
EnvelopeWebDocumentRequestMetadata
object
2 properties
1 required
CreateCustomFieldResponse
object
Create Custom Field Response
8 properties
5 required
ContentTooLargeProblemDetail
object
Content too large error details
6 properties
CreateCompanyFieldResponse
object
Create Company Field Response
7 properties
4 required
InternalServerErrorProblemDetail
object
Internal Server Error details
6 properties
CreateNameFieldResponse
object
Create Name Field Response
7 properties
4 required
SMS
object
SMS
3 properties
UpdateTitleField
object
Parameters to update a Title field
5 properties
1 required
CreateTitleField
object
Parameters to create a Title field
5 properties
3 required
ParticipantCreate
object
Request to create a new participant
3 properties
1 required
DeleteFieldsRequest
object
A set of unique UUIDv4 strings that identify the fields in the Nitro system.
1 property
JobStatusResponse
object
2 properties
ParticipantUpdate
object
1 property
CreateInitialsField
object
Parameters to create a Initials field
5 properties
3 required
UpdateSignatureField
object
Parameters to update a Signature field
5 properties
1 required
Notification
object
2 properties
2 required
CreateTitleFieldResponse
object
Create Title Field Response
7 properties
4 required
CreateDateField
object
Parameters to create a Date field
7 properties
3 required
Custom
object
Response representing a Custom field
8 properties
5 required
RenameDocumentRequest
object
1 property
1 required
ParticipantList
object
Fields
2 properties
EnvelopeInInvalidStateProblemDetail
object
Envelope in invalid state
6 properties
ExtendedEnvelope
object
7 properties
UpdateNameField
object
Parameters to update a Name field
5 properties
1 required
SealedDocumentResponse
object
Response for a sealed document
6 properties
2 required
CreateCheckboxFieldResponse
object
Create Checkbox Field Response
7 properties
4 required
CreateSignatureField
object
Parameters to create a Signature field
5 properties
3 required
DocumentNotFoundProblemDetail
object
Document Not Found error details
6 properties
UnprocessableEntityProblemDetail
object
Unprocessable Entity error details
6 properties
ConvertFileResponse
object
3 properties
1 required
Initials
object
Response representing an Initials field
7 properties
4 required
CreateInitialsFieldResponse
object
Create Initials Field Response
7 properties
4 required
BadRequestProblemDetail
object
Bad Request error details
6 properties
EnvelopeList
object
Fields
2 properties
DeleteParticipantsRequest
object
A set of unique UUIDv4 strings that identify the participants in the Nitro system.
1 property
AccessCode
object
Access code
2 properties
EnvelopeCreate
object
3 properties
3 required
UpdateCheckboxField
object
Parameters to update a Checkbox field
5 properties
1 required
Name
object
Response representing a Name field
7 properties
4 required
UpdateInitialsField
object
Parameters to update a Initials field
5 properties
1 required
SignerSigningUrlList
object
Fields
2 properties
BulkFieldRequest
object
Create multiple fields wrapped in an items array
1 property
1 required
UploadedDocumentResponse
object
Response for an uploaded document
6 properties
2 required
SendReminders
object
1 property
BulkParticipantResponse
object
Response containing multiple created participants wrapped in an items array
1 property
1 required
Checkbox
object
Response representing a Checkbox field
7 properties
4 required
UnsupportedMediaTypeDetail
object
Unsupported Media Type error details
6 properties
SignerSigningUrl
object
3 properties
UpdateDateField
object
Parameters to update a Date field
7 properties
1 required
CreateSignatureFieldResponse
object
Create Signature Field Response
7 properties
4 required
CreateDateFieldResponse
object
Create Date Field Response
9 properties
4 required
Company
object
Response representing a Company field
7 properties
4 required
Participant
object
4 properties
SignedDocumentResponse
object
Response for a signed document
6 properties
2 required
UnauthorizedProblemDetail
object
Unauthorized error details
6 properties
PendingDocumentResponse
object
Response for a pending document
4 properties
2 required
Signature
object
Response representing a Signature field
7 properties
4 required
SingleParticipantRequest
object
Create a single participant
3 properties
EnvelopeUpdate
object
3 properties
UpdateCompanyField
object
Parameters to update a Company field
5 properties
1 required
Date
object
Response representing a Date field
9 properties
5 required
Title
object
Response representing a Title field
7 properties
4 required
CreateCheckboxField
object
Parameters to create a Checkbox field
5 properties
3 required
Envelope
object
5 properties
CreateNameField
object
Parameters to create a Name field
5 properties
3 required
CreateCustomField
object
Parameters to create a Custom field
6 properties
3 required
ReorderDocumentsRequest
object
The request body should contain an array named 'order' with the document IDs in the desired sequence. This will update the order of documents within the envelo…
1 property
BulkParticipantRequest
object
Create multiple participants wrapped in an items array
1 property
FailedDocumentResponse
object
Response for a failed document
7 properties
2 required
CreateCompanyField
object
Parameters to create a Company field
5 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Nitro Software 2
Other APIs Nitro Software publishes across the network.
Nitro Software Authentication API
Nitro Software Platform API
#Sign