zapsign

$npx mdskill add vm0-ai/vm0-skills/zapsign

Execute e-signature workflows via ZapSign API

  • Processes PDF documents for digital signing requests
  • Integrates with ZapSign sandbox and production APIs
  • Validates user intent through signature-related keywords
  • Returns signed document URLs and status tokens

SKILL.md

.github/skills/zapsignView on GitHub ↗
---
name: zapsign
description: ZapSign API for e-signatures. Use when user mentions "ZapSign", "e-signature",
  "sign document", or Brazilian e-signature.
---

## Troubleshooting

If requests fail, run `zero doctor check-connector --env-name ZAPSIGN_TOKEN` or `zero doctor check-connector --url https://sandbox.api.zapsign.com.br/api/v1/docs/ --method GET`

## How to Use

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": "[email protected]",
      "auth_mode": "assinaturaTela",
      "send_automatic_email": true
    }
  ]
}
```

Then run:

```bash
curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer $ZAPSIGN_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": "[email protected]"
    }
  ]
}
```

Then run:

```bash
curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer $ZAPSIGN_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": "[email protected]"
    }
  ]
}
```

Then run:

```bash
curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer $ZAPSIGN_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": "[email protected]",
      "order_group": 1,
      "send_automatic_email": true
    },
    {
      "name": "Second Signer",
      "email": "[email protected]",
      "order_group": 2,
      "send_automatic_email": true
    }
  ]
}
```

Then run:

```bash
curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer $ZAPSIGN_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": "[email protected]"
    }
  ]
}
```

Then run:

```bash
curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer $ZAPSIGN_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 `<your-document-token>` with the actual document token:

```bash
curl -s -X GET "https://sandbox.api.zapsign.com.br/api/v1/docs/<your-document-token>/" -H "Authorization: Bearer $ZAPSIGN_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 `<your-document-token>` with the actual document token:

Write to `/tmp/zapsign_request.json`:

```json
{
  "name": "Additional Signer",
  "email": "[email protected]",
  "auth_mode": "assinaturaTela",
  "send_automatic_email": true
}
```

Then run:

```bash
curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/<your-document-token>/add-signer/" -H "Authorization: Bearer $ZAPSIGN_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
curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer $ZAPSIGN_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": "[email protected]",
      "selfie_validation_type": "liveness-document-match",
      "require_document_photo": true
    }
  ]
}
```

Then run:

```bash
curl -s -X POST "https://sandbox.api.zapsign.com.br/api/v1/docs/" -H "Authorization: Bearer $ZAPSIGN_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 `<your-document-token>` with the actual document token:

```bash
curl -s -X DELETE "https://sandbox.api.zapsign.com.br/api/v1/docs/<your-document-token>/" -H "Authorization: Bearer $ZAPSIGN_TOKEN"
```

## Authentication Modes

| Mode | Description | Cost |
|------|-------------|------|
| `assinaturaTela` | On-screen signature (default) | Free |
| `tokenEmail` | Email verification token | Free |
| `assinaturaTela-tokenEmail` | Signature + email token | Free |
| `tokenSms` | SMS verification token | Free |
| `assinaturaTela-tokenSms` | Signature + SMS token | Free |
| `tokenWhatsapp` | WhatsApp verification token | $0.10 |
| `assinaturaTela-tokenWhatsapp` | Signature + WhatsApp token | $0.10 |

## Biometric Validation Types

| Type | Description | Cost |
|------|-------------|------|
| `liveness-document-match` | Face + document match | $0.50 |
| `identity-verification` | Full identity verification (CO, MX, CL, PE) | $1.00 |
| `identity-verification-global` | Global identity verification | $0.90 |

## Document Status

| Status | Description |
|--------|-------------|
| `pending` | Document is awaiting signatures |
| `signed` | All signers have signed |

## Signer Status

| Status | Description |
|--------|-------------|
| `new` | Signer created, hasn't viewed |
| `link-opened` | Signer opened the link |
| `signed` | Signer completed signing |

## Response Fields

| Field | Description |
|-------|-------------|
| `token` | Document unique identifier |
| `status` | Document status (pending/signed) |
| `original_file` | URL to original PDF (expires in 60 min) |
| `signed_file` | URL to signed PDF (expires in 60 min) |
| `signers[].token` | Signer unique identifier |
| `signers[].sign_url` | Direct signing link for signer |
| `signers[].signed_at` | Timestamp when signer signed |

## Guidelines

1. **Use Sandbox for testing**: Always test in sandbox first - it's free and has no legal validity
2. **Store tokens**: Save `token` and `signers[].token` for future API calls
3. **File URLs expire**: `original_file` and `signed_file` URLs expire in 60 minutes
4. **Use webhooks**: Instead of polling, set up webhooks for real-time notifications
5. **WhatsApp costs credits**: Each WhatsApp notification costs $0.10
6. **Biometrics cost credits**: Facial recognition and identity verification require credits
7. **Production requires plan**: Production environment requires an active API plan

More from vm0-ai/vm0-skills

SkillDescription
account-reconciliationPerform account reconciliations comparing general ledger balances against subledgers, bank statements, or external records. Use for bank reconciliation, GL-to-subledger reconciliation, intercompany reconciliation, balance sheet reconciliation, reconciling item analysis, outstanding item aging, or clearing open items.
agentphoneBuild AI phone agents with AgentPhone API. Use when the user wants to make phone calls, send/receive SMS, manage phone numbers, create voice agents, set up webhooks, or check usage — anything related to telephony, phone numbers, or voice AI.
ahrefsAhrefs SEO API for backlink and keyword analysis. Use when user mentions
amplitudeAmplitude product analytics API. Use when user mentions "Amplitude",
analysis-qaQuality-check a data analysis before sharing — verify joins, aggregations, denominators, time ranges, and metric definitions. Detect pitfalls like survivorship bias, average-of-averages, join explosion, timezone mismatches, incomplete periods, and selection bias. Includes documentation templates for reproducible analyses.
anthropic-managed-agentsAnthropic Managed Agents API for programmatically creating, running, and streaming AI agents on Anthropic's cloud infrastructure. Use when the user mentions "Managed Agents", "Anthropic agent sessions", or needs to create/run/stream an Anthropic agent with tool use (bash, git, web), attach GitHub repositories, or inject secrets via Vault. Do NOT use for standard Claude Messages API — use the Claude API skill instead.
apifyApify web scraping platform. Use when user mentions "scrape website",
asanaAsana API for tasks and projects. Use when user mentions "Asana", "asana.com",
attioAttio REST API for AI-native CRM operations — manage companies, people, deals, and custom objects, plus notes, tasks, lists, and comments. Use when the user mentions "Attio", "CRM record", "create company", "add person", "list entry", "CRM note", or "CRM task".
audit-readinessPrepare for internal and external audits with SOX 404 control testing, sample selection, workpaper documentation, and deficiency evaluation. Use for SOX compliance, control testing methodology, audit sample selection, audit workpaper preparation, control deficiency classification, material weakness evaluation, ITGC testing, remediation tracking, or audit evidence standards.