> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.simplecheck.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Developer API: Enable Access, Secure Your Token, and Connect Zapier

## Before You Start

Open **Developer API** from the portal sidebar. The API lets you use SimpleCheck data inside your own product, CRM middleware, warehouse, or Zapier workflow without forcing every experience through the hosted SmartForm UI.

Your team owns implementation, debugging, permissible purpose, consent, disclosures, and credential security.

*Developer API shows the current access state, pricing/terms path, credentials, and versioned documentation.*

---

## Why Use the Developer API?

* Build a custom consumer experience while using SimpleCheck qualification
* Pull SmartForm leads into an internal data platform
* Automate lead/booking workflows with the official Zapier app
* Keep a stable submission ID for reliable synchronization

Use the hosted SmartForm when you want SimpleCheck to handle the form, consent flow, routing, and booking UI. Use the API when your engineering team intentionally owns those responsibilities.

---

## Enable API Access

1. Click the API Access purchase/enable action.
2. Complete billing when required.
3. Review every acknowledgment and the full terms.
4. Accept the current terms.
5. Copy the generated API token immediately and store it in a secret manager.

> Anyone with the token can read lead data and run permitted API requests. Never place it in frontend JavaScript, public repositories, screenshots, chat, or URL query parameters.

---

## Manage the Token

The active Developer API page lets the account owner:

* Reveal the current token
* Copy it
* Rotate it
* Review the active key prefix
* Cancel API Access when eligible

Sub-users cannot access API tokens. If you rotate a token, update every integration using the old value immediately.

---

## Authenticate Requests

Use either header:

**Authorization: Bearer YOUR\_API\_TOKEN**

or:

**X-SimpleCheck-Api-Key: YOUR\_API\_TOKEN**

Base URL:

https://portal.simplecheck.ai

The versioned documentation shown after activation includes authentication, endpoints, filters, pagination, rate limits, and Zapier guidance.

---

## Read SmartForm Leads

The public leads endpoint supports lead-only and booking-lead records:

* **GET /api/public/v1/leads?type=lead\_only**
* **GET /api/public/v1/leads?type=booking\_lead**

Use cursor pagination. When **page.hasMore** is true, send the returned **page.nextCursor** as the next **cursor**.

Use **updatedAfter** when your integration must retrieve records edited since a known timestamp.

Use the submission **id** as the durable deduplication key.

---

## Connect Zapier

For the official SimpleCheck Zapier polling trigger:

1. Enable **Developer API**.
2. Authenticate the SimpleCheck Zapier app with the API token.
3. Choose the lead-only or booking-lead trigger.
4. Keep the submission **id** as the deduplication key.

For real-time automation without Developer API access, use the widget’s **Webhooks** tab and a Zapier **Catch Hook** instead.

---

## Rate Limits

The public API limit is **120 requests per minute per token + IP**.

Read:

* **X-RateLimit-Limit**
* **X-RateLimit-Remaining**
* **X-RateLimit-Reset**

Back off when limited; do not retry in a tight loop.

---

## Cancellation and Suspension

Cancellation keeps access active through the current paid period, then credentials are revoked. Already-paid fees are not refunded.

If access is suspended/cancelled, stop jobs safely and re-enable access before retrying production requests.

## Troubleshooting

### 401 Unauthorized
Confirm the correct header/prefix and that the token was not rotated/revoked.

### Duplicate Zapier records
Deduplicate with the submission **id**, not email or timestamp.

### Missing recent edits
Use **updatedAfter** and cursor pagination.

### 429 responses
Read the rate-limit headers and wait until reset.

Never send your full API token to support. Share only the key prefix, endpoint, status code, request time, and redacted response.