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.2.0, at version 0.1.
Requests are made against a single base URL, https://api.gonitro.dev.
The identity and technical contract details declared by the specification.
Envelope
object
5 properties
ParticipantList
object
Fields
2 properties
BadRequestProblemDetail
object
Bad Request error details
6 properties
SendReminders
object
1 property
Date
object
Response representing a Date field
9 properties
5 required
CreateNameField
object
Parameters to create a Name field
5 properties
3 required
UpdateInitialsField
object
Parameters to update a Initials field
5 properties
1 required
UpdateCompanyField
object
Parameters to update a Company field
5 properties
1 required
DeleteFieldsRequest
object
A set of unique UUIDv4 strings that identify the fields in the Nitro system.
1 property
Title
object
Response representing a Title field
7 properties
4 required
Custom
object
Response representing a Custom field
8 properties
5 required
ContentTooLargeProblemDetail
object
Content too large error details
6 properties
UpdateNameField
object
Parameters to update a Name field
5 properties
1 required
CreateCustomField
object
Parameters to create a Custom field
6 properties
3 required
InternalServerErrorProblemDetail
object
Internal Server Error details
6 properties
EnvelopeList
object
Fields
2 properties
CreateInitialsField
object
Parameters to create a Initials field
5 properties
3 required
EnvelopeUpdate
object
3 properties
ConvertFileResponse
object
3 properties
1 required
CreateDateField
object
Parameters to create a Date field
7 properties
3 required
SealedDocumentResponse
object
Response for a sealed document
6 properties
2 required
Company
object
Response representing a Company field
7 properties
4 required
SMS
object
SMS
3 properties
PendingDocumentResponse
object
Response for a pending document
4 properties
2 required
RenameDocumentRequest
object
1 property
1 required
CreateSignatureFieldResponse
object
Create Signature Field Response
7 properties
4 required
UpdateCustomField
object
Parameters to update a Custom field
6 properties
1 required
UnprocessableEntityProblemDetail
object
Unprocessable Entity error details
6 properties
CreateTitleFieldResponse
object
Create Title Field Response
7 properties
4 required
EnvelopeInInvalidStateProblemDetail
object
Envelope in invalid state
6 properties
JobStatusResponse
object
2 properties
DeleteParticipantsRequest
object
A set of unique UUIDv4 strings that identify the participants in the Nitro system.
1 property
Initials
object
Response representing an Initials field
7 properties
4 required
ParticipantCreate
object
Request to create a new participant
3 properties
1 required
CreateTitleField
object
Parameters to create a Title field
5 properties
3 required
UpdateDateField
object
Parameters to update a Date field
7 properties
1 required
CreateCompanyField
object
Parameters to create a Company field
5 properties
3 required
SignedDocumentResponse
object
Response for a signed document
6 properties
2 required
ParticipantUpdate
object
1 property
BulkParticipantResponse
object
Response containing multiple created participants wrapped in an items array
1 property
1 required
Signature
object
Response representing a Signature field
7 properties
4 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
AccessCode
object
Access code
2 properties
UpdateSignatureField
object
Parameters to update a Signature field
5 properties
1 required
EnvelopeCreate
object
3 properties
3 required
UnsupportedMediaTypeDetail
object
Unsupported Media Type error details
6 properties
ExtendedEnvelope
object
7 properties
SignerSigningUrl
object
3 properties
CreateInitialsFieldResponse
object
Create Initials Field Response
7 properties
4 required
CreateCheckboxField
object
Parameters to create a Checkbox field
5 properties
3 required
Name
object
Response representing a Name field
7 properties
4 required
CreateCheckboxFieldResponse
object
Create Checkbox Field Response
7 properties
4 required
CreateSignatureField
object
Parameters to create a Signature field
5 properties
3 required
Participant
object
4 properties
CreateNameFieldResponse
object
Create Name Field Response
7 properties
4 required
UploadedDocumentResponse
object
Response for an uploaded document
6 properties
2 required
CreateDateFieldResponse
object
Create Date Field Response
9 properties
4 required
CreateCompanyFieldResponse
object
Create Company Field Response
7 properties
4 required
EnvelopeWebDocumentRequestMetadata
object
2 properties
1 required
BulkFieldRequest
object
Create multiple fields wrapped in an items array
1 property
1 required
Notification
object
2 properties
2 required
UpdateTitleField
object
Parameters to update a Title field
5 properties
1 required
Checkbox
object
Response representing a Checkbox field
7 properties
4 required
UpdateCheckboxField
object
Parameters to update a Checkbox field
5 properties
1 required
DocumentNotFoundProblemDetail
object
Document Not Found error details
6 properties
BulkParticipantRequest
object
Create multiple participants wrapped in an items array
1 property
NotFoundProblemDetail
object
Not Found error details
6 properties
CreateCustomFieldResponse
object
Create Custom Field Response
8 properties
5 required
SingleParticipantRequest
object
Create a single participant
3 properties
FailedDocumentResponse
object
Response for a failed document
7 properties
2 required
SignerSigningUrlList
object
Fields
2 properties
UnauthorizedProblemDetail
object
Unauthorized error details
6 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Nitro Software publishes across the network.
