Learn how to use the ATS API endpoints to retrieve identity envelopes.

Calling the ATS API

The Envelope API and Refresh Envelope API are both part of the same ATS API endpoint.

The API reference pages will help you generate the call to the respective endpoint for either creating a new envelope or refreshing an existing one.

Calling the Envelope API

Call the Envelope API with (hashed) identifiers to obtain an Identity Envelope.

Calling the Refresh Envelope API

To be GDPR and CCPA compliant, envelopes are generated with a TTL ("Time to Live" / expiration time).

To avoid passing expired envelopes that cannot be decrypted by Sidecar or other APIs, we recommend calling the Refresh Envelope API to reset the envelope expiration time to the maximum allowed value.


Refreshing envelopes is an important step to keep the match rate as high as possible for your users.