API Details

This section covers the conventions and behaviors that apply across all Verifa API endpoints.

TopicWhat it covers
AuthenticationAPI key usage and environment scoping
PaginationOffset-based and cursor-based pagination patterns
Rate LimitingRequest limits and retry strategies
VersioningAPI version headers and compatibility policy
ErrorsError response format and common status codes
WebhooksEvent types, delivery, and signature verification
IdempotencySafe retries with idempotency keys
Key InflectioncamelCase / snake_case response formatting
Data AccessScoped API key permissions and data visibility
Data RetentionPII lifecycle, redaction, and automatic expiry