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:
1. Create a Person or Company 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 Webhook for Results (in development)
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:
Details Endpoint: This endpoint returns the complete JSON with all the information found, including:
The global score
Details by dataset
Severity levels associated with each finding
PDF Endpoint: 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.
Last updated
Was this helpful?