Getting the deny list

To get your current deny list, make a GET request to:

https://auth.privy.io/api/v1/apps/<your-privy-app-id>/denylist

This is a paginated query, and the API will return up to 1000 deny list entries for a single request.

Parameters

In the request query parameters, specify the following fields:

• cursor (optional)
  • When you request a batch of deny list entries from Privy, the API will return a cursor for the next batch of deny list entries in the next_cursor field of the response. This will be a deny list ID, which is a string.
  • If you are requesting the first batch of deny list entries for your app, do not include a cursor in your request parameters.
  • If you have already requested a batch of deny list entries and want to request the next batch, set the cursor in your request parameters to be the next_cursor returned by the API in your previous query. If the provided cursor is not a valid deny list ID, the API will return an error.
• limit (optional): The number of users you would like the API to return. Defaults to 1000.

As an example, to get the first 1000 deny list entries for your app, you should include no URL query parameters:

curl --request GET https://auth.privy.io/api/v1/apps/<your-privy-app-id>/denylist \
-u "<your-privy-app-id>:<your-privy-app-secret>" \
-H "privy-app-id: <your-privy-app-id>"

Then, to get the next 1000 deny list entries for your app, you should pass the next_cursor field of the last response as the cursor in your request query parameters:

# Replace <insert-cursor> below with the `next_cursor` returned by the last query
curl --request GET https://auth.privy.io/api/v1/apps/<your-privy-app-id>/denylist?cursor=<insert-cursor> \
-u "<your-privy-app-id>:<your-privy-app-secret>" \
-H "privy-app-id: <your-privy-app-id>"

Response

A successful response will include:

• data: the deny list entries as an array
• next_cursor: the cursor to be used in your next request to this API

Below is an example:

{
  "data": [
    {
        "id": "denylist-entry-ID1",
        "rule_type": "email",
        "value": "user@email.com"
    },
    {
        "id": "denylist-entry-ID2",
        "rule_type": "emailDomain",
        "value": "email.com"
    },
    ...
  ],
  "next_cursor": "denylist-entry-ID2"
}

If you need to remove an entry from your deny list, you will need the id field returned in this API response.