Get envelope

Retrieves detailed information about a specific envelope using its unique identifier. The response includes the envelope's status, associated documents, signers, and other relevant metadata. Ensure the provided envelope ID exists and is valid before making the request.

Responses

🟢200OK

application/json

Envelope retrieved successfully

Body

string <uuid>

optional

Id of the envelope

createdAtUtc

string <date-time>

optional

Date and time when the envelope was created in UTC

createdById

string <uuid>

optional

Id of the user who created the envelope

createdByName

string | null

optional

Name of the user who created the envelope

createdByAvatar

string | null

optional

Url of the avatar of the user who created the envelope

updatedAtUtc

string <date-time>

optional

Date and time when the envelope was last updated in UTC

lastUpdateById

string <uuid>

optional

Id of the user who last updated the envelope

updatedByName

string | null

optional

Name of the user who last updated the envelope

updatedByAvatar

string | null

optional

Url of the avatar of the user who last updated the envelope

ownerId

string <uuid>

optional

Id of the owner of the envelope

ownerName

string | null

optional

Name of the owner of the envelope

ownerAvatar

string | null

optional

Url of the avatar of the owner of the envelope

language

enum<string>

optional

Language of the envelope

Allowed values:

EnUsPtBr

markupOrientation

enum<string>

optional

Orientation of the markup

Allowed values:

NoneBottomTopLeftRight

status

enum<string>

optional

Status of the envelope

Allowed values:

DraftPublishScheduledPublishedHoldCancelledCancelledBySignerMfaErrorRejectedSignedExpired

hasScheduledPublish

boolean

optional

Indicates if the envelope has scheduled publish

toBePublishedAtUtc

string <date-time> | null

optional

Date and time when the envelope will be published in UTC

vaultId

string <uuid>

optional

Id of the vault

vaultName

string | null

optional

Name of the vault

name

string | null

optional

Name of the envelope

privateDescription

string | null

optional

Private description of the envelope

publicDescription

string | null

optional

Public description of the envelope

message

string | null

optional

Message of the envelope, which will be send to the signers via email

reviewReminder

boolean

optional

Indicates if review reminders should be sent to the signers

expiresAtUtc

string <date-time> | null

optional

Date and time when the envelope will expire in UTC

expirationReminder

boolean

optional

Indicates if expiration reminders should be sent to the signers

isRemoved

boolean

optional

Indicates if the envelope is removed

removedById

string <uuid> | null

optional

Id of the user who removed the envelope

removedBy

string | null

optional

Name of the user who removed the envelope

removedAtUtc

string <date-time> | null

optional

Date and time when the envelope was removed in UTC

signInOrder

boolean

optional

Indicates if the signers should sign in order

certifiedAtUtc

string <date-time> | null

optional

Date and time when the envelope certification was last updated in UTC

isSandbox

boolean

optional

Indicates if the envelope was created in sandbox mode

hasActionsBeingProcessed

boolean

optional

Indicates if the envelope has some action being processed

documents

array[object (GetEnvelopeApiResponseDocument) {7}] | null

optional

List of documents of the envelope

string <uuid>

optional

Id of the document

index

integer <int32>

optional

Index of the document, starting from 0

origin

enum<string>

optional

Origin of the document

Allowed values:

UploadTemplate

name

string | null

optional

Name of the document

privateDescription

string | null

optional

Private description of the document

publicDescription

string | null

optional

Public description of the document

pageSizes

array[object (GetEnvelopeApiResponseDocumentPageSize) {3}] | null

optional

List of page sizes of the document

signers

array[object (GetEnvelopeApiResponseSigner) {27}] | null

optional

List of signers of the envelope

string <uuid>

optional

Id of the signer

index

integer <int32> | null

optional

Index of the signer, if the envelope is signed in order, starting from 0

status

enum<string>

optional

Status of the signer

Allowed values:

NoneReadyToReviewQueuedApprovedRejectedCancelledByMfaError

hadApproved

boolean

optional

Indicates if the signer had approved the envelope

approvedAtUtc

string <date-time> | null

optional

Date and time when the signer approved the envelope in UTC

hadRejected

boolean

optional

Indicates if the signer had rejected the envelope

rejectedAtUtc

string <date-time> | null

optional

Date and time when the signer rejected the envelope in UTC

name

string | null

optional

Name of the signer

string | null

optional

Email of the signer

role

enum<string>

optional

Role of the signer

Allowed values:

SignApproveRecognizeTestifyConfirmReceivingEndorseInBlackEndorseInWhiteConfirm

title

string | null

optional

Title of the signer

passcode

string | null

optional

Passcode of the signer

passcodeHint

string | null

optional

Passcode hint of the signer

phoneIdd

integer <int32> | null

optional

Phone IDD of the signer

phoneNumber

string | null

optional

Phone number of the signer

documentType

enum<string>

optional

Document type of the signer

Allowed values:

GenericIdentificationBrazilianCpf

documentValue

string | null

optional

Document value of the signer

shouldEnforceSmsValidation

boolean

optional

Indicates if the SMS OTP validation should be enforced for the signer

