canonical

Submit an SDK evidence window

Submit a session-signed feature window and receive accepted coverage accounting.

post/api/v1/sessions/{session_id}/evidence

Request

  • Base URL
    https://app.graypass.org (the document declares no server; this is the origin it was published from)
  • URL
    https://app.graypass.org/api/v1/sessions/{session_id}/evidence
  • Auth
    HTTP bearer

Path parameters

session_idstring required

Session identifier owned by the scoped subject in the authenticated environment.

Request body

duration_msnumber required

Frame duration in milliseconds; finite values from 0 through 600000 are accepted by the schema. Accepted coverage applies additional server checks.

featuresobject required

SDK-produced modality feature object containing bounded derived features. Raw key content, images, video and audio stay outside the evidence submission.

frame_idstring required

Unique identifier for this frame within the session; repeated identifiers are refused by replay controls.

purposestring

Frame purpose: enroll for enrollment evidence; score for observation. It must match the session’s purpose.

research_optinboolean

Separate per-frame JSON opt-in, default false. Retention requires this field plus current subject consent, environment participation and deployment eligibility.

timestampnumber required

Frame timestamp. The browser SDK emits Unix milliseconds; native-compatible Unix seconds are also normalized. Use the SDK’s clock convention consistently.

window_endnumber nullable

Optional evidence-window end as Unix seconds. Bounds must describe a fresh, non-overlapping window for this session.

window_startnumber nullable

Optional evidence-window start as Unix seconds. When omitted, bounds are derived from timestamp and duration_ms.

Response

accepted, neutral or rejected status plus coverage, reasons and enrollment readiness.

active_secondsnumber required

Duration of accepted active evidence in seconds.

coverage'none' | 'sparse' | 'partial' | 'sufficient' required

Evidence-coverage category: none, sparse, partial or sufficient. Describes the amount and variety of accepted evidence.

enrollment_readyboolean

Whether the server’s accepted coverage meets enrollment readiness. Client elapsed time alone is insufficient.

evidence_windowsinteger required

Number of accepted, non-overlapping evidence windows accounted for in this session or profile.

modalities_presentstring[]

Names of observed evidence modalities included in coverage accounting.

reason_codesstring[]

Stable reason identifiers explaining acceptance, limitations or a decision; resolve them in the reason-code catalog.

status'accepted' | 'neutral' | 'rejected' required

accepted contributes to coverage. Interpret neutral and rejected through the associated reason codes.

Changes

No recorded changes to this operation across all 1 revision of this API.