Quickstart
-
Get a test key. During early access, keys are issued on request. Email [email protected]. Test keys start with
ak_test_, work against sandbox lists and are never billed. -
Screen a person.
Terminal window curl https://api.auto-compliance.com/v1/screenings \-H "Authorization: Bearer $AUTOCOMPLIANCE_API_KEY" \-H "Content-Type: application/json" \-H "Idempotency-Key: $(uuidgen)" \-d '{"full_name": "Test Sanctioned Person","date_of_birth": "1970-01-01","external_id": "cust_test_001"}'import os, uuid, requestsresp = requests.post("https://api.auto-compliance.com/v1/screenings",headers={"Authorization": f"Bearer {os.environ['AUTOCOMPLIANCE_API_KEY']}","Idempotency-Key": str(uuid.uuid4()),},json={"full_name": "Test Sanctioned Person","date_of_birth": "1970-01-01","external_id": "cust_test_001",},timeout=10,)resp.raise_for_status()screening = resp.json()print(screening["hit"], [m["score"] for m in screening["matches"]])const resp = await fetch('https://api.auto-compliance.com/v1/screenings', {method: 'POST',headers: {Authorization: `Bearer ${process.env.AUTOCOMPLIANCE_API_KEY}`,'Content-Type': 'application/json','Idempotency-Key': crypto.randomUUID(),},body: JSON.stringify({full_name: 'Test Sanctioned Person',date_of_birth: '1970-01-01',external_id: 'cust_test_001',}),});if (!resp.ok) throw new Error(`HTTP ${resp.status}`);const screening = await resp.json();console.log(screening.hit, screening.matches.map((m) => m.score)); -
Read the result.
hitistruewhen at least one match scores at or above your project threshold. Each match explains why it was returned:{"id": "scr_01JD8Q4R7ZK3M2N5P6T8V9W0XY","hit": true,"threshold": 75,"matches": [{"score": 97,"matched_name": "SANCTIONED PERSON, Test","score_breakdown": {"retrieval": 0.93,"verifier": 0.98,"date_of_birth": "exact","single_token_penalty": false},"entity": {"source": "ofac_sdn","source_entity_id": "TEST-0001","list_version": "sandbox-2026-11-01"}}],"alert_id": "alt_01JD8QB1D3F5H7K9M1P3R5T7V9"} -
Decide what to do. A typical integration pauses onboarding or the payment when
hitistrueand routes the case to a compliance analyst. See Understanding results.
Next steps
Section titled “Next steps”- Try the other sandbox test names to see no-hit, reordered and typo cases.
- Screen many people at once with batches.
- Go through the integration checklist before going live.