KAkaleyra
Envelope

Get envelope

Get a specific sign envelope details by its Id.

get/v2/envelopes/{envelope_id}

Request

  • Base URL
    https://api.sandbox.eu.bandyer.com
  • URL
    https://api.sandbox.eu.bandyer.com/v2/envelopes/{envelope_id}
  • Auth
    API key in header apikey

Path parameters

envelope_idstring required

Enevlope id.

Response

idstring

Envelope id.

friendly_namestring

Friendly name.

room_idstring

Room id.

session_idstring

Session id.

statusstring

Status of the envelope.

senderstring

User id of the sender.

signerstring

User id of the signer.

creation_datestring date-time

Creation date of the envelope.

updated_atstring date-time

Update date of the envelope.

Example response

{
  "creation_date": "2023-01-01T00:00:00Z",
  "updated_at": "2023-01-01T00:00:00Z"
}

Changes

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