DIVE Online API - AccountProfileIntegrations

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.

The differences between an Auth and Unauth configuration is that the UnAuth configuration does not require a bearer token. Only passing in the accountProfileId and integrationId is sufficient to retrieve the configuration settings.

The integrationId is the token from the Domains/Bundles created in the DIVE Online Web Portal.

/api/v2/public/AccountProfileIntegrations/{accountProfileId}/{integrationId}/Configuration

[GET] /api/v2/public/AccountProfileIntegrations/{accountProfileId}/{integrationId}/Configuration

Use Case - Returns the configuration settings of a specific integration for a given account profile.

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

Required Parameters

• accountProfileId The unique identifier for the account profile.
• integrationId The unique identifier for the integration.

Response Body

{
  "cssStyles": "string",
  "cssVariables": "string",
  "jsonSettings": "string",
  "showConsentForm": true,
  "consentText": "string",
  "checkboxText": "string",
  "showQrCode": true
}

Response Fields

• cssStyles (string) - Custom CSS styles applied to the integration interface.
• cssVariables (string) - CSS variables for theming the integration interface.
• jsonSettings (string) - JSON formatted settings specific to the integration.
• showConsentForm (bool) - Indicates if a consent form should be displayed.
• consentText (string) - The text content of the consent form.
• checkboxText (string) - The text associated with the consent checkbox.
• showQrCode (bool) - Indicates if a QR code should be displayed.

/api/v2/public/AccountProfileIntegrations/{accountProfileId}/{integrationId}/UnauthConfiguration

[GET] /api/v2/public/AccountProfileIntegrations/{accountProfileId}/{integrationId}/UnauthConfiguration

Use Case - Returns the configuration settings of a specific integration for a given account profile.

Token - None

Required Parameters

• accountProfileId The unique identifier for the account profile.
• integrationId The unique identifier for the integration.

Response Body

{
  "cssStyles": "string",
  "cssVariables": "string",
  "jsonSettings": "string",
  "showConsentForm": true,
  "consentText": "string",
  "checkboxText": "string",
  "showQrCode": true
}

Response Fields

• cssStyles (string) - Custom CSS styles applied to the integration interface.
• cssVariables (string) - CSS variables for theming the integration interface.
• jsonSettings (string) - JSON formatted settings specific to the integration.
• showConsentForm (bool) - Indicates if a consent form should be displayed.
• consentText (string) - The text content of the consent form.
• checkboxText (string) - The text associated with the consent checkbox.
• showQrCode (bool) - Indicates if a QR code should be displayed.