REST

The Paksign REST API has three endpoints;

  1. Upload document
  2. Send document
  3. Download document

Upload document
post
https://app.paksign.pk/api/documents/upload

Request
FieldDescriptionTypeRequired
fileYour documentFileYes
workspaceIdYour workspace idstringYes

Response
FieldDescriptionType
filesArray of Asset, one for every page of your documentAsset[]
slugUnique slug for your documentstring
sourceSource asset keystring

Learn more about this endpoint on the upload document flow.

Send document
post
https://app.paksign.pk/api/documents/send
FieldDescriptionTypeRequired
workspaceIdYour workspace idnumberYes
titleDocument titlestringYes
slugDocument slug from uploadstringYes
sourceDocument source key from uploadstringYes
filesDocument assets from uploadAsset[]Yes
signersDocument signersSigner[]Yes
elementsSigner elementsElement[]Yes
metaDocument metadataobjectNo

Response
FieldDescriptionType
documentDocument objectDocument

Learn more about this endpoint on the send document flow.

Download document

This endpoint is used by signers (not Paksign users) to download documents after they've signed them. Workspace members can download documents from your dashboard.

get
https://app.paksign.pk/api/documents/download

Request
FieldDescriptionTypeRequired
codeToken codestringYes