API v3 to v3.6 migration guide

Start here

The following short guide is for customers migrating from API v3 to API v3.6 and supplements our API reference documentation. If you're migrating from API v2 to API v3.6, you should refer to our separate API v2->v3.6 migration guide instead. For a list of the new features in API v3.6, please refer to our API release notes.

If you have any difficulties migrating, please contact Entrust's Customer Support team.

Summary of differences

Base URL

The base URL for the European region has changed to api.eu.onfido.com from API v3.1 onwards.

If you're deployed in the European region using api.onfido.com with API v3, you should use the new base URL api.eu.onfido.com with API v3.6.

You can read more about our supported regions.

Applicant consent

From API v3.4 onwards, there is new applicant data required when creating identity verification flows.

Location

From API v3.4 onwards, Entrust has introduced a new location parameter in the applicant and documents resources for specifying the location of an applicant.

The location parameter is mandatory for all applicants in order to create identity verification flows from API v3.4 onwards. If you do not provide it, all verification requests will fail with a validation error.

Consent

Entrust has introduced a new consents parameter in the applicant resource.

The consents parameter is mandatory for any applicant who is located in the US in order to create identity verification flows from API v3.4 onwards. If you do not provide the consents parameter, and the location of the applicant is the US, all verification requests will fail with a validation error.

For customers who have not migrated to Workflow Studio and are creating identity verification flows using our checks API endpoint, the privacy_notices_read_consent_given parameter no longer exists in check creation.

You can read our Privacy notices and consent migration guide for further guidance on how to update your integration to collect end user consent in API 3.6.

Versioning policy

Our versioning policy has changed from v3.6 onwards, you can read about in our versioning policy page.