Skip to main content
GET
/
sign
/
envelopes
/
{envelopeID}
/
documents
/
{documentID}
Get Document by ID
curl --request GET \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/documents/{documentID} \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "status": "pending",
  "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
envelopeID
string<uuid>
required

A unique UUIDv4 string that identifies the envelope in the Nitro system.

​
documentID
string<uuid>
required

A unique string that identifies the document in the Nitro system.

Response

The GET Document by ID endpoint returns a JSON object with the document's data

  • Pending
  • Uploaded
  • Failed
  • Signed
  • Sealed

Response for a pending document

​
name
string
required

Name of the file provided by the user.

Minimum length: 1
​
ID
string<uuid>
required

Unique uuid identifier for the document.

Minimum length: 1
​
createdAt
string<date-time>

UTC timestamp indicating when the document was created.

​
status
enum<string>

Current status of the document.

Available options:
pending,
uploaded,
failed,
signed,
sealed
⌘I