Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pearcheck.com/llms.txt

Use this file to discover all available pages before exploring further.

PearCheck sends authenticated POST callbacks to your specified URLs for verification events. Configure callback URLs and security headers through your PearCheck dashboard or API requests.

​
Callback Types

​
Verification Callback

Trigger: Automated verification completion
Parameter: callback_url 
{
  "callback_url": "https://yourdomain.com/verify-callback"
}

​
Events Callback

Trigger: Manual actions (e.g. dashboard updates)
Parameter: events_callback_url 
{
  "events_callback_url": "https://yourdomain.com/events-callback"
}

​
Setting Callback URLs

​
Method 1: Global Settings

  1. Navigate to Dashboard > Settings
  2. Set default callback URLs
  3. Applies to all verifications unless overridden

​
Method 2: Per-Request

{
  "callback_url": "https://yourdomain.com/custom-callback",
  "events_callback_url": "https://yourdomain.com/custom-events"
}

​
Authentication

To ensure callbacks originate from PearCheck, verify the X-PearCheck-Signature header containing a signature set on your account.

​
Step 1: Set Your Secret Key

  1. Navigate to Dashboard > Settings
  2. Locate the “Signature Secret” section
  3. Enter your custom secret
  4. Compare your custom secret with the X-PearCheck-Signature header sent by PearCheck 
    X-PearCheck-Signature: your_shared_secret_here