ZapSign API
English
English
  • General Information
  • Getting Started
  • ZapSign Environments
  • Ready-to-use requests!
  • Authentication
    • Static token
    • JWT Authentication
      • Get access token
      • Refresh your access token
  • Types of Tokens
  • API versioning
  • Rate Limit Policies
  • Incident alerts
  • How Payment Works
  • Status Code
  • Account
    • Plan Information
    • List account users
    • Create account users
    • Delete account user
  • Documents
    • Create document via Upload
    • OneClick (ClickWrap)
      • Create document (OneClick)
    • Create document via Template
    • Add attachment (extra document)
    • Add attachment (extra document) via Template
    • Detail document
    • List documents
    • Delete document
    • Document Audit Trail
    • Optional: Place signatures
    • Reject Documents
  • Signers
    • Detail signer
    • Update signer
    • Add signer
    • Delete signer
    • Batch sign via API
    • Reject Documents by User
  • Templates
    • Create template (DOCX)
      • Configure Template Form
    • List templates
    • Get template
    • Update template
    • Delete template
  • Partnerships
    • Update Payment Status
    • Create Account
  • TIMESTAMP
    • Add timestamp
  • Background Check
  • Introduction
  • Understanding the Result
  • Creating a Background Check
    • Person Check
    • Company check
  • Retrieve a Check
  • Check details
  • Webhooks
    • How webhooks works
    • Testing webhooks on ZapSign
    • Create Webhook
    • Webhooks logs
    • Events
      • Document
        • Doc created
        • Doc deleted
        • Created signer
      • Signer
        • Signature request send
        • Document viewed
        • Reading confirmation
        • Doc signed
        • Doc refused
        • Email bounce
        • Failed Validation
      • Background check
        • Background check completed
    • Reprocessing Documents and Webhooks
    • Delete Webhook
  • Widget
    • How widget works
Powered by GitBook
On this page

Was this helpful?

  1. Webhooks
  2. Events
  3. Document

Created signer

created_signer (example)

PreviousDoc deletedNextSigner

Last updated 2 months ago

Was this helpful?

Caution: the original_file and signed_file links are temporary and expires in 60 minutes. In case your system needs to save those links it is recommended that you save them in your own CDN or that you call the endpoint every time your user needs a valid URL that will expires in more 60 minutes.

{
	"sandbox": false,
	"external_id": "",
	"open_id": 5,
	"token": "0eb8f439-2afa-4014-a09a-2055e4fc5e24",
	"name": "a6f3fb67-dd1a-471a-89f6-75baf6d89a19.docx",
	"folder_path": "/",
	"status": "pending",
	"rejected_reason": null,
	"lang": "es",
	"original_file": "https://zapsign.s3.amazonaws.com/dev/2025/2/pdf/c19051a3-75b0-4b88-b367-34774040d3eb/bbecc211-3e39-4688-aef2-a019ebd73e50.pdf?AWSAccessKeyId=AKIASUFZJ7JCTI2ZRGWX&Signature=wnn2ZfDYmtula%2BhZf7BY85B8PUk%3D&Expires=1739469047",
	"signed_file": null,
	"extra_docs": [],
	"created_through": "web",
	"deleted": false,
	"deleted_at": null,
	"signed_file_only_finished": false,
	"disable_signer_emails": false,
	"brand_logo": "",
	"brand_primary_color": "",
	"created_at": "2025-02-13T16:50:35.657445Z",
	"last_update_at": "2025-02-13T16:50:46.595543Z",
	"created_by": {
		"email": "email@email.com"
	},
	"template": null,
	"signers": [{
		"external_id": "",
		"sign_url": "https://app.zapsign.com.br/verificar/12fea879-7c23-4733-a9d0-9377105dba80",
		"token": "1c7ea879-7c23-4733-a9d0-9377105dba80",
		"status": "new",
		"name": "Signer name",
		"lock_name": false,
		"email": "email@email.com",
		"lock_email": true,
		"hide_email": false,
		"blank_email": false,
		"phone_country": "57",
		"phone_number": "111111111",
		"lock_phone": false,
		"hide_phone": false,
		"blank_phone": true,
		"times_viewed": 0,
		"last_view_at": null,
		"signed_at": null,
		"auth_mode": "assinaturaTela",
		"qualification": "",
		"require_selfie_photo": false,
		"require_document_photo": false,
		"geo_latitude": null,
		"geo_longitude": null,
		"redirect_link": "",
		"signature_image": null,
		"visto_image": null,
		"document_photo_url": "",
		"document_verse_photo_url": "",
		"selfie_photo_url": "",
		"selfie_photo_url2": "",
		"send_via": "whatsapp",
		"resend_attempts": null,
		"cpf": "",
		"cnpj": "",
		"send_automatic_whatsapp_signed_file": null,
		"liveness_photo_url": "",
		"selfie_validation_type": "none",
		"ip": null
	}],
	"answers": [],
	"auto_reminder": 0,
	"signature_report": null,
	"tsa_country": null,
	"use_timestamp": true,
	"metadata": [],
	"event_type": "created_signer",
	"created_signer": {
		"external_id": "",
		"sign_url": "https://app.zapsign.com.br/verificar/1656879-7c23-4733-a9d0-9377105dba80",
		"token": "1c7ea879-7c23-4733-a9d0-9377105dba80",
		"status": "new",
		"name": "New signer",
		"lock_name": false,
		"email": "email2@email.com",
		"lock_email": true,
		"hide_email": false,
		"blank_email": false,
		"phone_country": "57",
		"phone_number": "2222222",
		"lock_phone": false,
		"hide_phone": false,
		"blank_phone": true,
		"times_viewed": 0,
		"last_view_at": null,
		"signed_at": null,
		"auth_mode": "assinaturaTela",
		"qualification": "",
		"require_selfie_photo": false,
		"require_document_photo": false,
		"geo_latitude": null,
		"geo_longitude": null,
		"redirect_link": "",
		"signature_image": null,
		"visto_image": null,
		"document_photo_url": "",
		"document_verse_photo_url": "",
		"selfie_photo_url": "",
		"selfie_photo_url2": "",
		"send_via": "whatsapp",
		"resend_attempts": null,
		"cpf": "",
		"cnpj": "",
		"send_automatic_whatsapp_signed_file": null,
		"liveness_photo_url": "",
		"selfie_validation_type": "none",
		"ip": null,
		"notification_type": "request",
		"notification_channel": "whatsapp",
		"sent_at": "2025-02-13T16:50:47.874783Z"
	}
}
Detail document