All examples use the sandbox environment. For production, replace sandbox.api.zapsign.com.br with api.zapsign.com.br.
---
1. Create Document from PDF URL
Create a document for signature from a public PDF URL:
Write to /tmp/zapsign_request.json:
```json
{
"name": "Employment Contract",
"url_pdf": "https://example.com/contract.pdf",
"lang": "en",
"signers": [
{
"name": "John Doe",
"email": "john@example.com",
"auth_mode": "assinaturaTela",
"send_automatic_email": true
}
]
}
```
Then run:
```bash
bash -c 'curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer ${ZAPSIGN_API_TOKEN}" -H "Content-Type: application/json" -d @/tmp/zapsign_request.json' | jq '{token, status, sign_url: .signers[0].sign_url}'
```
---
2. Create Document from Base64
Create a document from base64-encoded PDF:
```bash
# First, encode your PDF to base64
BASE64_PDF=$(base64 -i document.pdf)
```
Write to /tmp/zapsign_request.json:
```json
{
"name": "Contract",
"base64_pdf": "${BASE64_PDF}",
"signers": [
{
"name": "Jane Smith",
"email": "jane@example.com"
}
]
}
```
Then run:
```bash
bash -c 'curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer ${ZAPSIGN_API_TOKEN}" -H "Content-Type: application/json" -d @/tmp/zapsign_request.json' | jq '{token, status, signers}'
```
---
3. Create Document from Markdown
Create a document directly from Markdown text (great for AI integrations):
Write to /tmp/zapsign_request.json:
```json
{
"name": "Service Agreement",
"markdown_text": "# Service Agreement\n\nThis agreement is between Company A and Client B.\n\n## Terms\n\n1. Service will be provided for 12 months\n2. Payment is due monthly\n\n---\n\nSignature: ________________",
"signers": [
{
"name": "Client Name",
"email": "client@example.com"
}
]
}
```
Then run:
```bash
bash -c 'curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer ${ZAPSIGN_API_TOKEN}" -H "Content-Type: application/json" -d @/tmp/zapsign_request.json' | jq '{token, status, original_file}'
```
---
4. Create Document with Multiple Signers
Create a document with signing order:
Write to /tmp/zapsign_request.json:
```json
{
"name": "Multi-party Contract",
"url_pdf": "https://example.com/contract.pdf",
"signature_order_active": true,
"signers": [
{
"name": "First Signer",
"email": "first@example.com",
"order_group": 1,
"send_automatic_email": true
},
{
"name": "Second Signer",
"email": "second@example.com",
"order_group": 2,
"send_automatic_email": true
}
]
}
```
Then run:
```bash
bash -c 'curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer ${ZAPSIGN_API_TOKEN}" -H "Content-Type: application/json" -d @/tmp/zapsign_request.json' | jq '{token, status, signature_order_active}'
```
---
5. Create Document with Expiration
Create a document with a deadline for signing:
Write to /tmp/zapsign_request.json:
```json
{
"name": "Limited Time Offer",
"url_pdf": "https://example.com/offer.pdf",
"date_limit_to_sign": "2025-12-31T23:59:59Z",
"signers": [
{
"name": "Customer",
"email": "customer@example.com"
}
]
}
```
Then run:
```bash
bash -c 'curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer ${ZAPSIGN_API_TOKEN}" -H "Content-Type: application/json" -d @/tmp/zapsign_request.json' | jq '{token, status, date_limit_to_sign}'
```
---
6. Get Document Details
Retrieve document status and signer information. Replace
```bash
bash -c 'curl -s -X GET "https://sandbox.api.zapsign.com.br/api/v1/docs//" -H "Authorization: Bearer ${ZAPSIGN_API_TOKEN}"' | jq '{name, status, original_file, signed_file, signers: [.signers[] | {name, status, signed_at}]}''
```
---
7. Add Signer to Existing Document
Add a new signer to an existing document. Replace
Write to /tmp/zapsign_request.json:
```json
{
"name": "Additional Signer",
"email": "additional@example.com",
"auth_mode": "assinaturaTela",
"send_automatic_email": true
}
```
Then run:
```bash
bash -c 'curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs//add-signer/" -H "Authorization: Bearer ${ZAPSIGN_API_TOKEN}" -H "Content-Type: application/json" -d @/tmp/zapsign_request.json' | jq '{token, sign_url, status}'
```
---
8. Create Document with WhatsApp Notification
Send signing link via WhatsApp (costs credits):
Write to /tmp/zapsign_request.json:
```json
{
"name": "Contract via WhatsApp",
"url_pdf": "https://example.com/contract.pdf",
"signers": [
{
"name": "Mobile User",
"phone_country": "1",
"phone_number": "5551234567",
"send_automatic_whatsapp": true,
"auth_mode": "tokenWhatsapp"
}
]
}
```
Then run:
```bash
bash -c 'curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer ${ZAPSIGN_API_TOKEN}" -H "Content-Type: application/json" -d @/tmp/zapsign_request.json' | jq '{token, status, signers}'
```
---
9. Create Document with Biometric Verification
Require facial recognition during signing:
Write to /tmp/zapsign_request.json:
```json
{
"name": "High Security Contract",
"url_pdf": "https://example.com/contract.pdf",
"signers": [
{
"name": "Verified Signer",
"email": "verified@example.com",
"selfie_validation_type": "liveness-document-match",
"require_document_photo": true
}
]
}
```
Then run:
```bash
bash -c 'curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer ${ZAPSIGN_API_TOKEN}" -H "Content-Type: application/json" -d @/tmp/zapsign_request.json' | jq '{token, status, signers: [.signers[] | {name, selfie_validation_type}]}''
```
---
10. Delete a Document
Delete a document. Replace
```bash
bash -c 'curl -s -X DELETE "https://sandbox.api.zapsign.com.br/api/v1/docs//" -H "Authorization: Bearer ${ZAPSIGN_API_TOKEN}"'
```
---
|