Account Protection API Changelog
8 min
\<font color="#b6c7cb">\</font> topic type concept purpose record contractual and behavioral changes to the api over time audience api integrators and client developers maintaining or upgrading integrations applies to the api and its published openapi reference does not apply to internal implementation changes that do not affect the public api contract this changelog documents contractual and behavioral changes to the api it is intended to help integrators understand how the api has evolved and assess the impact of changes on existing integrations the openapi reference remains the single source of truth for the current api contract this changelog provides historical context and impact classification for changes reflected in the reference how to read this changelog each entry is listed in reverse chronological order and classified by impact level type meaning client action breaking a change that may require code changes or integration updates classifications removed, changed required update backward compatible a change that does not break existing integrations classifications added, changed, deprecated optional update behavioral contract unchanged, behavior changed classification changed review documentation a clarification or correction with no contract or behavior change classification clarified none when a field or behavior is deprecated, the changelog records the deprecation date the recommended replacement (if applicable) whether removal is planned for a future release changelog entries version 2 12 ( expanded authentication options) type backward compatible added added support for oauth 2 0 (client credentials) authentication in addition to basic authentication version 2 11 (verification event enhancements) type backward compatible added added required updateeventtype field to the verification event added optional fields to the verification event verificationclassification updateeventrecommendationdetail changed added new option newcodewithinexpiry to the failurecode field in the verification event version 2 10 (field relocation in payment schema ) type breaking changed moved ispaymentrecurring from the paymentmethods block to the payment block version 2 9 (schema and example alignment ) type documentation clarified updated schema types and examples to ensure consistency and alignment version 2 8 (field removal ) type breaking removed removed recommendationcode from chargeback and verification events version 2 7 (response structure changes ) type breaking changed recalibrated nested blocks in the response structure removed removed reasoncodes block from the response version 2 6 (new events and verification fields ) type backward compatible added added success and failurecode fields to the verification event added new refunds event to the api version 2 5 (major authentication and schema updates ) type breaking changed changed api base url prefix to adi accertify net removed removed support for jwt authentication custom authentication type backward compatible added added account object to the login event added seccard as a payment type for corporate issued payments used within secure payment portals added isrecurring field to the paymentmethods object for subscriptions changed moved accountstatus and hashedpassword to the root level version 2 4 (verification and authentication enhancements ) type backward compatible added added success and failurecode fields to the verification event added new options to verificationtype field fido magiclink added authenticationmethod field to all events version 2 3 (guest checkout support) type backward compatible added added isguestcheckout field to inventoryhold and payment events version 2 2 (authentication method expansion ) type backward compatible added introduced jwe authentication method version 2 1 (branding and new event ) type backward compatible added added new inventory hold event changed updated api branding from adi to