Create a short-lived hosted signing URL

POST

/envelopes/{id}/signing-sessions

const url = 'https://app.qsig.in/backend/api/v1/envelopes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/signing-sessions';
const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<X-Api-Key>', 'Content-Type': 'application/json'},
  body: '{"recipient_id":"00000000-0000-0000-0000-000000000001","mode":"redirect"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://app.qsig.in/backend/api/v1/envelopes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/signing-sessions \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <X-Api-Key>' \
  --data '{ "recipient_id": "00000000-0000-0000-0000-000000000001", "mode": "redirect" }'

Use mode redirect for a full-page hosted signer handoff. The signing_url expires after 15 minutes; keep the API key on your server.

Authorizations

ApiKeyAuth

Parameters

Path Parameters

required

string format: uuid

Request Body^required

application/json

object

recipient_id

required

string format: uuid

mode

string

default: embedded

Allowed values: redirect embedded

origin

Required for embedded mode and must be allowed on the account.

string format: uri

return_url

string format: uri

Example

{
  "recipient_id": "00000000-0000-0000-0000-000000000001",
  "mode": "redirect"
}

Responses

201

Signing session