Send files. Receive scores, bands and reports. The models never leave the house.

The connector is a small web service. Each call carries your files and a few settings, runs one job and returns the finished deliverables with a record of what was sent and what came back.

One key, one job per call, one synchronous answer.

1. 1.Criterica issues a key for your connection. Send it on every call in the header X-Criterica-Key. The key is tied to your organization and to the job types connected to it.
2. 2.Send one job per call as multipart form data: your files under the field names for that job type, and settings as form fields. Anything not listed for the job type is rejected.
3. 3.Every call is synchronous. A job takes seconds to about a minute and returns the finished job.
4. 4.A successful call returns the job id, the status, the outputs (name, sha256, page count, download path), the method version that produced them and your usage for that job type this quarter.
5. 5.Every call is recorded. Results are visible only to the key that requested them.

Five calls.

Uploads are limited to 50 MB per call, one job per call. Dates are written YYYY-MM-DD.

A file that fails the intake check is not run.

The call returns status 422 with the problems in plain words, for example missing columns: law_firm or resolved_date: 3 rows are blank or not a date (use YYYY-MM-DD). Fix the file and send it again. Rejected files are not billed.

{
  "job_id": "<job id>",
  "status": "rejected",
  "problems": ["missing columns: law_firm"],
  "method_version": "<method version>"
}

Every call leaves a record you can check.

For each job the record holds the job id, your key id, the job type, when it was received, the names, sizes and sha256 of every file you sent, the settings used, the outcome (rejected, done or failed), the problems if any, the name, sha256 and page count of every deliverable, the method version, and start and finish times.

The record is kept in an append-only ledger. Compare the sha256 of a downloaded file with the record to confirm it is the file that was issued.

Your statement for the quarter.

A call to the usage endpoint returns, for each job type on your key, the number of jobs delivered in the quarter, your allowance and any overage, plus the matters and advances counted, for example matters under watch. Work past the allowance is not blocked. It is flagged overage: true on the job and billed on the statement. Only delivered jobs count. Rejected and failed jobs are not billed.

A request and a response.

curl -X POST "https://<connector host, sent with your key>/v1/jobs/closed_tape_read" \
  -H "X-Criterica-Key: <your key>" \
  -F "tape=@funder_tape.csv" \
  -F "hurdle=0.20" \
  -F "hurdle_basis=total" \
  -F "servicing=0.02" \
  -F "cutoff=auto"

{
  "job_id": "<job id>",
  "status": "done",
  "outputs": [
    {
      "name": "<deliverable file name>",
      "sha256": "<sha256 of the file>",
      "pages": "<page count>",
      "url": "/v1/jobs/<job id>/files/<deliverable file name>"
    }
  ],
  "method_version": "<method version>",
  "usage": "<your usage for this job type this quarter>",
  "overage": false
}

Placeholders in angle brackets are filled by the service or by you. The download path in each output retrieves the deliverable with your key.

What the service says plainly.

• –Live monitoring reads federal dockets only. Matters outside that coverage are listed as not covered; nothing is estimated for them.
• –A matter without evidence in the pack is returned as not rated. It is never filled in.
• –Deliverables are analytical work product, not guarantees of outcome, value, financing or timing.

Your files stay yours. The models stay here.

• –Your files are used to produce your results and do not train a generalized model without a separate written agreement.
• –Results are visible only to the key that requested them.
• –You receive results: reports, bands, scores and the files listed for your job. You do not receive, and the service cannot return, the models, their settings, the rules behind a rating or anything else that is not a deliverable of your job.
• –Retention follows your agreement with Criterica.

Questions