Reporting API

The Reporting API allows your platform to retrieve and sync Activity history.

Parameters

All parameters are optional. API will return up to 250 results per page. If using the search parameter, be sure to URL encode its content.

Authentication

curl --request GET 'https://verifypass-new.com/api/v2/[email protected]&startDate=2024-01-01&endDate=2024-01-30'
--header 'key: your-api-key'

Response

{
  "count": 2090,
  "maxPage": 9,
  "data": [
    {
      "first_name": "Test",
      "last_name": "User",
      "email": "[email protected]",
      "community_key": "mil",
      "widget_key": "7d9e53",
      "data": "fake-demo-code",
      "created_at": "2023-08-18T03:21:46.000000Z"
    },
    {
      "first_name": "Test",
      "last_name": "User",
      "email": "[email protected]",
      "community_key": "fir",
      "widget_key": "7d9e53",
      "data": "fake-demo-code",
      "created_at": "2023-08-14T15:48:56.000000Z"
    },
  ]
}

Errors

{
    "error": "Invalid auth credentials."
}

A valid API key is required for every request.

Rate Limiting

While there is no specific rate limit for API requests, VerifyPass serves requests behind the Cloudflare network for DDoS mitigation. Therefore, it is recommended to poll and store results periodically or as-needed.