REST APIs

The SDK covers most use cases, but you may need to build custom functionality — a custom dashboard, or exposing a subset of data to your users. The REST APIs support these use cases.

Available Endpoints

Endpoint	Method	Description
`/api/v2/test-attempts/{hashedTestAttemptId}/`	`GET`	Fetch the proctoring report for a single test attempt. Requires `clientId` as a query parameter.
`/api/v2/tenants/{clientId}/results/`	`GET`	Fetch all test attempt results. Requires `hashedUnixTimestamp` and `unixTimestamp` as query parameters.
`/api/v2/usage/`	`GET`	Fetch your account usage and credit balance. Requires authentication headers.

All API requests are made to https://www.autoproctor.co. Authentication uses the same hashing mechanism as the SDK — your CLIENT_SECRET is used to compute HMAC-SHA256 hashes of the relevant parameters.

API Playground

Test API requests interactively with your credentials. Select an endpoint, enter your CLIENT_ID and CLIENT_SECRET, and inspect the exact request and response.

REST API Client

Select Endpoint

Get detailed results for a single test attempt (multi-step)

Credentials

Client ID

Client Secret

Test Attempt ID

Get Test Attempt Details

Fetches the test attempt metadata including trust score, timestamps, and evidence processing status. The response contains an `evidence_status` field - you can only proceed to the next steps if this is "processed". If still processing, wait and retry.

Get Evidence File URL

Once evidence is processed (Step 1), this endpoint returns a URL pointing to a JSON file containing all evidence records. This URL is temporary and should be fetched immediately.

Fetch Evidence JSON

Downloads the evidence JSON from the URL obtained in Step 2. This file contains all violation records with their S3 paths (screenshots, audio clips, etc). These paths are not directly accessible - they need presigned URLs.

Generate Presigned URLs

Takes the S3 paths from the evidence JSON (Step 3) and generates time-limited, authenticated URLs that can be used to download the actual evidence files (images, audio recordings).

How the API Playground works

After registering, enter your CLIENT_ID and CLIENT_SECRET, select an endpoint from the dropdown, and click Submit. The playground displays the full request and response. Use this to verify API responses and copy the request parameters into your codebase.

Some APIs may require Headers for Authentication. Others may be hashing the parameters