Skip to content

Developer reference

API Reference

Selected v1 endpoints for organizations with approved API access. Available operations depend on your key, scope, and enabled products.

Base URL

https://app.securepointusa.com/api/v1

API access is activated by SecurePoint. External calls use an issued spusa_ API key with the required scope and product access. Ask for a sandbox organization and check GET /api/v1/whoami before sending test traffic.

Selected Endpoints

MethodPathPurpose
GET/api/v1/whoamiCheck which organization and environment (sandbox or production) a key acts in.
POST/api/v1/checkinSubmit a v1 check-in request.
POST/api/v1/prescreenRun a prescreen decision workflow.
POST/api/v1/ownership/checkRun an ownership-aware screening check where enabled.
POST/api/v1/vendors/screenScreen vendor entities against sanctions sources.
GET/api/v1/screenings/{id}Fetch one screening record by id.
GET/api/v1/screenings/{id}/evidenceDownload the evidence PDF for a screening record.
GET/api/v1/adjudication/queueFetch adjudication cases available to the caller.
GET/api/v1/adjudication/{id}Fetch one adjudication case.
POST/api/v1/adjudication/{id}/dispositionRecord an adjudication disposition.
POST/api/v1/sessions/{id}/updateUpdate a session state or metadata.
GET/api/v1/audit/exportExport audit records for authorized users.
GET/api/v1/audit/integrityCheck audit-log integrity (signed-in users only; API keys are not accepted).
PUT/api/v1/adjudication/rulesUpdate adjudication rules configuration.
GET/api/v1/compliance/reportsRetrieve report summaries (signed-in users only; API keys are not accepted).

Success Response Shape

{
  "success": true,
  "data": {
    "...": "resource payload"
  },
  "meta": {
    "requestId": "uuid"
  }
}

Error Response Shape

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient permissions",
    "details": {
      "...": "optional diagnostic data"
    }
  },
  "meta": {
    "requestId": "uuid"
  }
}

Example: Check In an Existing Sandbox Visitor

Replace the example UUID with a visitor that already exists in your approved sandbox. This call can create visit records; it does not create a visitor from a name. Required review, host, and site checks must be satisfied before check-in can complete.

curl -X POST "https://app.securepointusa.com/api/v1/checkin" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <spusa_api_key>" \
  -d '{
    "visitor_id": "00000000-0000-4000-8000-000000000001"
  }'

See the full API quickstart (Markdown) and OpenAPI specification (YAML) for endpoint contracts, scopes, and prerequisites.

How to screen a name with the Screening API

A short walkthrough of /api/v1/prescreen and /api/v1/screenings/{id}, once SecurePoint has turned on the Screening API for your organization and issued your API key.

Read the transcript

Step 1. SecurePoint turns on the Screening API for your organization and issues your API key.

Step 2. POST the name to prescreen as the subject, with your key in the Authorization header. The key identifies your organization, so you don't send one.

Step 3. Read the result: a screening ID, a risk level and score, the number of possible matches, and whether review is required.

When review is required, the name goes to your compliance team's review queue, and the status reads pending.

Step 4. Keep the screening ID. Later, GET the screening by that ID to read the stored result.

Screen visitors at check-in. Keep the decisions on record.

Handle Errors and Retries Next

Review rate-limit and error-handling guidance before integrating production traffic.

Open Error Handling Guide