Blocked Phones

Blocked phones prevent reports from being processed for candidates with specific phone numbers. If a report is created for one of your blocked phones, it will automatically be canceled right away. This feature must be enabled for your account.
Use this resource to manage the list of blocked phones for your account.

List blocked phones

Retrieve a paginated list of blocked phones for your account. See Pagination.

SecurityApiKey
Request
query Parameters
page
integer

The page number to retrieve.

per_page
integer

The maximum number of results per page.

Responses
200

List of blocked phones

401

Unauthorized

404

Not Found

get/blocked-phones
Request samples 
Response samples 
application/json
{
  • "object": "list",
  • "meta": {
    },
  • "data": [
    ]
}
Create a blocked phone
Add a phone number to the blocked list for your account. Reports created for candidates with a blocked phone will automatically be canceled right away.


SecurityApiKey 
Request 
Request Body schema: application/json
required
required
object
 
Responses 
201
Blocked phone was created successfully


400
Bad Request


401
Unauthorized


422
Unprocessable Entity


post/blocked-phones
Request samples 
application/json
{
  • "blocked_phone": {
    }
}
Response samples 
application/json
{
  • "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "phone": "+14155552671",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Delete a blocked phone
Remove a phone number from the blocked list for your account.
This won't impact any previously-canceled reports for that phone. It will allow processing of future reports created for that phone.


SecurityApiKey 
Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the blocked phone to delete.


 
Responses 
204
Blocked phone was deleted successfully


401
Unauthorized


404
Not Found


delete/blocked-phones/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Webhooks