Blocked Driver Licenses

Blocked driver licenses prevent reports from being processed for candidates with specific driver license numbers. If a report is created for one of your blocked driver licenses, it will automatically be canceled right away. This feature must be enabled for your account.
Each entry pairs a driver license number with its two-letter US state code.
Unlike blocked SSNs, blocked driver license numbers are returned in plaintext rather than masked.
Use this resource to manage the list of blocked driver licenses for your account.

List blocked driver licenses

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

401

Unauthorized

403

Forbidden

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


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


400
Bad Request


401
Unauthorized


403
Forbidden


422
Unprocessable Entity


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


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


 
Responses 
204
Blocked driver license was deleted successfully


401
Unauthorized


403
Forbidden


404
Not Found


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