As part of our commitment to delivering the latest and most secure services, we are excited to announce the complete migration from API Version 7 to Version 8. The transition is imperative to ensure continued access to our enhanced features and robust security measures. Below is a guide to assist you in smoothly migrating.
API Version 8 brings significant improvements, including enhanced security features, optimized performance, and additional functionalities. To benefit from these advancements, it is essential to upgrade.
What this means for you
All users currently utilizing API Version 7 must migrate to Version 8 before the designated deprecation date to avoid service disruption.
Following the deprecation date, we will no longer provide support for API Version 7. It is crucial to transition to Version 8 to continue receiving the benefits and security compliance.
Steps to Take
Upgrade to Version 8: Please review our documentation and upgrade your systems to API Version 8 as soon as possible. This will ensure uninterrupted service.
Testing: We recommend thoroughly testing your applications with Version 8 to identify and address any potential compatibility issues before the deprecation date.
Support: If you encounter any challenges during the migration process or have questions, our support team is ready to assist you. Contact email@example.com for prompt assistance.
More logical; improved JSON structure
More stable; e.g., v7 has a limitation for the number of documents users can request with the GET call
More flexible; e.g., in v8 there are more fields that users can update
More fields; v8 includes many fields beyond what v7 supports.
Feature Freeze; v7 has been in feature freeze since May 2022.
Changes and Improvements
The main differences between v7 and v8 of the Veryfi API are the request and response structure. Before making the switch to API v8, make sure you’ve reviewed the following breaking changes as these will require corresponding implementation changes in your application code.
Making the switch to version 8 is as simple as changing the version portion of the API endpoint URLs. For example, if you’re currently using version 7, you’re used to submitting documents for processing at this endpoint:
To switch to version 8, you’ll need to change that
v7 to a
v8 like so:
Boolean Parameters in Requests
API Version 8 abandons
1/0 style booleans for a more traditional
true/false style of boolean.
Boolean in Responses
Similar to the above, booleans in responses have also been moved from the
1/0 style to
JSON Response Structure Changes
phone_numberand all fields with the
vendor_prefix at the root level have been moved inside the
vendor_prefix on all vendor fields has been stripped
all fields with
bill_to_prefix have been moved into the
all fields with
ship_to_prefix have been moved into the
all fields with
payment_prefix have been moved into the
end many more
More than 15 new JSON fields have been introduced to v8.
Version 8 introduces pagination to document
GET requests. This provides control over how many documents are returned per search query and allows for short response times when a query results in a large number of documents.
To enable pagination, simply specify the
page_size query string parameters. For example, this request will return the first 50 documents:
curl --location --request GET 'https://api.veryfi.com/api/v8/partner/documents/?q=keyword&page=1&page_size=50' \
--header 'CLIENT-ID: **********' \
--header 'AUTHORIZATION: apikey *********:**********'
Reach out if you need to set up a test environment to simulate the migration process. Thoroughly test all functionalities to ensure your system compatibility with Version 8 before the full switch.
Plan your migration within the specified timeline to avoid service disruption.
Planned depreciation date: June 1, 2024
Support and Assistance:
If you encounter challenges during the migration, reach out to our support team at firstname.lastname@example.org for prompt assistance or your Technical Account Manager.