Authentication

ClearChecks uses HTTP Basic Authentication over HTTPS. Your private API token is securely encrypted by the SSL channel.

https://app.clearchecks.com/{ENDPOINT}/{PATH_PARAMETERS}/?api_token={API_TOKEN}
ACCEPT HEADER

ClearChecks API returns results as JSON. Your requests should always include the header requesting the results as JSON:

Accept: application/json
CONTENT-TYPE HEADER

When sending data to ClearChecks in a POST or PUT request, your request must specify the content type of your request:

Content-Type: application/json; charset=utf-8

HTTP response codes

Code Reason
200Success
201Success; created
429Too many requests
404Not Found – The specified resource could not be found.
500Server error

Order/report statuses

Value Description
A Applicant Information Requested by Email
P or R Pending Background Report
C Complete Background Report
V Pre-Adverse Notice Sent
X Final Adverse Notice Sent
GETGet account details

Returns account details.

/api/accounts

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/accounts/?api_token={API_TOKEN}' \ -H 'Accept: application/json'

Response:

{
    "first_name": "William",
    "last_name": "Hanna",
    "company_name": "Warner Bros. Cartoons",
    "city": "Greenwood Village",
    "state": "CA",
    "zip": "01010"
}
GETList teams

Returns teams of the account.

/api/accounts/teams

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/accounts/teams/?api_token={API_TOKEN}' \ -H 'Accept: application/json'

Response:

[
    {
        "id": 1,
        "owner_id": 1,
        "name": "George's Team",
        "slug": null,
        "photo_url": "https://www.gravatar.com/avatar/c02f03af326e6fef06f743f40d8a6714.jpg?s=200&d=identicon",
        "stripe_id": null,
        "current_billing_plan": null,
        "vat_id": null,
        "trial_ends_at": null,
        "created_at": "2018-11-06 21:03:42",
        "updated_at": "2018-12-31 16:06:30",
        "pivot": {
            "user_id": 1,
            "team_id": 1,
            "role": "owner"
        },
        "tax_rate": 0
    },
    {
        "id": 2,
        "owner_id": 2,
        "name": "Jane's Team",
        "slug": null,
        "photo_url": "https://www.gravatar.com/avatar/d3766fb34e720e8b515aedc0acf65461.jpg?s=200&d=identicon",
        "stripe_id": null,
        "current_billing_plan": null,
        "vat_id": null,
        "trial_ends_at": null,
        "created_at": null,
        "updated_at": null,
        "pivot": {
            "user_id": 1,
            "team_id": 2,
            "role": "member"
        },
        "tax_rate": 0
    }
]
GETGet billing details

Returns account billing.

/api/billing/info

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/billing/info/?api_token={API_TOKEN}' \ -H 'Accept: application/json'

Response:

{
    "account_cc4": "1234",
    "cc_month": 6,
    "cc_year": 2022,
    "card_type": "Visa",
    "first_name": "John",
    "last_name": "Doe",
    "address1": "5910 S University Blvd C18",
    "city": "Greenwood Village",
    "state": "CO",
    "zip": "80121"
}
PUTUpdate billing details

Updates account billing.

/api/billing/info

Body Parameters:

first_name:
required
string
last_name:
required
string
address1:
required
string
city:
required
string
state:
required
string
zip:
required
string
billing_card:
required
string
billing_month:
required
string
billing_year:
required
string
billing_cvv:
required
string

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/billing/info/?api_token={API_TOKEN}' \
  -X PUT \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'first_name=Jane&last_name=Jetson&address1=2001%20Skypad%20Way&city=Orbit%20City&state=CA&zip=01010&billing_card=1234567812345678&billing_month=12&billing_year=22&billing_cvv=123'

Response:

""
GETList invoices

Returns list of account invoices.

/api/invoices

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/invoices/?api_token={API_TOKEN}' \
  -H 'Accept: application/json'

Response:

