API documentation

Retrieve results and evidence

Read retained outcomes, follow original references, and export the versioned evidence file through an authorized request.

Updated

Retrieve
Result ID

Keep the identifier with your business record.

Context
Evidence + versions

Review the source facts behind each candidate.

Availability
Retention applies

Expired inputs can prevent full reproduction.

Retrieve the result your request produced

GET /api/v1/results/{id} returns a retained result under data. GET /api/v1/results lists permitted results with items and nextCursor. Result IDs do not grant access on their own: the key or session must belong to the correct organization and environment.

GET /api/v1/results/{id}/evidence returns a downloadable JSON evidence document. Unlike the ordinary API data envelope, that document is the evidence object itself. Its format field identifies sanctionskit-evidence@1. Preserve the original result separately from later analyst decisions.

Terminal · curl
curl --fail-with-body \
  "https://www.sanctionskit.com/api/v1/results/$SCREENING_ID/evidence" \
  -H "Authorization: Bearer $SANCTIONSKIT_API_KEY" \
  --output screening-evidence.json

Know when reproduction stops being possible

The result includes the selected source versions, dataset, matching-engine version, policy version, and package version when used. Original source records and authority references help reviewers understand the finding. Retention must preserve the necessary inputs and source history to support later reproduction.

An expired result returns 410 rather than a fabricated historical response. Minimal retention omits the retained subject, redacts submitted values from persisted match evidence, and limits the reduced result to 24 hours. The immediate response and any copy your application stores remain your responsibility. A request digest cannot reconstruct a deleted subject.

KEEP BUILDING

Where to go next