API quickstart

Upload a document, add a recipient and fields, then send it for signature.

1. Upload a document

curl -X POST https://docsign.noviqent.co.uk/api/v1/organisations/{org_id}/documents \
  -H "Authorization: Bearer <api_key>" \
  -F "file=@contract.pdf"

2. Create an envelope

curl -X POST https://docsign.noviqent.co.uk/api/v1/organisations/{org_id}/envelopes \
  -H "Authorization: Bearer <api_key>" -H "Content-Type: application/json" \
  -d '{"document_id": "<document_id>", "title": "Service Agreement"}'

3. Add a recipient and a field

curl -X POST .../envelopes/{envelope_id}/recipients \
  -d '{"order": 0, "name": "Jane Doe", "email": "jane@example.com", "role": "signer"}'

curl -X POST .../envelopes/{envelope_id}/fields \
  -d '{"recipient_id": "<recipient_id>", "field_type": "signature", "page_number": 0, "x": 100, "y": 100, "width": 160, "height": 50}'

4. Send it

The recipient gets an email with a signing link. Poll GET on the envelope, or check Reports in the dashboard, to see when they've completed it - the final signed PDF becomes available as final_document_id once every recipient is done.

curl -X POST .../envelopes/{envelope_id}/send \
  -d '{"deadline_days": 7}'