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
  • 1. Create a Person or Company Check
  • 2. Use the Webhook for Results
  • 3. Retrieve the Results

Was this helpful?

Creating a Background Check

If you are integrating background checks through the ZapSign API, we recommend following this flow for proper implementation and the best user experience:

PreviousUnderstanding the ResultNextPerson Check

Last updated 19 days ago

Was this helpful?

1. Create a or Check

The first step is to make a request to our check creation endpoint. Once submitted, the check enters the verification process.

Estimated processing time: between 2 minutes and 2 hours, depending on the databases consulted and the country.

2. Use the

We recommend configuring a webhook to automatically receive a notification when the check is completed.

  • Once the check is finished, ZapSign will send an HTTP POST notification to the webhook configured by your system, indicating that the results are ready to be retrieved.

  • This avoids the need for repetitive polling requests to the server.

3. Retrieve the Results

Once you’ve received the webhook notification—or after the estimated processing time—you can obtain the results through our endpoints:

  • : This endpoint returns the complete JSON with all the information found, including:

    • The global score

    • Details by dataset

    • Severity levels associated with each finding

  • : If you need a readable and shareable version, you can download the PDF of the check.

💡 Tip: Using the webhook along with the result endpoints ensures an efficient and automated flow, avoiding unnecessary delays or redundant API calls.

Person
Company
Webhook for Results
Check Details
Retrieve check