[
    {
        "invoice_number": 12345,
        "address": {
            "address1": "5910 S University Blvd C18",
            "city": "Greenwood Village",
            "state": "CO",
            "zip": "80121",
            "country": "US"
        },
        "subtotal_in_cents": -3998,
        "due_on": {
            "date": "2019-01-31 20:44:58.000000",
            "timezone_type": 2,
            "timezone": "Z"
        },
        "tax_in_cents": -290,
        "total_in_cents": -4288,
        "currency": "USD",
        "created_at": {
            "date": "2019-01-31 20:44:58.000000",
            "timezone_type": 2,
            "timezone": "Z"
        },
        "tax_type": "usst",
        "tax_rate": 0.0725,
        "line_items": [
            {
                "description": "Refund for ClearHire Background Check",
                "unit_amount_in_cents": 1999,
                "tax_in_cents": -290,
                "total_in_cents": -4288,
                "currency": "USD",
                "tax_type": "usst",
                "tax_region": "CO",
                "tax_rate": 0.0725
            }
        ],
        "transactions": [
            {
                "action": "refund",
                "amount_in_cents": 4288,
                "tax_in_cents": 290,
                "currency": "USD",
                "status": "success",
                "payment_method": "credit_card"
            }
        ]
    },
    {
        "invoice_number": 12346,
        "address": {
            "address1": "5910 S University Blvd C18",
            "city": "Greenwood Village",
            "state": "CO",
            "zip": "80121",
            "country": "US"
        },
        "subtotal_in_cents": 3998,
        "due_on": {
            "date": "2019-01-31 20:34:42.000000",
            "timezone_type": 2,
            "timezone": "Z"
        },
        "tax_in_cents": 290,
        "total_in_cents": 4288,
        "currency": "USD",
        "created_at": {
            "date": "2019-01-31 20:34:42.000000",
            "timezone_type": 2,
            "timezone": "Z"
        },
        "customer_notes": "abc@test.com",
        "tax_type": "usst",
        "tax_rate": 0.0725,
        "line_items": [
            {
                "description": "ClearHire Background Check",
                "unit_amount_in_cents": 1999,
                "tax_in_cents": 290,
                "total_in_cents": 4288,
                "currency": "USD",
                "tax_type": "usst",
                "tax_region": "CO",
                "tax_rate": 0.0725
            }
        ],
        "transactions": [
            {
                "action": "purchase",
                "amount_in_cents": 4288,
                "tax_in_cents": 290,
                "currency": "USD",
                "status": "success",
                "payment_method": "credit_card"
            }
        ]
    }
]
GETGet invoice as PDF

Returns invoice in PDF format.

/api/invoices/{invoice_number}/pdf

Path Parameters:

invoice_number:
required
string
invoice_number identifier of the invoice.

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/invoices/123456/pdf?api_token={API_TOKEN}' \
  -H 'Accept: application/json'

Response:

""
GETList applicants

Returns list of applicants.

/api/applicants/{state}

Path Parameters:

state:
required
string
Allowed values: all, complete, pending, or inprogress

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/applicants/complete/?api_token={API_TOKEN}' \
  -H 'Accept: application/json'

Response:

{
    "current_page": 1,
    "data": [
        {
            "count": 1,
            "timestamp": "2019-01-16 16:07:26",
            "criminal_monitoring": "N",
            "report_status": "C",
            "applicant_email": "george@jetson.com",
            "drug_addon": "N",
            "email_status": "click",
            "report_description": "ClearHire Background Check",
            "report_key": "52678e019a5b6be5bcd33zz412377542",
            "applicant_firstname": "George",
            "applicant_lastname": "Jetson",
            "mvd_response": null,
            "status": "C",
            "background_status": null,
            "county_status": null,
            "drug_status": null,
            "mvd_status": null
        }
    ],
    "first_page_url": "https://app.clearchecks.com/api/applicants/complete?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://app.clearchecks.com/api/applicants/complete?page=1",
    "next_page_url": null,
    "path": "https://app.clearchecks.com/api/applicants/complete",
    "per_page": 20,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}
GETSearch applicants

Returns list of applicants filtered by a search query.

/api/applicants/search

Query Parameters:

api_token:
required
string
Your private API token.
searchString:
required
string
The value that will be used to search against applicant_email, applicant_firstname, and applicant_lastname.

Request:

curl 'https://app.clearchecks.com/api/applicants/search/?api_token={API_TOKEN}&searchString=jane' \
  -H 'Accept: application/json'

Response:

{
    "current_page": 1,
    "data": [
        {
            "count": 1,
            "timestamp": "2019-01-16 16:07:26",
            "criminal_monitoring": "N",
            "report_status": "A",
            "applicant_email": "jane@jetson.com",
            "drug_addon": "N",
            "email_status": "open",
            "report_description": "ClearHire Background Check",
            "report_key": "356ad6146104408c3bd3bab9bb06450c",
            "applicant_firstname": "Jane",
            "applicant_lastname": "Jetson",
            "mvd_response": null,
            "status": "A",
            "background_status": null,
            "county_status": null,
            "drug_status": null,
            "mvd_status": null
        }
    ],
    "first_page_url": "https://app.clearchecks.com/api/applicants/search?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://app.clearchecks.com/api/applicants/search?page=1",
    "next_page_url": null,
    "path": "https://app.clearchecks.com/api/applicants/search",
    "per_page": 20,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}
POSTCreate order

Create a new order.

/api/orders/new

Body Parameters:

report_sku:
required
string
Allowed values: EE4, EE5, EE6
drug_test:
required
string
Allowed values: Y, N
drug_sku:
required if drug_test = Y
string
Allowed values: drug, drug9, drug10
include_monitoring:
required
string
Allowed values: Y, N
order_quantity:
required
integer
Must equal # of applicant_emails
applicant_emails:
required
array
URL encode in post:
["george@yahoo.com", "astro@gmail.com"]
terms_agree:
required
string
Allowed values: Y, N

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/orders/new/?api_token={API_TOKEN}' \
  -X POST \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'report_sku=EE4&drug_test=Y&drug_sku=drug9&include_monitoring=N&order_quantity=1&terms_agree=Y&applicant_emails=%5B%22gjetson%40spacely.com%22%5D'

Response:

{
    "order created": "true",
    "account": "g2g91d441da13b32"
}
POSTUpdate order

Update details of an existing order.

/api/orders/{report_key}

Path Parameters:

report_key:
required
string
report_key identifier of the order.

Body Parameters:

applicant_email:
required
string
New applicant email to assign to an order.

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.app.clearchecks.com/api/orders/52678e019a5b6be5bcd33zz412377542/?api_token={API_TOKEN}'
  -X POST \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d applicant_email=home@jetson.com

Response:

{
    "report_key": "52678e019a5b6be5bcd33zz412377542",
    "message": "updated"
}
POSTAdd services to order

Add-on services to an existing order.

/api/report/{service}/{report_key}

Path Parameters:

service:
required
string
Allowed values: drugaddon, countyaddon
report_key:
required
string
report_key identifier of the order.

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/report/drugaddon/{API_TOKEN}' \
  -X POST \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded'

Response:

{
    "registration_id": "55678e019a5b4be5adw77aa908744321",
    "registration_number": "567231776"
}
GETList reports

Returns list of reports.

/api/reports/{state}

Path Parameters:

state:
required
string
Allowed values: all, pending, complete, adverse, or archived

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/reports/adverse/?api_token={API_TOKEN}' \
  -H 'Accept: application/json'

Response:

{
    "current_page": 1,
    "data": [
        {
            "timestamp": "2019-01-16 16:07:26",
            "report_key": "52678e019a5b6be5bcd33zz412377542",
            "applicant_email": "jane@jetson.com",
            "applicant_firstname": "Jane",
            "applicant_lastname": "Jetson",
            "report_sku": "EE4",
            "background_response": "",
            "mvd_response": null,
            "status": "V",
            "background_status": null,
            "county_status": null,
            "drug_status": null,
            "mvd_status": null,
            "archived": "N",
            "account_email": "account@clearchecks.com",
            "report_description": "ClearHire Background Check",
            "report_status": "C",
            "criminal_monitoring": "N",
            "drug_addon": "N"
        }
    ],
    "first_page_url": "https://app.clearchecks.com/api/reports/adverse?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://app.clearchecks.com/api/reports/adverse?page=1",
    "next_page_url": null,
    "path": "https://app.clearchecks.com/api/reports/adverse",
    "per_page": 20,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}
GETGet report status

Returns statuses of a report.

/api/status/{report_key}

Path Parameters:

report_key:
required
string
report_key identifier of the report.

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/status/52678e019a5b6be5bcd33zz412377542/?api_token={API_TOKEN}' \
  -H 'Accept: application/json'

Response:

{
    "status": "P",
    "reports": {
        "background_report": "C",
        "mvd_status": "P"
    }
}
GETGet report details

Returns details of a report.

/api/reports/{report_key}

Path Parameters:

report_key:
required
string
report_key identifier of the report.

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/reports/52678e019a5b6be5bcd33zz412377542/?api_token={API_TOKEN}' \
  -H 'Accept: application/json'

Response:

{
    "report_key": "52678e019a5b6be5bcd33zz412377542",
    "report_description": "ClearDriver Background Check",
    "report_sku": "EE3",
    "order_date": {
        "date": "2018-01-01 09:01",
        "timezone_type": 3,
        "timezone": "UTC"
    },
    "completed_date": {
        "date": "2018-01-03 17:01",
        "timezone_type": 3,
        "timezone": "UTC"
    },
    "status": "C",
    "archived": "N",
    "motor_vehicle": {
        "licenses": [
            {
                "license_number": "1001000",
                "license_class": "\n Class C Non-commercial Any Non Commercial Vehicle \n ",
                "license_type": "Personal",
                "license_status": "Valid",
                "state_issued": "CA",
                "issue_date": "2032-07-17",
                "exp_date": "2036-04-17",
                "first_name": "George",
                "middle_name": "J",
                "last_name": "Jetson",
                "address": "2001 Skypad Way Apt G",
                "city": "Orbit City ",
                "state": "CA"
            }
        ],
        "violations": [
            {
                "message": " Statecode: 3714a, Statedescription: Careless Driving, Incidentnum: 0, State: Pa ",
                "message_type": " Viol ",
                "violation_date": "2016-06-04",
                "conviction_date": "2016-08-11",
                "violation_acd": "M81"
            }
        ],
        "notes": [
            {
                "message": " Corrective Lenses ",
                "message_type": " REST "
            },
            {
                "message": " Statecode: 3362, Statedescription: Exceeding Maximum Speed, Incidentnum: 0 ",
                "message_type": " ACTION "
            }
        ]
    },
    "subject": {
        "first_name": "George",
        "middle_name": "J",
        "last_name": "Jetson",
        "ssn": "3837",
        "dob_month": "07",
        "dob_day": "01",
        "dob_year": "2022",
        "address": {
            "address1": "2001 Skypad Way APT G",
            "address2": "",
            "city": "Orbit City ",
            "state": "CA",
            "zipcode": ""
        }
    },
    "ssn_trace": {
        "message": "SSN IS PRESUMED TO BE VALID. Issued in CA ",
        "year": "2022-2023"
    },
    "address_history": {
        "count": "5",
        "addresses": [
            {
                "name": {
                    "first_name": "George",
                    "middle_name": "J",
                    "last_name": "Jetson"
                },
                "address": {
                    "street_number": "2001",
                    "street_name": "Skypad",
                    "street_suffix": "Way"
                },
                "city": "Orbit City",
                "state": "CA",
                "zipcode": "01010",
                "dob_match": {
                    "month": "07",
                    "day": "01",
                    "year": "2022"
                },
                "record_date": {
                    "first": "01-2044",
                    "last": "01-2045"
                }
            },
            {
                "name": {
                    "first_name": "George",
                    "middle_name": "J",
                    "last_name": "Jetson"
                },
                "address": {
                    "street_number": "5000",
                    "street_name": "Spacley",
                    "street_suffix": "Circle"
                },
                "city": "Orbit City",
                "state": "CA",
                "zipcode": "10100",
                "dob_match": {
                    "month": "07",
                    "day": "01",
                    "year": "2022"
                },
                "record_date": {
                    "first": "07-2044",
                    "last": "01-2045"
                }
            },
            {
                "name": {
                    "first_name": "George",
                    "last_name": "Jetson"
                },
                "address": {
                    "street_number": "2000",
                    "street_name": "Galaxy Way",
                    "street_suffix": "Way"
                },
                "city": "Orbit City",
                "state": "CA",
                "zipcode": "10100",
                "dob_match": {
                    "month": "04",
                    "day": "16",
                    "year": "2022"
                },
                "record_date": {
                    "first": "06-2044",
                    "last": "03-2045"
                }
            },
            {
                "name": {
                    "first_name": "George",
                    "middle_name": "A",
                    "last_name": "Jetson"
                },
                "address": {
                    "street_number": "2001",
                    "street_name": "Space",
                    "street_suffix": "Rd"
                },
                "city": "Pluto City",
                "state": "CA",
                "zipcode": "20100",
                "dob_match": {
                    "month": "04",
                    "day": "16",
                    "year": "2022"
                },
                "record_date": {
                    "first": "10-2042",
                    "last": "05-2044"
                }
            },
            {
                "name": {
                    "first_name": "George",
                    "last_name": "Jetson"
                },
                "address": {
                    "street_number": "1972",
                    "street_name": "Saturn",
                    "street_suffix": "Place"
                },
                "city": "Orbit City",
                "state": "CA",
                "zipcode": "15021",
                "dob_match": {
                    "month": "04",
                    "day": "16",
                    "year": "2022"
                },
                "record_date": {
                    "first": "07-2022",
                    "last": "04-2042"
                }
            }
        ]
    },
    "criminal_records": {
        "count": "2",
        "records": [
            {
                "first_name": "George",
                "last_name": "Jetson",
                "address": "",
                "city": "",
                "state": "",
                "zip": "",
                "dob_day": "16",
                "dob_month": "04",
                "dob_year": "2022",
                "jurisdiction": "CA AOC",
                "case_number": "CP-63-CR-0002801-2017/CALIFORNIA",
                "comments": "Case#: CA-63-CR-00034534/CALIFORNIA OTN#: T912345",
                "race": "WHITE",
                "hair_color": "",
                "eye_color": "UNKNOWN",
                "offenses": [
                    {
                        "jurisdictioncounty": "ORBIT CITY",
                        "jurisdictionstate": "CA",
                        "offensedescription": "Possession Of Controlled Subtance - 1st Off",
                        "offenseseverity": "MISDEMEANOR",
                        "disposition": "WAIVED FOR COURT (LOWER COURT)",
                        "casefilingdate": "09/24/2032"
                    },
                    {
                        "jurisdictioncounty": "ORBIT CITY",
                        "jurisdictionstate": "CA",
                        "offensedescription": "Possession Of Class 2 Cntl - 1st Off",
                        "offenseseverity": "MISDEMEANOR",
                        "disposition": "WAIVED FOR COURT (LOWER COURT)",
                        "casefilingdate": "09/24/2024"
                    }
                ]
            },
            {
                "first_name": "George",
                "last_name": "Jetson",
                "address": "",
                "city": "Orbit",
                "state": "CITY",
                "dob_day": "16",
                "dob_month": "04",
                "dob_year": "2042",
                "jurisdiction": "ORBIT CITY,CA",
                "case_number": "MJ-27306-CR-0000240-2017 CALI",
                "comments": "Case#: MJ-27306-CR-0000240-2017 ORBIT County OTN: T9762701 ORBIT WAY Court Office Code: MDJ-27-3-06",
                "race": "WHITE",
                "hair_color": "",
                "eye_color": "UNKNOWN",
                "offenses": [
                    {
                        "jurisdictioncounty": "ORBIT CITY",
                        "jurisdictionstate": "CA",
                        "offensedescription": "Disorderly Conduct - 1st Off",
                        "offenseseverity": "MISDEMEANOR",
                        "disposition": "WAIVED FOR COURT",
                        "dispositiondate": "11/03/2017",
                        "casefilingdate": "09/24/2034"
                    }
                ]
            }
        ]
    },
    "drug_test": {
        "donor": {
            "donor_id": "219373631",
            "donor_first_name": "George",
            "donor_last_name": "Jetson",
            "donor_middle_initial": "R",
            "donor_reason_for_test": "PE",
            "donor_ssn": "0123"
        },
        "test_results": [
            {
                "confirmCutoff": "000500",
                "resultQualitative": "N",
                "screeningCutoff": "1000",
                "drugId": "001000",
                "units": "ng/mL",
                "testName": "Amphetamines"
            },
            {
                "confirmCutoff": "000150",
                "resultQualitative": "N",
                "screeningCutoff": "300",
                "drugId": "003000",
                "units": "ng/mL",
                "testName": "Cocaine"
            },
            {
                "resultQualitative": "O",
                "resultQuantitative": "15.0",
                "drugId": "025000",
                "units": "mg/dL",
                "referenceInterval": ">= 20",
                "testName": "Creatinine"
            },
            {
                "confirmCutoff": "000015",
                "resultQualitative": "P",
                "screeningCutoff": "50",
                "drugId": "004000",
                "units": "ng/mL",
                "testName": "Marijuana Metab."
            },
            {
                "confirmCutoff": "002000",
                "resultQualitative": "N",
                "screeningCutoff": "2000",
                "drugId": "006000",
                "units": "ng/mL",
                "testName": "Opiates"
            },
            {
                "confirmCutoff": "000025",
                "resultQualitative": "N",
                "screeningCutoff": "25",
                "drugId": "007000",
                "units": "ng/mL",
                "testName": "PCP"
            },
            {
                "resultQualitative": "O",
                "resultQuantitative": "1.0020",
                "drugId": "027000",
                "referenceInterval": ">= 1.0030",
                "testName": "Specific Gravity"
            },
            {
                "resultQualitative": "I",
                "resultQuantitative": "6.2",
                "drugId": "026000",
                "referenceInterval": "4.5 - 8.9",
                "testName": "pH"
            }
        ],
        "collection_site": {
            "lab_name": "LabCorp",
            "site_id": "01010",
            "panel_id": "0270480001",
            "tempInRange": "1",
            "address1": "1000 Mars Way",
            "address3": "13-3757370",
            "city": "Orbit City",
            "state": "CA",
            "zip": "15136",
            "collector_name": "Alice Robot",
            "collector_phone": "4123310406",
            "specimen_id": "0232044411",
            "specimen_collection_date": "2018-03-14T15:03:00.000Z",
            "specimen_received_at_lab_date": "2018-03-15T20:57:00.000Z",
            "specimen_reported_from_lab": "2018-03-15T20:57:00.000Z"
        },
        "status": "C"
    }
}
POSTArchive report