shouldEnforceWhatsAppValidation

boolean

optional

Indicates if the WhatsApp OTP validation should be enforced for the signer

shouldEnforcePixValidation

boolean

optional

Indicates if the PIX OTP validation should be enforced for the signer

shouldEnforceGeolocationValidation

boolean

optional

Indicates if the geolocation validation should be enforced for the signer

shouldAllowCustomDigitalCertificateValidation

boolean

optional

Indicates if the custom digital certificate validation should be allowed for the signer

shouldEnforceCustomDigitalCertificateValidation

boolean

optional

Indicates if the custom digital certificate validation should be enforced for the signer

shouldEnforcePasscodeValidation

boolean

optional

Indicates if the passcode validation should be enforced for the signer

shouldEnforceEmailValidation

boolean

optional

Indicates if the email OTP validation should be enforced for the signer

signMarks

array[object (GetEnvelopeApiResponseSignMark) {7}] | null

optional

List of sign marks of the signer

actions

array[object (GetEnvelopeApiResponseSignerAction) {6}] | null

optional

List of actions of the signer

Example

{
  "id": "cfb27af9-2a01-4b7c-8d19-452a4e4d0174",
  "createdAtUtc": "2025-03-29T12:47:40.2520844Z",
  "createdById": "df750b44-423a-4a9a-9704-b25ea7140615",
  "createdByName": "John Doe",
  "createdByAvatar": "https://example.com/avatar.jpg",
  "updatedAtUtc": "2025-03-29T12:47:40.2520857Z",
  "lastUpdateById": "dc7aab02-7710-436e-ac42-b976008dc3b3",
  "updatedByName": "John Doe",
  "updatedByAvatar": "https://example.com/avatar.jpg",
  "ownerId": "993f91d5-5261-416b-a9ea-a529617b063a",
  "ownerName": "John Doe",
  "ownerAvatar": "https://example.com/avatar.jpg",
  "language": "EnUs",
  "markupOrientation": "Bottom",
  "status": "Published",
  "hasScheduledPublish": false,
  "toBePublishedAtUtc": null,
  "vaultId": "645ca872-b9ef-4636-8e3d-d4853502ab8f",
  "vaultName": "Example Vault",
  "name": "Example Envelope",
  "privateDescription": "Private description",
  "publicDescription": "Public description",
  "message": "Message",
  "reviewReminder": false,
  "expiresAtUtc": null,
  "expirationReminder": false,
  "isRemoved": false,
  "removedById": null,
  "removedBy": null,
  "removedAtUtc": null,
  "signInOrder": false,
  "certifiedAtUtc": null,
  "isSandbox": false,
  "hasActionsBeingProcessed": false,
  "documents": [
    {
      "id": "3e7c8678-5138-4ef5-a740-cac1fb5578fc",
      "index": 0,
      "origin": "Upload",
      "name": "Example Document",
      "privateDescription": "Private description",
      "publicDescription": "Public description",
      "pageSizes": [
        {
          "page": 1,
          "width": 100,
          "height": 100
        }
      ]
    }
  ],
  "signers": [
    {
      "id": "eb21ab20-c4d5-4b9c-9539-d5662d95032d",
      "index": null,
      "status": "ReadyToReview",
      "hadApproved": false,
      "approvedAtUtc": null,
      "hadRejected": false,
      "rejectedAtUtc": null,
      "name": "John Doe",
      "email": "john.doe@example.com",
      "role": "Sign",
      "title": "Title",
      "passcode": "123456",
      "passcodeHint": "1 to 6",
      "phoneIdd": 1,
      "phoneNumber": "123456789",
      "documentType": "GenericIdentification",
      "documentValue": "123456789",
      "shouldEnforceSmsValidation": true,
      "shouldEnforceWhatsAppValidation": true,
      "shouldEnforcePixValidation": true,
      "shouldEnforceGeolocationValidation": true,
      "shouldAllowCustomDigitalCertificateValidation": true,
      "shouldEnforceCustomDigitalCertificateValidation": true,
      "shouldEnforcePasscodeValidation": true,
      "shouldEnforceEmailValidation": true,
      "signMarks": [
        {
          "id": "2fb93697-a345-439d-a0d3-7465d10be7a5",
          "documentId": "3e7c8678-5138-4ef5-a740-cac1fb5578fc",
          "type": "Signature",
          "page": 1,
          "x": 10,
          "y": 10,
          "rotation": 0
        }
      ],
      "actions": [
        {
          "id": "8a065b19-19af-4927-9f91-8d0d72261097",
          "createdAtUtc": "2025-03-29T12:44:40.252096Z",
          "type": "View",
          "ip": "127.0.0.1",
          "userAgent": "Mozilla/5.0",
          "location": "New York, USA"
        },
        {
          "id": "d26505c3-6ab1-4134-9eda-b30267a03558",
          "createdAtUtc": "2025-03-29T12:44:40.2520975Z",
          "type": "EmailMfaRequest",
          "ip": "127.0.0.1",
          "userAgent": "Mozilla/5.0",
          "location": "New York, USA"
        }
      ]
    }
  ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Request

Request samples

Responses