Blocked SSNs

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

List blocked SSNs

Retrieve a paginated list of blocked SSNs 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 SSNs

401

Unauthorized

404

Not Found

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


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


400
Bad Request


401
Unauthorized


422
Unprocessable Entity


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


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


 
Responses 
204
Blocked SSN was deleted successfully


401
Unauthorized


404
Not Found


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