ACE Connect - API

Your system places the order.

Submit a background check straight from your HR or applicant-tracking system. It follows the same package, searches, review, and report workflow as an order entered through the portal.

What the integration gives you

A small, accountable connection.

01

Three endpoints

List the packages, place an order, and check its status. There is nothing else to learn.

02

A person accepts before you are billed

An order sent by mistake can be rejected by ACE before it reaches a provider and before it costs anything.

03

Reports stay in the portal

A consumer report is not something to hand out on an API key, so it is collected by a signed-in user.

The contract

One order in. One order back.

The applicant, the package, and where to search. What returns is the order object your system polls until it is finished.

Request · POST /v1/orders
{
  "package": "Employment Background Screening",
  "first_name": "Jordan",
  "last_name": "Sample",
  "date_of_birth": "1987-05-15",
  "ssn": "123-45-6789",
  "address": "123 Example St, Canton, OH 44714",
  "reference": "HR-2026-0042",
  "jurisdictions": {
    "county_criminal_record": {
      "state": "OH",
      "county": "Stark"
    }
  }
}
Response · 201 Created
{
  "message": "Order received. It will be reviewed and accepted by ACE before searches are run.",
  "order": {
    "id": "01a0866b-5e58-730c-a8e5-1a5e911535eb",
    "number": "ACE-000562",
    "status": "pending_acceptance",
    "status_label": "Awaiting acceptance",
    "package": "Employment Background Screening",
    "subject": "Jordan Sample",
    "reference": "HR-2026-0042",
    "submitted_at": "2026-10-07T12:04:11+00:00",
    "completed_at": null,
    "documents": 0,
    "searches": []
  }
}

After you submit

Seven states. One clear order path.

An order reports one of these on every poll. Six run in sequence; rejected is the branch ACE takes when it cannot proceed.

01pending_acceptanceReceived. Waiting for ACE to accept it — no search has run, nothing is billed.

Nothing has been sent to a provider. An order submitted in error can still be rejected at no cost.

02newAccepted. Searches have not started.

The order is accepted and searches are now billable, whether or not they have started.

03processingSearches are running at the providers.

Providers are working and charges are already committed.

04under_reviewResults are in. ACE is reviewing each record.

No further charge is added while ACE decides what each record means.

05readyReview finished. The report is being produced.

No further charge is added unless a search is added during review.

06completedFinished. The report is available in the portal.

The final order is available in the portal and appears on the next invoice.

—rejectedACE could not proceed.

The order is not billed. ACE could not proceed and nothing was searched.

Live demonstration

Place a sample order and watch it move.

The sample uses the documented request and response shapes. It is a browser-only demonstration: no applicant information leaves this page, no search is run, and nothing is billed.

Request body
{
  "package": "Employment Background Screening",
  "first_name": "Jordan",
  "last_name": "Sample",
  "reference": "HR-2026-0042"
}
Response
{
  "status": "Awaiting request",
  "endpoint": "POST /v1/orders"
}

Order progress

  1. 01pending_acceptance
  2. 02new
  3. 03processing
  4. 04under_review
  5. 05ready
  6. 06completed

Sample order is waiting to be submitted.

API reference · Version 1

The whole contract.

JSON in, JSON out, over HTTPS. Three endpoints, one key, and a status to poll until the order is finished.

Productionhttps://clientportal.acebackgroundcheck.com/api/v1
Staginghttps://clientportal-dd.acebackgroundcheck.com/api/v1
AuthAuthorization: Bearer <key> or X-Api-Key: <key>
Rate limit120 requests per minute
GET/packages

What a client can order.

Read packages at integration time. The key for each search is what your system uses to send a jurisdiction.

POST/orders

Place an order.

A successful request returns 201 with pending_acceptance and an empty search list until ACE accepts it.

GET/orders/{id}

Check the order.

Poll while status is anything other than completed or rejected. Collect the final report through the signed-in portal.

Keys

One key per client system.

The key is shown once when created and stored only as a hash, so it can be replaced but never retrieved. Revoking takes effect immediately. Every accepted, rejected, or unauthorized call is recorded in the portal.

Errors

What can come back instead.

401 missing, unknown, or revoked key · 404 no such order on this account · 422 request understood but a field is wrong · 429 rate limit exceeded.

Before you build

Three limits worth knowing.

01

No duplicate detection

Submitting the same applicant twice creates two orders. Use your own reference to guard against duplicate submission.

02

Billing starts at acceptance

Searches are billable from the moment ACE accepts the order, not when it is submitted.

03

Numbers are redacted

Social Security numbers are stored encrypted and redacted in the intake log.