sign

Get envelope

Look up one envelope with each signer's status (pending, viewed, signed, declined), whose turn it is, and the event history; free and read-only; it shows whether everyone has signed. It never returns signing links.

get/v1/envelopes/{envelope_id}

Request

  • Base URL: https://api.noerrands.com/c/sign
  • URL: https://api.noerrands.com/c/sign/v1/envelopes/{envelope_id}
  • Auth: HTTP bearer

Path parameters

envelope_idstring required

The envelope id, "sg_..." from create_envelope.

Response

Success.

envelope_idstring required
titlestring required
mode'request' | 'self' required
status'draft' | 'sending' | 'sent' | 'completing' | 'completed' | 'declined' | 'voided' | 'expired' required
created_atstring required
sent_atstring
completed_atstring
expires_atstring
delete_afterstring

When we delete the documents and personal data.

credits_charged_centsinteger required
pagesinteger required
placement'fields' | 'signature_page' required
refunded_centsinteger required
document_sha256string required
final_sha256string

SHA-256 of the finished PDF, certificate included.

erasedboolean required

True once the documents and personal data were deleted.

next_signersstring[] required

signer_ids whose turn it is now.

Changes

No recorded changes to this operation across all 1 revision of this API.