DIVE Online API - AccountProfile

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.


/api/v2/public/AccountProfile

[GET] api/v2/public/AccountProfile

Use Case - Retrieves all account profiles associated with the DIVE Online account.

Token - public API token (pk_) or secret API Token (sk)

Required Parameters

Optional Parameters

  • Page specifies the page number to return. The value must be between 1 and 2147483647.

  • PageSize specifies the number of items to return per page. The value must be between 1 and 400.

  • SortField specifies the field to sort the results by. The value must be one of the following: id, name, active, isDefaultForAccount, lastUpdated.

  • Order can be either asc or desc to specify the order of the results.

  • IncludeOnlyActive when set to true, only active profiles will be returned.

  • ShowDefaultAtTop when set to true, the default profile will be shown at the top of the list. This will override any sorting applied.

Response Body

{
 
  "page": 0,
  "pageSize": 0,
  "total": 0,
  "totalPages": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "active": true,
      "isDefaultForAccount": true,
      "lastUpdated": "2025-12-18T16:46:45.897Z"
    }
  ]
}

Response Fields

  • page The current page number.
  • pageSize The number of items per page.
  • total The total number of items listed.
  • totalPages The total number of pages.

items — An array of accountProfiles.
  • items.id - The unique identifier for the account profile.
  • items.name - The name of the account profile.
  • items.active - Indicates whether the profile is active.
  • items.isDefaultForAccount - Indicates whether this profile is the default for the account.
  • items.lastUpdated - The date and time when the profile was last updated.