Skip to main content

3 posts tagged with "webhooks"

View All Tags

ageCategory Now Included in FAIL Status Webhook Events

We've updated the Verification.Result webhook event to include the ageCategory field in FAIL status events when age data is available.

What's New​

ageCategory in FAIL Status Events​

The ageCategory field is now included in Verification.Result webhook events for FAIL status when:

  • failureReason is age-criteria-not-met
  • Age data is available (both age.low and age.high are present)

This provides more complete information about the user's age category even when verification fails due to age criteria not being met, enabling better analytics and logging while maintaining clear access control boundaries.

Updated Documentation​

The Verification.Result documentation has been updated to reflect this change:

  • Fields table: Updated description to clarify when ageCategory is present for FAIL status
  • Key differences table: Clarified when ageCategory is present for webhook events vs API endpoint
  • FAIL status field presence rules: Updated to show ageCategory as "Sometimes included" with specific conditions
  • Complete field matrix: Updated to show ageCategory as "sometimes²" for FAIL status in webhooks
  • Example payloads: Added ageCategory to the FAIL status example to demonstrate the new behavior
  • Implementation checklist: Updated guidance for handling ageCategory in FAIL status
  • Implementation notes: Clarified the behavior of ageCategory for both PASS and FAIL statuses

Important Notes​

  • Access control: Even when ageCategory is present in FAIL status events, it should never be used for access control decisions. Always use the status field to determine access.
  • Consistency: This update applies to both webhook events and API endpoint responses
  • Language support: All language versions (English, Japanese, Simplified Chinese, and Korean) have been updated

Next Steps​

  • Review the updated Verification.Result documentation
  • Update your integration to handle ageCategory in FAIL status events if needed
  • Remember: Never use ageCategory for access control when status is FAIL, even if the field is present. Use it only for analytics, logging, or informational purposes.

Edge Case Handling Examples

We've added comprehensive edge case handling examples to the age verification guide and updated the verification event contract to clarify field presence rules.

What's New​

Edge Case Handling Examples​

The Waterfall Flow guide now includes detailed code examples for handling verification edge cases. Each example demonstrates both incorrect and correct handling patterns.

New examples include:​

  • Partial attempt (max attempts exceeded): Proper handling of max-attempts-exceeded failure reason when users exhaust all verification attempts without a conclusive age determination
  • Suspicious activity detected: Security-focused handling of fraudulent-activity-detected failure reason, including appropriate rate limiting and security measures
  • Complete edge case handler: A comprehensive TypeScript example demonstrating all patterns together

All examples link directly to the Verification Event Contract for complete field presence rules.

Verification Event Contract Updates​

The Verification Event Contract has been updated to clarify field presence rules:

  • age and ageCategory are always present for PASS status: All verification methods that result in PASS provide both age information and age category. You can safely access these fields without conditional checks when processing PASS status results.
  • Age bounds clarification: When an exact age is not provided by the verification method, age.low will be the threshold minimum age required for the verification, and age.high will be 100.

Updated Documentation​

Introducing the Changelog

We're excited to introduce our new Changelog section! This will serve as a centralized place to keep you updated on changes to developer interfaces, API behaviors, and integration patterns.

What's New​

Changelog Section​

Starting today, you can find updates about developer-facing changes in one convenient location. We'll be posting regular updates here to help you stay informed about:

  • API updates and changes: New endpoints, parameter modifications, and deprecations
  • Event system updates: Changes to DOM events and webhooks
  • Interface and behavior changes: Updates to developer interfaces and integration patterns
  • Breaking changes: Important updates that may affect your integration

Verification Event Contract​

We're introducing the Verification Event Contract to provide developers with reliable reference material for how all verification result data is expected to be formatted. This contract applies to both DOM Events and Webhooks, and we're committed to maintaining it as a stable reference for your integrations.

What this means:​

  • Consistent event structure: Predictable event payloads across all event types
  • Comprehensive documentation: Complete event schemas and examples for easier integration
  • Reliable reference: We're committed to maintaining this contract as stable reference material for verification result data formatting

For detailed information about the event structures and how to use them in your integration, please refer to our Events documentation.

Stay Updated​

Bookmark this changelog and check back regularly, or subscribe to our updates to stay informed about the latest changes to the k-ID platform. We're committed to keeping you informed about all updates that may impact your integration.

For high-level product announcements and feature releases, see our Release Notes.

Subscribe to Updates​

You can subscribe to the changelog using your preferred feed format:

Add any of these feed URLs to your RSS reader, news aggregator, or monitoring tool to receive automatic notifications when new changelog entries are published.