Blocked emails prevent reports from being processed for candidates with specific email addresses. If a report is created for one of your blocked emails, it will automatically be canceled right away. This feature must be enabled for your account. Addresses are normalized before they are stored - surrounding whitespace is removed and the address is lowercased - so the value you receive back may differ in case from the one you submitted. Unlike blocked SSNs, blocked emails are returned in plaintext rather than masked. Use this resource to manage the list of blocked emails for your account.
Retrieve a paginated list of blocked emails for your account. See Pagination.
List of blocked emails
Unauthorized
Forbidden
{- "object": "list",
- "meta": {
- "page": 2,
- "per_page": 25,
- "total_count": 137,
- "total_pages": 6
}, - "data": [
- {
- "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
- "email": "candidate@example.com",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}Add an email address to the blocked list for your account. Reports created for candidates with a blocked email will automatically be canceled right away.
required | object |
Blocked email was created successfully
Bad Request
Unauthorized
Forbidden
Unprocessable Entity
{- "blocked_email": {
- "email": "candidate@example.com"
}
}{- "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
- "email": "candidate@example.com",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}Remove an email address from the blocked list for your account.This won't impact any previously-canceled reports for that email. It will allow processing of future reports created for that email.
Blocked email was deleted successfully
Unauthorized
Forbidden
Not Found
{- "errors": [
- "Not Authenticated"
]
}