Arity

This documentation for the Arity integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Arity, visit our connection instructions.

Version

This integration utilizes the Arity Data Compliance API v1.

Base URL

The base URL used for all Arity API endpoints:

https://api.arity.com/data-compliance/v1

---

Authentication & Authorization

The DataGrail Arity integration connects using OAuth 2.0 with the following credentials: Client ID and Client Secret.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Arity API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	https://api.arity.com/platform/oauth/v1/token	Generate a B2B-scope access token using the client ID and client secret.

Scopes

The Arity integration requires specific scopes that must be granted in order to function for a given capability.

Scope	Base
b2b	✅

Base Scopes

All base scopes must be granted in order to connect the integration with DataGrail. The remaining scopes are only required if enabling those capabilities

Limits

Limits in Arity are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Deletion

DataGrail's Arity integration provides Asynchronous (Whole Record) Deletion capabilities for the following supported identifier category: User ID.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

1. Request user deletion using the User ID provided in the request.
2. Continuously check the status of the deletion request until it is complete.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/requests/request_id	Retrieve an existing user deletion request.
POST	/user-deletion-request	Create a new user deletion request.