Changelog and compatibility
API v1 policy
Within /v1, Assayra may add optional response fields, new enum values where documented as extensible, new webhook types and new endpoints. Existing required fields, meanings and security controls are not silently weakened.
Integrations should:
- ignore unknown additive response properties;
- handle unknown event types safely;
- never use exhaustive enum switching without a default path;
- pin SDK versions; and
- import or diff
/openapi/jsonduring release validation .
Breaking changes
A breaking contract receives a new API or bridge protocol version, migration guidance and an announced support window. Workflow policy changes are also explicit: applications remain pinned to their original immutable version.
Current release line
1.0.13
- Added workflow-version-pinned recovery and inclusion policy with tamper-evident hashes.
- Added accessible retry, low-bandwidth capture, alternate-document, camera-less review and attended-assistance routes.
- Added applicant recovery UI, tenant policy workbench, linked recovery cases, audit records and webhook events.
- Added Web SDK and OpenAPI recovery contracts with tests proving recovery cannot pass checks or approve applications.
1.0.12
- Added idempotent event-level usage meters across identity, NFC, attended, fraud, monitoring, wallet and agent operations.
- Added hashed open-period snapshots and immutable closed-period finalization.
- Added normalized Stripe invoice-line comparison and explicit mismatch review state.
- Added tenant billing and Control Tower aggregate visibility without applicant evidence access.
- Added typed Web SDK billing methods and full API reference guidance.
- Added privacy-thresholded assurance funnel, quality, review, cohort and cost analytics across API, portal and Web SDK.
1.0.11
- Added signed, secret-free tenant configuration packages.
- Added path-level target validation and diff review.
- Added two-person live promotion and two-person governed rollback.
- Added typed Web SDK configuration methods and full API reference guidance.
| Contract | Version | Notes |
|---|---|---|
| Tenant/applicant REST | v1 | OpenAPI 3.1 at /openapi/json |
| Hosted bridge events | 1.0 | ready, step, complete, error |
| Web SDK | 1.0.x | Hosted plus tenant/server client |
| iOS SDK | 1.0.x | iOS 15+, Swift Package |
| Android SDK | 1.0.x | API 26+, AAR/Maven |
| React Native SDK | 1.0.x | Hosted and headless TypeScript |
Production customers receive release notes with exact artifacts, hashes, migration state and target-environment verification requirements.