Changelog
Breaking-change announcements for B2B Digital Certificate Issuance. Versions are listed newest first. Review the affected APIs and migration steps before changing your integration.
17 August 2026: Response standardization
2026-08-17.heimdall
Breaking change · Announcement date: 17 August 2026 · Effective date: 17 August 2026
The Privy-Version header introduces the response version 2026-08-17.heimdall. The previous response version is 2023-01-30.hela.
This release standardizes response field names and the success status value. Integrations that read the previous field names or compare status with ok must update their response handling when adopting the new version.
Affected APIs
- User Verification v2 (
userverification v2)
Response changes
Previous response (2023-01-30.hela) | New response (2026-08-17.heimdall) |
|---|---|
userStatus | user_status |
rejectCode or reject_code | rejected_code |
registrationStatus | registration_status |
status: "ok" | status: "success" |
Apply these mappings wherever the corresponding fields occur in an affected API response. This announcement does not imply that every response contains every listed field.
New integrations
Send this request header explicitly, alongside the API's existing authentication and other required headers:
Code
For cURL, add:
Code
Implement response handling using user_status, rejected_code, registration_status, and the success status value wherever applicable.
Existing integrations
- Inspect the API's
Privy-Versionresponse header to identify the response version your integration currently uses. - Before adopting
2026-08-17.heimdall, update field lookups, response models, validation, and status comparisons for the mappings above. - Test successful and rejected responses for each affected API your integration uses.
- Send
Privy-Version: 2026-08-17.heimdallwith the updated integration and verify the version returned in the response header.
Changing the request header alone is not sufficient: response handling must support the selected version to avoid breaking the integration.
30 January 2023: Hela
2023-01-30.hela · Previous version
Most existing integrations currently use this version. Clients and merchants can check the Privy-Version response header returned by the API to identify the version their integration currently uses.
We encourage clients and merchants to migrate to the latest version, 2026-08-17.heimdall, using the response changes and migration steps above.