Developer Docs
API Reference
Integrate Premtrace screenings into your compliance workflow.
Authentication
All API requests require your API key in the Authorization header. Your API key is provided when your account is created.
Authorization: Bearer pt_your_api_key_hereBase URL
https://api.premtrace.chContact us for your specific endpoint URL during the pilot phase.
Create a Screening
POST
/api/screeningsSubmit a subject for digital risk screening. The screening runs asynchronously and results are delivered via email with a PDF report.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| subject_name | string | Yes | Full name of the person to screen |
| subject_role | string | No | Role or title (e.g. "CFO") |
| subject_company | string | No | Company or organization |
| subject_context | string | No | Additional context (e.g. "Hiring due diligence") |
Example
curl -X POST https://api.premtrace.ch/api/screenings \
-H "Authorization: Bearer pt_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"subject_name": "John Smith",
"subject_role": "CFO",
"subject_company": "Acme Corp",
"subject_context": "Board appointment due diligence"
}'Response
{
"screening": {
"id": "abc123-...",
"subject_name": "John Smith",
"status": "pending",
"created_at": "2026-04-14T10:00:00Z"
}
}List Screenings
GET
/api/screeningsList all your screenings with their current status.
curl https://api.premtrace.ch/api/screenings \
-H "Authorization: Bearer pt_your_api_key"Get Screening Details
GET
/api/screenings/:idGet a specific screening with all findings.
curl https://api.premtrace.ch/api/screenings/abc123 \
-H "Authorization: Bearer pt_your_api_key"Response (completed)
{
"screening": {
"id": "abc123-...",
"subject_name": "John Smith",
"status": "completed",
"risk_score": 45,
"summary": "Two medium-severity findings identified...",
"completed_at": "2026-04-14T10:02:30Z"
},
"findings": [
{
"severity": "MEDIUM",
"category": "Compliance",
"title": "Undisclosed directorship",
"summary": "Subject listed as director of...",
"recommendation": "Review against conflict policy.",
"source_url": "https://...",
"source_platform": "Commercial Registry"
}
]
}Rate Limits
| Plan | Screenings / Month |
|---|---|
| Pilot | 5 |
| Professional | 50 |
| Enterprise | Unlimited |
Exceeding your monthly limit returns HTTP 429. Contact us to upgrade.
Screening Statuses
| Status | Description |
|---|---|
pending | Screening has been created and is queued |
processing | Search and analysis in progress |
completed | Report generated and emailed |
failed | An error occurred — contact support |