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
  • Signature Validation
  • Signers
    • Detail signer
    • Update signer
    • Add signer
    • Delete signer
    • Reset validation attempts
    • 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. Signers

Reset validation attempts

If a signer fails the validation process three times, the document will be blocked and the signer will not be able to continue signing. This endpoint allows you to reset the validation attempts for a specific signer, enabling them to restart the validation process.

Important: When resetting the attempts, if the signer starts the validation process again, there will be an additional credit cost according to the selected method (see pricing here). The signer will have three (3) new attempts to validate their identity, and if they fail again, the process will be blocked once more.

PUT https://api.zapsign.com.br/api/v1/reset-auth-attempts/{{signer_token}}/

Headers

Name
Type
Description

Authorization*

string

apiToken ahead of the "Bearer" text.

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

Params

Name
Type
Description

signer_token*

string

Unique token of the signer (obtained when creating the document).

{
    "success": "The signer's attempts have been successfully reset."
}
{
    "error": "Signer has attempts"
}

Important Note

This endpoint to reset attempts only applies to authentication methods that include retries, specifically when the selfie_validation_type parameter matches one of the following values:

  • liveness-document-match

  • identity-verification

  • identity-verification-global

For other authentication methods that do not require selfie capture or biometric validation, this endpoint has no effect.

PreviousDelete signerNextBatch sign via API

Last updated 1 day ago

Was this helpful?