API Manual

In this documentation, we describe in detail all the endpoints available via the DIVE Online Web API as well as how to authenticate your requests.

Base URL

https://api-diveonline.idscan.net/

Authentication

Every endpoint in the DIVE Online Web API requires authentication. You will need to include a bearer token with each request to authenticate. The bearer token will be included in the Authorization header of each request made.

Important

When making requests using the DIVE Online Web API we call the bearer token an API token. DIVE Online utlizies two types of tokens for authentication: public API(with the pk_ prefix) tokens and secret (with the sk_ prefix) _ API tokens. They all serve the same purpose (i.e. serving as the bearer token to authenticate a request) but they have different names to denote their different uses.

You can generate a token for authentication in the DIVE Online Web Portal here.

The type of token required for each endpoint is specified in the documentation for that endpoint.

Applicants Endpoints

The Applicants endpoints allow you to create and manage applicants in DIVE Online. The applicant is the core entity in DIVE Online and represents a person whose identity is being verified. All other groups of endpoints in the DIVE Online API revolve around the applicant entity.

Important

The developer integrating the DIVE Online Web API should understand the applicant lifecycle and how to create and manage applicants using the Applicants endpoints before proceeding to other groups of endpoints.

Account Profile Integration Endpoints

The AccountProfileIntegrations API allows you to retrieve information about the integrations associated with specific account profiles in DIVE Online. Each account profile can have multiple integrations configured, which define how identity verification processes are handled for applicants linked to that profile.

Account Profiles Endpoints

The DIVE Online platform provides a way to create unique settings profiles for different use cases. The AccountProfile API allows you to view these profiles programmatically.

Profiles can be created and managed through the DIVE Online web portal. Each profile contains specific settings that dictate how identity verification processes are handled for applicants associated with that profile.

Authentication Endpoints

The authentication endpoints are designed to be used with a hardware scanner that is capable of taking UV/IR images of documents.

These endpoints allow not only white light verification, but also additional layers with these new set of images.

Integrations Endpoints

The Integrations endpoints allows the DIVE Online developer to view the current configuration for a specific Integeration ID.

Transaction Management Endpoints

The transaction mangaement API endpoints allow the DIVE Online account to programmatically maintain it's subaccount transaction limits.

This includes enabling transactions for subaccounts, viewing transaction balances, depositing transactions, and retrieving transaction history.

Transaction Endpoints

The transaction API endpoints allow for viewing account transaction limits.

Upload Documents Endpoints

The Upload Documents endpoint allows the DIVE Online developer to store but not validate an applicant's documents in DIVE Online. This can be useful in scenarios where the developer wants to store documents for future validation or for having a more secure storage solution.

Validation Endpoints

The Validation Endpoints are the main endpoints used for verifying transaction with DIVE Online.