Volumental

Authentication & Authorization

Credentials

• Volumental connects via OAuth 2.0 with Client Credentials grant flow.
• Client ID and Client Secret credentials can be obtained through the Volumental account. See Volumental Connection Instructions.
• Publicly exposing your API credentials can allow unauthorized access to the Volumental API endpoints, and your Volumental data by a third party. DataGrail stores your API credentials encrypted and protected.

Endpoints Utilized

• Get and refresh access token:
  • POST https://api.volumental.dev/v1/auth
• Verify connection and access to the requested scopes:
  • GET https://api.volumental.dev/v1/{tenant}/profiles/{test_email}

Version

DataGrail Volumental integration currently supports stable version 1.0.

Limits

Volumental API access token is valid for 24 hours. The token should be stored and reused and not re-issued for every request: if too many tokens are issued in a 24 hours period, the account will be temporarily blocked.

DataGrail stores access token locally and uses Refresh Token flow to periodically update access token after it expires to keep the connection alive.

Access

For an access request, DataGrail will take the following actions:

• Retrieves a user profile by the Data Subject email.
• Select profiles and store visits objects.
• For all objects found, DataGrail will return all available fields. You can edit which objects and fields you want to provide to the Data Subject via our Portal Requests.

DataGrail also supports the Direct Contact Access workflow for Volumental.

Endpoints Utilized

• GET https://api.volumental.dev/v1/{tenant}/profiles/{data_subject_email}

Deletion

DataGrail supports the Direct Contact Deletion workflow for Volumental.