DIVE API/Web Services API to DIVE Online Migration Guide

This guide provides an overview of the key differences between Web Services API/DIVE API and DIVE Online, along with steps to help you transition your integration smoothly.

Key Differences

New Features:

DIVE Online offers several new features not present in DIVE API or the Web Services API, including:

  • Account Profiles: Allowing for multiple configurations under a single account.
  • Webhooks: For real-time notifications on verification status changes.
  • SMS/Email Notifications: Optional SMS/email notifications to applicants during the verification process. The link on this page is hosted by IDScan.net.
  • Callback URLs: For redirecting users post-verification.
  • Manual Upload Portal: A web interface for applicants to manually upload documents if needed.
  • Front End Portal Editing: Customizable UI settings directly from the DIVE Online Web Portal.
  • Attempt Limits: Configurable limits on verification attempts to enhance security.
  • QR Code Transitions: Enabling users to switch between devices during the verification process using QR codes. Requires the use of the IDScan.net Wrapper.
  • Consent Forms: Built-in support for consent forms that applicants must agree to before proceeding with verification.
  • Automated Email Reports: Scheduled email reports summarizing verification activities.

Front End UI:

Customers familiar with IDScan.net's front-end offerings in DIVE API/Web Services API will need to adapt to the new front-end solutions provided by DIVE Online:

  • Browser UI: IDVC2(Web Library) is replaced by Onboarding(Wrapper) for web applications.
  • Mobile SDKs: DIVE SDKs for iOS and Android are replaced by DIVE Online Mobile SDKs.

Although they visually resemble past offerings, they are separate dependencies with distinct integration methods.

Additionally, users on DIVE Online can customize their UI settings directly from the DIVE Online Web Portal, reducing the need for extensive front-end coding.

  • Wrapper : Managed on the Domains page of the DIVE Online Web Portal.
  • Mobile SDKs: Managed on the Bundles page of the DIVE Online Web Portal.
Note

Any customizations made in code for the Wrapper or DIVE Online Mobile SDKs will override settings configured in the DIVE Online Web Portal.

Applicant Management:

DIVE Online introduces the concept of Applicants, which represent individuals undergoing verification. Each Applicant can have multiple associated verification Requests. This structure differs from DIVE API, where Requests were typically standalone.

Part of the applicants system is the generation of an applicantId for each new applicant created. This applicantId is then used to associate all verification requests for that individual.

This is done via a POST to the Applicants endpoint. It will be the responsibility of the integrator to call this endpoint and store the returned applicantId for future use.

This applicant ID is then used in the Validation endpoint to create verification requests for that specific applicant. The Validation endpoint is the equivalent of a DIVE API v3/v4 verify or a Web Services Parse/ParseImage request.

Integration Method:

When migrating from DIVE API/Web Services API to DIVE Online, you will need to decide on the integration method that best suits your application's needs. DIVE Online supports multiple integration options, including:

  • No Code/Web Portal: Using the DIVE Online Web Portal for manual verifications.
  • Low Code : Utilizing the hosted front-end solutions (Wrapper or Mobile SDKs) with minimal backend coding. Utilizes the page hosted by IDScan.net.
  • Full Embedding: Embedding the Wrapper or Mobile SDKs directly into your application with full control over the user experience.

More Information on these integration options can be found in the Integration Options section.