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
  • Detail signer
  • Request
  • Response

Was this helpful?

  1. Signers

Detail signer

Detail signer

GET https://api.zapsign.com.br/api/v1/signers/{{signer_token}}/

Path Parameters

Name
Type
Description

signer_token

string

Signer token

Headers

Name
Type
Description

Authorization*

string

apiToken ahead of the "Bearer" text.

Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

{
    "external_id": "",
    "token": "9031eccc-3926-453d-b384-5f1afeadf16c",
    "status": "new",
    "name": "João da Silva",
    "lock_name": false,
    "email": "",
    "lock_email": false,
    "phone_country": "55",
    "phone_number": "11989128585",
    "lock_phone": true,
    "times_viewed": 0,
    "last_view_at": null,
    "signed_at": null,
    "auth_mode": "tokenEmail",
    "qualification": "testemunha"
}

Request

Response

{
    "external_id": "",
    "token": "9534eabd-1111-4ba0-aaaa-37bfa6324257",
    "status": "signed",
    "name": "João da Silva",
    "lock_name": false,
    "email": "joao@gmail.com",
    "lock_email": false,
    "phone_country": "55",
    "phone_number": "11999881286",
    "lock_phone": false,
    "times_viewed": 5,
    "last_view_at": "2021-08-23T21:50:02.193406Z",
    "signed_at": "2021-08-23T21:48:41.783595Z",
    "auth_mode": "assinaturaTela",
    "qualification": "contratante",
    "require_selfie_photo": true,
    "require_document_photo": false,
    "geo_latitude": "-20.559258",
    "geo_longitude": "-48.683447",
    "redirect_link": "",
    "resend_attempts": {
        "whatsapp": 0,
        "email": 0,
        "sms": 0
    },
    "send_automatic_whatsapp_signed_file": false
}
PreviousReject DocumentsNextUpdate signer

Last updated 5 months ago

Was this helpful?

LogoDetail signer | ZapSign WorkspacePostman