Checkr Trust is a modern, RESTful API-driven service designed to enhance trust and safety for your platform. The Checkr Trust API uses resource-oriented URLs, supports HTTPS for authentication and requests, and returns JSON responses.
The Checkr Trust API provides access to a rich set of data, including criminal records, traffic infractions, and registry checks. Once credentialed, you can start testing locally in minutes. For additional resources, please refer to our resource center. This documentation aims to help you quickly utilize Checkr Trust’s services, offering context and technical guidance for working with the API.
Important: Checkr Trust is not a “consumer reporting agency” or otherwise a producer of “consumer reports,” as those terms are defined in the Fair Credit Reporting Act (“FCRA”). Checkr Trust data must not be accessed, obtained, disclosed, or otherwise used to make any decisions related to credit, insurance, employment, or any other purposes described in 15 U.S.C. § 1681b of FCRA
The following sections will guide you through the steps necessary to start running checks with the Checkr Trust API:
Before you can request data from this API, you must first work with a Checkr Trust Account Executive or Customer Success representative to set up and credential your account.
Best practices for securing your API credentials:
Your API key can be used to make any API call on behalf of your account, such as creating profiles and checks. Currently, your API key has unlimited access and must be secured accordingly. Checkr Trust will provide you with your Client Key and Secret Key, which can be exchanged for an access token via OAuth. The generated access tokens expire in 24 hours if not refreshed. Below is a step-by-step guide.
OAuth 2.0 is an authorization framework that allows applications to obtain access to a HTTP service. User authentication is delegated to the service that hosts the user account, while third-party applications are authorized to access the user account.
Before you start, register your application with the Authorization Server to obtain your client_id and client_secret.
Make a POST request to the token endpoint with your client_id and client_secret in the body.
$ curl --location 'https://api.checkrtrust.com/v1/accounts/token' \
--header 'Content-Type: application/json' \
--data '{
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET"
}'
If the request is successful, the Authorization Server responds with an access token, scopes, expiration time, and token type.
{
"access_token": "eyJhb...(something long)...qJFlg",
"scope": "read:account create:account delete:account",
"expires_in": 86400,
"token_type": "Bearer"
}
If the request fails, the Authorization Server responds with an error message.
{
"error": "access_denied",
"error_description": "Unauthorized"
}
Include the access token in the Authorization header when making requests to the Resource Server.
curl --location 'https://api.checkrtrust.com/v1/checks' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--data '{
"first_name": "John",
"last_name": "Smith",
"dob": "19880218"
}'
If any step in the OAuth 2.0 flow encounters an error, the Authorization Server returns an error response. These errors can include invalid requests, invalid clients, and invalid grants.
Our API uses webhooks to notify your application about asynchronous events, primarily when certain checks or verifications are completed. This allows you to receive results without needing to poll our API continuously.
Currently, webhook endpoints must be configured by your Checkr Trust Account Executive. Please contact them to set up or update the URL where you wish to receive webhook events and to provide your shared secret key for signature verification (if desired).
Receiving results for driver_checks
(both driver_license_status
and motor_vehicle_report
) requires a configured webhook endpoint.
The results are delivered asynchronously via a webhook payload once the check/verification is complete. See the specific event schemas defined under the callbacks for the respective POST operations:
POST /driver_checks
: driver-license-status-completed-event-body
, motor-vehicle-report-completed-event-body
To ensure the integrity and authenticity of webhook payloads, we offer optional payload signing using HMAC-SHA256. This is highly recommended for securing your webhook endpoint.
How it Works:
X-Checkr-Signature
header with the value sha256={signature}
Verifying the Signature (Recommended): You should verify this signature on your end to confirm that the payload was sent by Checkr Trust and hasn't been tampered with.
Verification Steps:
X-Checkr-Signature
(or the specific header name provided to you) header of the incoming request.Code Examples for Verification:
Ruby:
require 'openssl'
# For secure_compare, typically available in Rails/ActiveSupport
require 'active_support/security_utils'
# Assuming 'request' is your HTTP request object
# and 'SIGNATURE_KEY' is your shared secret
provided_signature = request.headers['X-Checkr-Signature']&.split('=')&.last
raise 'signature missing' unless provided_signature
# Ensure you get the raw body, not parsed JSON
payload_body = request.raw_post
expected_signature = OpenSSL::HMAC.hexdigest('SHA256', SIGNATURE_KEY, payload_body)
# Use secure_compare for timing-attack resistance
is_valid = ActiveSupport::SecurityUtils.secure_compare(provided_signature, expected_signature)
if is_valid
# Signature is valid, process the webhook payload
puts "Webhook signature verified."
else
# Signature is invalid, reject the request
puts "Webhook signature verification failed."
# Return an appropriate error response (e.g., 401 Unauthorized)
end
Our system will attempt to deliver webhook events to your configured endpoint. If your endpoint returns a non-2xx status code (e.g., 4xx, 5xx) or fails to respond within a reasonable timeout, we will retry sending that event. We retry up to 25 times with exponential time backoff (e.g. after 15 seconds, 16 seconds, 30 seconds, 90 seconds, etc) for a total period of around 20 days.
It is crucial that your endpoint:
200 OK
status upon successful receipt of the request (ideally before performing complex processing).Profiles represent a set of Personally Identifiable Information (PII) for a person who will be checked. Profiles can be updated with the latest information for a person and be referenced to generate checks.
Checks provide the resulting information relevant to the requested check for a set of PII. The response will include the check type and results.
Creates a new check resource.
Required Fields
The required attributes for a check resource vary depending on its intended use. Each check requires a minimum set of attributes. You can pass through the minimum set of PII or a profile_id to reference the profile’s PII. If both parameters are passed, the PII from the profile will take precedence. If the PII is insufficient for a check, a validation error will return a 401 Bad Request.
Fields required to generate an Instant Criminal Check
include:
first_name
last_name
Although dob (date of birth) is encouraged, it is not required. Searches without dob will give back results that are matched by name only, which may be false positives.
Synchronous responses for a check and GET requests for a check both contain the same information about the results of the check. A completed check with empty results indicates that there are no items on the person’s record for review. Results that are populated indicate items on the check that may require review. Results may not be used to determine eligibility for credit, insurance, employment, or any other purpose regulated under the FCRA. Additionally, Checkr Trust does not make any policy decisions on behalf of its customers.
Driver checks provide the resulting information relevant to the requested driver license. The response will include the driver check type and results.
Creates a new Driver Check.
Required Fields
The required attributes for a driver check vary depending on its intended use. You can pass through the minimum set of PII or a profile_id to reference the profile’s PII. If both parameters are passed, the PII from the profile will take precedence. If the PII is insufficient for a driver check, a validation error will return a 401 Bad Request.
Fields required to generate a Driver Check
include:
first_name
last_name
dob
driver_license_number
driver_license_state
Asynchronous responses for a Driver Check and GET requests for a Driver Check both contain the same information about the results. You must expose a Webhook endpoint on your end to receive Driver Check completion events. Please work with a Checkr Trust Account Executive or Customer Success representative to set up this Webhook endpoint on your account. Additionally, Checkr Trust does not make any policy decisions on behalf of its customers.
Identity Verifications provide the resulting information relevant to the requested verification for a set of PII. The response will include the IDV type and results.
Creates a new Identity Verification resource.
Required Fields
The required attributes for an Identity Verification resource vary depending on its intended use. You can pass through the minimum set of PII or a profile_id to reference the profile’s PII. If both parameters are passed, the PII from the profile will take precedence. If the PII is insufficient for a verification, a validation error will return a 401 Bad Request.
Fields required to generate an Identity Verification
include:
first_name
last_name
idv_type
email, phone, dob
or address
Identity Verifications of idv_type
pii_validation
use synchronous responses. Responses for POST and GET requests for an Identity Verification both contain the same information about the results. A completed Identity Verification will provide match scores for each attribute provided (first name, last name, email, phone, etc); and an overall match score.
Identity Verifications of idv_type
document_verification
use asynchronous responses. The POST request contains an initial payload with the collection_link
to provide to your end user; they use the web application at that link on a mobile device to provide the documents we will verify. You must expose a Webhook endpoint to receive the completed document verification, which contains the same information and results as a GET request once the request is completed. Please work with a Checkr Trust Account Executive or Customer Success representative to set up this Webhook endpoint on your account.
Additionally, Checkr Trust does not make any policy decisions on behalf of its customers.
Endpoints and operations having to do with accounts and authorization. Account creation and credentialing will be done with a Checkr Trust team member.
Get a bearer token which will allow you to access the other endpoints in this API
OK - success response from create token
Unauthorized - not allowed to response from create token
{- "client_id": "string",
- "client_secret": "string"
}
{- "access_token": "eyJhb...(something long)...qJFlg",
- "scope": "read:account create:account delete:account",
- "expires_in": 86400,
- "token_type": "Bearer"
}
Checks provide the resulting information relevant to the requested check for a set of PII. Checks will include the Check type and results.
Get a set of checks
OK
Bad Request
Unauthorized
Internal Server Error
[- {
- "id": "5bb1242f-6963-4886-8f05-9ee965da2ca1",
- "created_at": "2024-06-15 00:03:49.588",
- "completed_at": "2024-06-15 00:03:49.588",
- "results": [
- {
- "category": "Criminal/traffic",
- "person": {
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "suffix": "string",
- "full_name": "string",
- "dob": "19950401",
- "gender": "string",
- "height": "string",
- "weight": "string",
- "hair_color": "string",
- "eye_color": "string",
- "skin_color": "string",
- "race": "string",
- "ethnicity": "string",
- "physical_build": "string",
- "physical_marks": "string",
- "photo_urls": [
- "string"
], - "name_aliases": [
- "string"
], - "dob_aliases": [
- "string"
], - "addresses": [
- {
- "street": "123 Main St",
- "city": "San Francisco",
- "state": "KY",
- "zip_code": "12345",
- "country": "US"
}
]
}, - "cases": [
- {
- "case_number": "string",
- "type": "string",
- "status": "string",
- "file_date": "19950401",
- "arresting_agency": "string",
- "arrest_date": "19950401",
- "court_name": "string",
- "court_county": "string",
- "charges": [
- {
- "description": null,
- "offense_date": null,
- "legal_code": null,
- "type": null,
- "category": null,
- "subcategory": null,
- "subsubcategory": null,
- "city": null,
- "county": null,
- "state": null,
- "sentences": [ ],
- "dispositions": [ ]
}
]
}
], - "source": {
- "id": "string",
- "category": "court",
- "name": "string",
- "county": "string",
- "state": "KY"
}
}
], - "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
- "check_type": "instant_criminal",
- "reference_id": "AB245"
}
]
Create a new check
the request to create a check
Created
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "first_name": "JOHN",
- "last_name": "SMITH",
- "dob": "19900101"
}
{- "id": "5bb1242f-6963-4886-8f05-9ee965da2ca1",
- "created_at": "2024-06-15 00:03:49.588",
- "completed_at": "2024-06-15 00:03:49.588",
- "results": [
- {
- "category": "Criminal/traffic",
- "person": {
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "suffix": "string",
- "full_name": "string",
- "dob": "19950401",
- "gender": "string",
- "height": "string",
- "weight": "string",
- "hair_color": "string",
- "eye_color": "string",
- "skin_color": "string",
- "race": "string",
- "ethnicity": "string",
- "physical_build": "string",
- "physical_marks": "string",
- "photo_urls": [
- "string"
], - "name_aliases": [
- "string"
], - "dob_aliases": [
- "string"
], - "addresses": [
- {
- "street": "123 Main St",
- "city": "San Francisco",
- "state": "KY",
- "zip_code": "12345",
- "country": "US"
}
]
}, - "cases": [
- {
- "case_number": "string",
- "type": "string",
- "status": "string",
- "file_date": "19950401",
- "arresting_agency": "string",
- "arrest_date": "19950401",
- "court_name": "string",
- "court_county": "string",
- "charges": [
- {
- "description": "string",
- "offense_date": "19950401",
- "legal_code": "string",
- "type": "felony",
- "category": "Criminal Intent",
- "subcategory": "Accessory",
- "subsubcategory": "Accessory",
- "city": "string",
- "county": "string",
- "state": "string",
- "sentences": [
- null
], - "dispositions": [
- null
]
}
]
}
], - "source": {
- "id": "string",
- "category": "court",
- "name": "string",
- "county": "string",
- "state": "KY"
}
}
], - "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
- "check_type": "instant_criminal",
- "reference_id": "AB245"
}
Get a single check with a given id
OK
Unauthorized
Not Found
Internal Server Error
{- "id": "5bb1242f-6963-4886-8f05-9ee965da2ca1",
- "created_at": "2024-06-15 00:03:49.588",
- "completed_at": "2024-06-15 00:03:49.588",
- "results": [
- {
- "category": "Criminal/traffic",
- "person": {
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "suffix": "string",
- "full_name": "string",
- "dob": "19950401",
- "gender": "string",
- "height": "string",
- "weight": "string",
- "hair_color": "string",
- "eye_color": "string",
- "skin_color": "string",
- "race": "string",
- "ethnicity": "string",
- "physical_build": "string",
- "physical_marks": "string",
- "photo_urls": [
- "string"
], - "name_aliases": [
- "string"
], - "dob_aliases": [
- "string"
], - "addresses": [
- {
- "street": "123 Main St",
- "city": "San Francisco",
- "state": "KY",
- "zip_code": "12345",
- "country": "US"
}
]
}, - "cases": [
- {
- "case_number": "string",
- "type": "string",
- "status": "string",
- "file_date": "19950401",
- "arresting_agency": "string",
- "arrest_date": "19950401",
- "court_name": "string",
- "court_county": "string",
- "charges": [
- {
- "description": "string",
- "offense_date": "19950401",
- "legal_code": "string",
- "type": "felony",
- "category": "Criminal Intent",
- "subcategory": "Accessory",
- "subsubcategory": "Accessory",
- "city": "string",
- "county": "string",
- "state": "string",
- "sentences": [
- null
], - "dispositions": [
- null
]
}
]
}
], - "source": {
- "id": "string",
- "category": "court",
- "name": "string",
- "county": "string",
- "state": "KY"
}
}
], - "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
- "check_type": "instant_criminal",
- "reference_id": "AB245"
}
Driver Checks provide the resulting information relevant to the requested driver license. The response will include the driver check type and results.
Get a set of driver checks
OK
Bad Request
Unauthorized
Conflict
Internal Server Error
[- [
- {
- "id": "f9b62bbd-92ae-4fa6-b969-as0058266a11",
- "created_at": "2025-01-07T16:46:09.307Z",
- "completed_at": "2025-01-07T16:46:15.454Z",
- "results": {
- "order_details": {
- "result_code": "FOUND"
}, - "licenses": [
- {
- "type": "PASSENGER",
- "validity": "VALID",
- "jurisdiction": "NY",
- "number": "608712355",
- "class_code": "*D*",
- "class_description": "*D*",
- "status_code": "VALID",
- "status_description": "VALID",
- "issued_on": "",
- "expires_on": "2027-02-14"
}
]
}, - "profile_id": "16be7356-3e1a-413b-96a2-722213dce679",
- "check_type": "driver_license_status"
}, - {
- "id": "a5eb5e1b-4996-49ee-9a55-f089bc1b3319",
- "created_at": "2025-01-07T16:44:24.974Z",
- "completed_at": "2025-01-07T16:44:34.221Z",
- "results": {
- "order_details": {
- "result_code": "FOUND"
}, - "driver_information": {
- "date_of_birth": "1944-02-14",
- "license": {
- "number": "608712355",
- "jurisdiction": "NY"
}, - "name": {
- "first": "PAUL",
- "middle": "SAL",
- "last": "NACHOS",
- "suffix": "",
- "raw": ""
}
}, - "licenses": [
- {
- "type": "PASSENGER",
- "subtype": "",
- "validity": "VALID",
- "jurisdiction": "NY",
- "number": "608717225",
- "class_code": "*D*",
- "class_description": "*D*",
- "status_code": "VALID",
- "status_description": "VALID",
- "issued_on": "",
- "expires_on": "2027-02-14",
- "restrictions": [ ],
- "comments": [
- "CLASS CHANGE: 02/14/1994 NEW: *E* OLD: *4*"
]
}
], - "miscellaneous": [
- {
- "date": "",
- "description": "StateSpecificInfo",
- "comments": [
- "MI #: Z01086 47523 281220-44",
- "NAME ON LICENSE/ID: NACHOS",
- "PAUL,SAL"
]
}
]
}, - "profile_id": "41a9b942-12f4-41fc-a724-3341f9b1a07a",
- "check_type": "motor_vehicle_report"
}
]
]
Create a new driver check
the request to create a driver check
the request to create a new driver check from set of PII
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "check_type": "motor_vehicle_report",
- "first_name": "JOHN",
- "last_name": "SMITH",
- "dob": "19900101",
- "driver_license_number": "A1234567",
- "driver_license_state": "CA"
}
{- "id": "5bb1242f-6963-4886-8f05-9ee965da2ca1",
- "created_at": "2024-06-15 00:03:49.588",
- "completed_at": "2024-06-15 00:03:49.588",
- "results": {
- "order_details": {
- "result_code": "FOUND"
}, - "licenses": [
- {
- "type": "PASSENGER",
- "validity": "VALID",
- "jurisdiction": "string",
- "number": "string",
- "class_code": "string",
- "class_description": "string",
- "status_code": "string",
- "status_description": "string",
- "issued_on": "2024-06-15 00:03:49.588",
- "expires_on": "2024-06-15 00:03:49.588"
}
]
}, - "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
- "check_type": "driver_license_status"
}
{- "id": "5bb1242f-6963-4886-8f05-9ee965da2ca1",
- "object": "event",
- "type": "driver_license_status.completed",
- "created_at": "2024-06-15 00:03:49.588",
- "data": {
- "id": "5bb1242f-6963-4886-8f05-9ee965da2ca1",
- "created_at": "2024-06-15 00:03:49.588",
- "completed_at": "2024-06-15 00:03:49.588",
- "results": {
- "order_details": {
- "result_code": "FOUND"
}, - "licenses": [
- {
- "type": "PASSENGER",
- "validity": "VALID",
- "jurisdiction": "string",
- "number": "string",
- "class_code": "string",
- "class_description": "string",
- "status_code": "string",
- "status_description": "string",
- "issued_on": "2024-06-15 00:03:49.588",
- "expires_on": "2024-06-15 00:03:49.588"
}
]
}, - "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
- "check_type": "driver_license_status"
}, - "account_id": "5bb1242f-6963-4886-8f05-9ee965da2ca1"
}
Get a single driver check with a given id
OK
Unauthorized
Not Found
Internal Server Error
{- "id": "5bb1242f-6963-4886-8f05-9ee965da2ca1",
- "created_at": "2024-06-15 00:03:49.588",
- "completed_at": "2024-06-15 00:03:49.588",
- "results": {
- "order_details": {
- "result_code": "FOUND"
}, - "licenses": [
- {
- "type": "PASSENGER",
- "validity": "VALID",
- "jurisdiction": "string",
- "number": "string",
- "class_code": "string",
- "class_description": "string",
- "status_code": "string",
- "status_description": "string",
- "issued_on": "2024-06-15 00:03:49.588",
- "expires_on": "2024-06-15 00:03:49.588"
}
]
}, - "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
- "check_type": "driver_license_status"
}
Identity Verifications provide the resulting information relevant to the requested verification for a set of PII. The response will include the IDV type and results.
Get a set of identity verifications
OK
Bad Request
Unauthorized
Internal Server Error
[- {
- "id": "5bb1242f-6963-4886-8f05-9ee965da2ca1",
- "created_at": "2024-06-15 00:03:49.588",
- "completed_at": "2024-06-15 00:03:49.588",
- "results": {
- "attribute_match_scores": {
- "first_name": 100,
- "last_name": 100,
- "dob": 100,
- "phone": 100,
- "email": 0,
- "address": 100,
- "city": 100,
- "state": 100,
- "zip_code": 100,
- "ssn": 0
}, - "overall_match_score": 50,
- "result_context": [
- "Address was fuzzy matched to the address on record"
]
}, - "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
- "idv_type": "pii_validation",
- "reference_id": "AB245"
}
]
Create a new identity verification
the request to create an identity verification
the request to create a new identity verification from set of PII
The object must have DOB.
Created
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "first_name": "JOHN",
- "last_name": "SMITH",
- "idv_type": "pii_validation",
- "email": "j.doe@example.com"
}
{- "id": "5bb1242f-6963-4886-8f05-9ee965da2ca1",
- "created_at": "2024-06-15 00:03:49.588",
- "results": {
- "attribute_match_scores": {
- "first_name": 100,
- "last_name": 100,
- "dob": 100,
- "phone": 100,
- "email": 0,
- "address": 100,
- "city": 100,
- "state": 100,
- "zip_code": 100,
- "ssn": 0
}, - "overall_match_score": 50,
- "result_context": [
- "Address was fuzzy matched to the address on record"
]
}, - "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
- "idv_type": "pii_validation",
- "reference_id": "AB245"
}
{- "id": "5bb1242f-6963-4886-8f05-9ee965da2ca1",
- "object": "event",
- "type": "document_verification.completed",
- "created_at": "2024-06-15 00:03:49.588",
- "data": {
- "id": "5bb1242f-6963-4886-8f05-9ee965da2ca1",
- "created_at": "2024-06-15 00:03:49.588",
- "completed_at": "2024-06-15 00:03:49.588",
- "results": {
- "status": "complete",
- "result": "accept",
- "errors": [ ],
- "result_context": [
- "High-confidence match between the email and first name",
- "Document number extracted from document correlates with input number"
], - "document_type": {
- "type": "Drivers License",
- "country": "USA",
- "state": "CO"
}, - "document_data": {
- "first_name": "Dwayne",
- "sur_name": "Denver",
- "full_name": "Dwayne Denver",
- "address": "123 Example Street, New York City, NY 10001",
- "parsed_address": {
- "physical_address": "123 Example Street",
- "physical_address2": "Suite 200",
- "city": "New York City",
- "state": "NY",
- "country": "USA",
- "zip": 10001
}, - "document_number": 0,
- "dob": "2000-01-01",
- "issue_date": "2020-01-01",
- "expiration_date": "2027-01-01"
}
}, - "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
- "idv_type": "document_verification",
- "reference_id": "AB245"
}, - "account_id": "5bb1242f-6963-4886-8f05-9ee965da2ca1"
}
Get a single identity verification with a given id
OK
Unauthorized
Not Found
Internal Server Error
{- "id": "5bb1242f-6963-4886-8f05-9ee965da2ca1",
- "created_at": "2024-06-15 00:03:49.588",
- "completed_at": "2024-06-15 00:03:49.588",
- "results": {
- "attribute_match_scores": {
- "first_name": 100,
- "last_name": 100,
- "dob": 100,
- "phone": 100,
- "email": 0,
- "address": 100,
- "city": 100,
- "state": 100,
- "zip_code": 100,
- "ssn": 0
}, - "overall_match_score": 50,
- "result_context": [
- "Address was fuzzy matched to the address on record"
]
}, - "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
- "idv_type": "pii_validation",
- "reference_id": "AB245"
}
Profiles represent a set of Personally Identifiable Information (PII) for a person who will be checked. Profiles can be updated with the latest information for a person and be referenced to generate checks.
The required attributes for a Profile resource vary depending on its intended use. Each check will require a minimum set of attributes.
Get a set of profiles
OK
Bad Request
Unauthorized
Internal Server Error
[- {
- "id": "f43dd5e8-5f34-4366-b9e4-722cd54266ad",
- "first_name": "John",
- "middle_name": "William",
- "last_name": "Smith",
- "zip_code": "12345",
- "dob": "19950401",
- "phone": "+14155551212",
- "email": "j.doe@example.com",
- "driver_license_number": "string",
- "driver_license_state": "string",
- "address": {
- "street": "123 Main St",
- "city": "San Francisco",
- "state": "KY",
- "zip_code": "12345",
- "country": "US"
}, - "custom_id": "ABC-123",
- "check_ids": [
- "5bb1242f-6963-4886-8f05-9ee965da2ca1"
]
}
]
Creates a new profile resource
Required Fields
The required attributes for a Profile resource vary depending on its intended use. Each check will require a minimum set of attributes as shared below:
Fields required to generate an Instant Criminal Check
include:
first_name
last_name
Date of birth (dob) is strongly suggested, as name-only searches will likely provide data on many differernt people with the same name.
Validation for these attributes is performed when requesting a check, as the requirements depend on the check type.
the request to create a profile
Created
Bad Request
Unauthorized
Internal Server Error
{- "first_name": "John",
- "middle_name": "William",
- "last_name": "Smith",
- "zip_code": "12345",
- "dob": "19950401",
- "phone": "+14155551212",
- "email": "j.doe@example.com",
- "driver_license_number": "string",
- "driver_license_state": "string",
- "address": {
- "street": "123 Main St",
- "city": "San Francisco",
- "state": "KY",
- "zip_code": "12345",
- "country": "US"
}, - "custom_id": "ABC-123"
}
{- "id": "f43dd5e8-5f34-4366-b9e4-722cd54266ad",
- "first_name": "John",
- "middle_name": "William",
- "last_name": "Smith",
- "zip_code": "12345",
- "dob": "19950401",
- "phone": "+14155551212",
- "email": "j.doe@example.com",
- "driver_license_number": "string",
- "driver_license_state": "string",
- "address": {
- "street": "123 Main St",
- "city": "San Francisco",
- "state": "KY",
- "zip_code": "12345",
- "country": "US"
}, - "custom_id": "ABC-123"
}
Get a single profile by id
OK
Bad Request
Unauthorized
Not Found
Internal Server Error
{- "id": "f43dd5e8-5f34-4366-b9e4-722cd54266ad",
- "first_name": "John",
- "middle_name": "William",
- "last_name": "Smith",
- "zip_code": "12345",
- "dob": "19950401",
- "phone": "+14155551212",
- "email": "j.doe@example.com",
- "driver_license_number": "string",
- "driver_license_state": "string",
- "address": {
- "street": "123 Main St",
- "city": "San Francisco",
- "state": "KY",
- "zip_code": "12345",
- "country": "US"
}, - "custom_id": "ABC-123",
- "check_ids": [
- "5bb1242f-6963-4886-8f05-9ee965da2ca1"
]
}
Update a profile with a given id
the request to patch (modify) a profile
OK
Bad Request
Unauthorized
Not Found
Internal Server Error
{- "first_name": "John",
- "middle_name": "William",
- "last_name": "Smith",
- "zip_code": "12345",
- "dob": "19950401",
- "phone": "+14155551212",
- "email": "j.doe@example.com",
- "driver_license_number": "string",
- "driver_license_state": "string",
- "address": {
- "street": "123 Main St",
- "city": "San Francisco",
- "state": "KY",
- "zip_code": "12345",
- "country": "US"
}, - "custom_id": "ABC-123"
}
{- "id": "f43dd5e8-5f34-4366-b9e4-722cd54266ad",
- "first_name": "John",
- "middle_name": "William",
- "last_name": "Smith",
- "zip_code": "12345",
- "dob": "19950401",
- "phone": "+14155551212",
- "email": "j.doe@example.com",
- "driver_license_number": "string",
- "driver_license_state": "string",
- "address": {
- "street": "123 Main St",
- "city": "San Francisco",
- "state": "KY",
- "zip_code": "12345",
- "country": "US"
}, - "custom_id": "ABC-123"
}