All the changes listed below are considered to be backwards compatible by Veriff. Make sure to set up your systems in such flexible manner that it is able to handle these changes.
Adding new properties (e.g.,
strings,objects,arrays) to existing API responsesChanging the order* of properties in existing API responses, i.e., the order of
strings,objects,arraysAdding new API resources, e.g., adding new API endpoints
Adding new optional request parameters to existing API endpoints
Changing the length or format of opaque**
strings, such as error messages, object IDs, etc.Adding new
event typesto webhooksAdding new properties (e.g.,
strings,objects,arrays) to webhook payloadsWebhook listener should gracefully handle unfamiliar
event types
*As a general note on the order of properties in the responses, keep in mind that the order is not static. This means that the order you see in your API call responses may differ from the order you see in Veriff documentation.
**This means data that your system should be able to just transmit or store, not interpret.