Quickstart

This walkthrough takes you from a PDF on disk to a document out for signature. You need an API key and enough credits for your signers.

Prefer to click around instead of copying curl commands? Use the Download Postman collection button at the top of these docs to import every endpoint into Postman, set your apiKey, and run the flow end to end.

1. Create a document

Upload your PDF as multipart/form-data. The file field is required and must be a PDF up to 10MB. The name field is optional.

curl -X POST https://signyu.com/api/v1/documents \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -F "file=@/path/to/agreement.pdf" \
  -F "name=Service Agreement"

{
  "documentId": "b6b1f0e2-1c9a-4a1e-9b1a-2f3d4e5a6b7c",
  "name": "Service Agreement",
  "status": "PENDING"
}

2. Add signers

Add one or more signers. Each needs a name, a phone (digits only, at least 10), and an email. A document can have up to 6 signers, and they sign in the order you add them.

curl -X POST https://signyu.com/api/v1/documents/b6b1f0e2-1c9a-4a1e-9b1a-2f3d4e5a6b7c/signers \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "signers": [
      { "name": "Asha Rao", "phone": "9876543210", "email": "asha@example.com" },
      { "name": "Vikram Nair", "phone": "9812345678", "email": "vikram@example.com" }
    ]
  }'

{
  "signers": [
    { "signerId": "s_1", "name": "Asha Rao", "email": "asha@example.com", "signingOrder": 1 },
    { "signerId": "s_2", "name": "Vikram Nair", "email": "vikram@example.com", "signingOrder": 2 }
  ]
}

3. Send for signature

Sending deducts one credit per signer, marks the document as sent, and emails a signing link to every signer. The response includes the signing link for each signer so you can share it yourself if you prefer.

curl -X POST https://signyu.com/api/v1/documents/b6b1f0e2-1c9a-4a1e-9b1a-2f3d4e5a6b7c/send \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "documentId": "b6b1f0e2-1c9a-4a1e-9b1a-2f3d4e5a6b7c",
  "status": "SENT",
  "creditsRemaining": 48,
  "signers": [
    {
      "signerId": "s_1",
      "name": "Asha Rao",
      "email": "asha@example.com",
      "signingOrder": 1,
      "signUrl": "https://signyu.com/sign?did=b6b1f0e2-1c9a-4a1e-9b1a-2f3d4e5a6b7c&sid=s_1"
    }
  ]
}

4. Track progress

Poll the document to see each signer's status, or configure webhooks to be notified automatically. Once every signer has signed, status becomes COMPLETED and a downloadUrl for the signed PDF is returned.

curl https://signyu.com/api/v1/documents/b6b1f0e2-1c9a-4a1e-9b1a-2f3d4e5a6b7c \
  -H "Authorization: Bearer sk_live_your_api_key"

Next steps

• See the full Documents reference for every field.
• Set up webhooks so you do not have to poll.