Archive/unarchive an existing report.

/api/{archive_action}/{report_key}

Path Parameters:

archive_action:
required
string
Allowed values: archive, or unarchive
report_key:
required
string
report_key identifier of the report.

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/unarchive/52678e019a5b6be5bcd33zz412377542/?api_token={API_TOKEN}' \
  -X POST \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded'

Response:

"Report Un-Archived!"
GETList monitorings

Returns list of enrolled monitorings.

/api/reports/monitoring

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/reports/monitoring?api_token={API_TOKEN}' \
  -H 'Content-Type: application/json' 

Response:

{
    "current_page": 1,
    "data": [
        {
            "timestamp": "2019-01-08 22:56:56",
            "report_key": "52678e019a5b6be5bcd33zz412377542",
            "applicant_email": "george@jetson.com",
            "applicant_firstname": "George",
            "applicant_lastname": "Jetson",
            "report_sku": "EE5",
            "background_response": "",
            "mvd_response": null,
            "status": "C",
            "background_status": null,
            "county_status": null,
            "drug_status": null,
            "mvd_status": null,
            "archived": "N",
            "account_email": "account@clearchecks.com",
            "report_description": "ClearHire Complete Background Check",
            "report_status": "C",
            "criminal_monitoring": "Y",
            "drug_addon": "N"
        }
    ],
    "first_page_url": "https://app.clearchecks.com/api/reports/monitoring?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://app.clearchecks.com/api/reports/monitoring?page=1",
    "next_page_url": null,
    "path": "https://app.clearchecks.com/api/reports/monitoring",
    "per_page": 20,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}
POSTSend pre-adverse notice

/api/adverse/sendPreAdverse/{report_key}

Path Parameters:

report_key:
required
string
report_key identifier of the report.

Query Parameters:

api_token:
required
string
Your private API token.

Request:

curl 'https://app.clearchecks.com/api/adverse/sendPreAdverse/52678e019a5b6be5bcd33zz412377542/?api_token={API_TOKEN}' \
  -X POST \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded'

Response:

""
POSTSend final adverse notice

/api/adverse/sendFinalAdverse/{report_key}

Path Parameters:

report_key:
required
string
report_key identifier of the report.

Query Parameters:

api_token:
required
string
Your private API token.
curl 'https://app.clearchecks.com/api/adverse/sendFinalAdverse/52678e019a5b6be5bcd33zz412377542/?api_token={API_TOKEN}' \
  -X POST \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded'

Response:

""