POST /v1/envelopes HTTP/1.1
Host: api.signatureapi.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
{
"title": "Service Agreement",
"message": "Please review the agreement and provide your signature.",
"routing": "parallel",
"documents": [
{
"key": "service_agreement",
"title": "Service Agreement",
"url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/docs-samples/acme-service-agreement.pdf",
"format": "pdf",
"places": [
{
"key": "client_signs_here",
"type": "signature",
"recipient_key": "client"
},
{
"key": "provider_signs_here",
"type": "signature",
"recipient_key": "provider"
}
]
}
],
"recipients": [
{
"type": "signer",
"key": "client",
"name": "Jane Doe",
"email": "jane.doe@example.com"
},
{
"type": "signer",
"key": "provider",
"name": "John Smith",
"email": "john.smith@example.com"
}
]
}
npx signatureapi envelopes create --body - <<'EOF'
{
"title": "Service Agreement",
"message": "Please review the agreement and provide your signature.",
"routing": "parallel",
"documents": [
{
"key": "service_agreement",
"title": "Service Agreement",
"url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/docs-samples/acme-service-agreement.pdf",
"format": "pdf",
"places": [
{
"key": "client_signs_here",
"type": "signature",
"recipient_key": "client"
},
{
"key": "provider_signs_here",
"type": "signature",
"recipient_key": "provider"
}
]
}
],
"recipients": [
{
"type": "signer",
"key": "client",
"name": "Jane Doe",
"email": "jane.doe@example.com"
},
{
"type": "signer",
"key": "provider",
"name": "John Smith",
"email": "john.smith@example.com"
}
]
}
EOF
{
"name": "create_envelope",
"arguments": {
"title": "Service Agreement",
"message": "Please review the agreement and provide your signature.",
"routing": "parallel",
"documents": [
{
"key": "service_agreement",
"title": "Service Agreement",
"url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/docs-samples/acme-service-agreement.pdf",
"format": "pdf",
"places": [
{
"key": "client_signs_here",
"type": "signature",
"recipient_key": "client"
},
{
"key": "provider_signs_here",
"type": "signature",
"recipient_key": "provider"
}
]
}
],
"recipients": [
{
"type": "signer",
"key": "client",
"name": "Jane Doe",
"email": "jane.doe@example.com"
},
{
"type": "signer",
"key": "provider",
"name": "John Smith",
"email": "john.smith@example.com"
}
]
}
}
POST /v1/envelopes HTTP/1.1
Host: api.signatureapi.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
{
"title": "Offer Letter",
"label": "Offer Letter for Maria Garcia",
"routing": "sequential",
"message": "Welcome to Acme Corp! Please review and sign your offer letter.",
"topics": [
"hr",
"onboarding"
],
"metadata": {
"candidate_ref": "hr-2210"
},
"branding": {
"logo": "https://api.signatureapi.com/v1/uploads/upl_42NTdNnkg6dGLx8jR1X1wm",
"accent_color": "#9810fa",
"email": {
"footer": "**Confidential:** this email is intended only for the named recipient.",
"logo_position": "left"
}
},
"timezone": "America/New_York",
"documents": [
{
"key": "offer_letter",
"title": "Offer Letter",
"url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/docs-samples/acme-offer-letter-template.docx",
"format": "docx",
"data": {
"candidateName": "Maria Garcia",
"position": "Product Designer",
"startDate": "December 1, 2026",
"salary": "$92,000"
},
"places": [
{
"key": "candidate_signs_here",
"type": "signature",
"recipient_key": "candidate",
"height": 60
}
]
}
],
"recipients": [
{
"type": "approver",
"key": "hiring_manager",
"name": "Alex Chen",
"email": "alex.chen@example.com"
},
{
"type": "signer",
"key": "candidate",
"name": "Maria Garcia",
"email": "maria.garcia@example.com",
"signature_options": [
"typed",
"drawn"
],
"delivery_type": "email",
"ceremony": {
"authentication": [
{
"type": "email_code"
}
],
"redirect_url": "https://acme.example/welcome",
"embeddable_in": [],
"url_variant": "standard"
}
}
],
"deliverable": {
"type": "standard",
"language": "en",
"timezone": "America/New_York",
"timestamp_format": "MM/DD/YYYY HH:mm:ss"
}
}
npx signatureapi envelopes create --body - <<'EOF'
{
"title": "Offer Letter",
"label": "Offer Letter for Maria Garcia",
"routing": "sequential",
"message": "Welcome to Acme Corp! Please review and sign your offer letter.",
"topics": [
"hr",
"onboarding"
],
"metadata": {
"candidate_ref": "hr-2210"
},
"branding": {
"logo": "https://api.signatureapi.com/v1/uploads/upl_42NTdNnkg6dGLx8jR1X1wm",
"accent_color": "#9810fa",
"email": {
"footer": "**Confidential:** this email is intended only for the named recipient.",
"logo_position": "left"
}
},
"timezone": "America/New_York",
"documents": [
{
"key": "offer_letter",
"title": "Offer Letter",
"url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/docs-samples/acme-offer-letter-template.docx",
"format": "docx",
"data": {
"candidateName": "Maria Garcia",
"position": "Product Designer",
"startDate": "December 1, 2026",
"salary": "$92,000"
},
"places": [
{
"key": "candidate_signs_here",
"type": "signature",
"recipient_key": "candidate",
"height": 60
}
]
}
],
"recipients": [
{
"type": "approver",
"key": "hiring_manager",
"name": "Alex Chen",
"email": "alex.chen@example.com"
},
{
"type": "signer",
"key": "candidate",
"name": "Maria Garcia",
"email": "maria.garcia@example.com",
"signature_options": [
"typed",
"drawn"
],
"delivery_type": "email",
"ceremony": {
"authentication": [
{
"type": "email_code"
}
],
"redirect_url": "https://acme.example/welcome",
"embeddable_in": [],
"url_variant": "standard"
}
}
],
"deliverable": {
"type": "standard",
"language": "en",
"timezone": "America/New_York",
"timestamp_format": "MM/DD/YYYY HH:mm:ss"
}
}
EOF
{
"name": "create_envelope",
"arguments": {
"title": "Offer Letter",
"label": "Offer Letter for Maria Garcia",
"routing": "sequential",
"message": "Welcome to Acme Corp! Please review and sign your offer letter.",
"topics": [
"hr",
"onboarding"
],
"metadata": {
"candidate_ref": "hr-2210"
},
"branding": {
"logo": "https://api.signatureapi.com/v1/uploads/upl_42NTdNnkg6dGLx8jR1X1wm",
"accent_color": "#9810fa",
"email": {
"footer": "**Confidential:** this email is intended only for the named recipient.",
"logo_position": "left"
}
},
"timezone": "America/New_York",
"documents": [
{
"key": "offer_letter",
"title": "Offer Letter",
"url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/docs-samples/acme-offer-letter-template.docx",
"format": "docx",
"data": {
"candidateName": "Maria Garcia",
"position": "Product Designer",
"startDate": "December 1, 2026",
"salary": "$92,000"
},
"places": [
{
"key": "candidate_signs_here",
"type": "signature",
"recipient_key": "candidate",
"height": 60
}
]
}
],
"recipients": [
{
"type": "approver",
"key": "hiring_manager",
"name": "Alex Chen",
"email": "alex.chen@example.com"
},
{
"type": "signer",
"key": "candidate",
"name": "Maria Garcia",
"email": "maria.garcia@example.com",
"signature_options": [
"typed",
"drawn"
],
"delivery_type": "email",
"ceremony": {
"authentication": [
{
"type": "email_code"
}
],
"redirect_url": "https://acme.example/welcome",
"embeddable_in": [],
"url_variant": "standard"
}
}
],
"deliverable": {
"type": "standard",
"language": "en",
"timezone": "America/New_York",
"timestamp_format": "MM/DD/YYYY HH:mm:ss"
}
}
}