GrayPass Labs

Reference

API reference

Generated from the running application. Every path, method, and parameter below exists in this build. Requests carry a server credential as a Bearer token; browser credentials can only submit evidence.

Contract metadata

MethodPathPurpose
GET/api/v1/metaMeta

Credential identity

MethodPathPurpose
GET/api/v1/credentialCredential identity

Protected actions and policies

MethodPathPurpose
GET/api/v1/actionsList actions
POST/api/v1/actionsCreate action
DELETE/api/v1/actions/{action_id}Archive action
GET/api/v1/actions/{action_id}Get action
PATCH/api/v1/actions/{action_id}Update action
GET/api/v1/actions/{action_id}/policy-versionsList policy versions
POST/api/v1/actions/{action_id}/policy-versionsCreate policy version
POST/api/v1/actions/{action_id}/policy-versions/{version}/activateActivate policy version

Subjects

MethodPathPurpose
GET/api/v1/subjectsList subjects
POST/api/v1/subjectsCreate subject
DELETE/api/v1/subjects/{subject_id}Delete subject
GET/api/v1/subjects/{subject_id}Get subject
POST/api/v1/subjects/{subject_id}/adaptation/freezeFreeze adaptation
POST/api/v1/subjects/{subject_id}/enrollments/completeComplete enrollment
POST/api/v1/subjects/{subject_id}/exportExport subject
POST/api/v1/subjects/{subject_id}/passkeys/register/completePasskey register complete
POST/api/v1/subjects/{subject_id}/passkeys/register/optionsPasskey register options
POST/api/v1/subjects/{subject_id}/passkeys/registration-grantsCreate passkey registration grant
DELETE/api/v1/subjects/{subject_id}/passkeys/{passkey_id}Revoke passkey
POST/api/v1/subjects/{subject_id}/recoveryBegin recovery
POST/api/v1/subjects/{subject_id}/research-consentResearch consent
POST/api/v1/subjects/{subject_id}/revokeRevoke subject

Browser credentials

MethodPathPurpose
POST/api/v1/client-tokensCreate client token

Sessions and evidence

MethodPathPurpose
POST/api/v1/sessionsCreate session
GET/api/v1/sessions/{session_id}/assessmentSession assessment
POST/api/v1/sessions/{session_id}/endEnd session
POST/api/v1/sessions/{session_id}/evidenceSubmit evidence
GET/api/v1/sessions/{session_id}/statusSession status

Authorization

MethodPathPurpose
POST/api/v1/authorizeAuthorize

Authorizations and outcomes

MethodPathPurpose
GET/api/v1/authorizations/{authorization_id}Get authorization
POST/api/v1/authorizations/{authorization_id}/outcomeReport outcome
POST/api/v1/authorizations/{authorization_id}/reviewReview authorization

Challenges

MethodPathPurpose
GET/api/v1/challenges/{challenge_id}Get challenge
POST/api/v1/challenges/{challenge_id}/cancelCancel challenge
POST/api/v1/challenges/{challenge_id}/completeComplete challenge
POST/api/v1/challenges/{challenge_id}/passkey/optionsChallenge passkey options

Proofs

MethodPathPurpose
GET/api/v1/proofs/{jti}/statusProof status

Evaluations

MethodPathPurpose
GET/api/v1/evaluationsList evaluations
POST/api/v1/evaluationsCreate evaluation
POST/api/v1/evaluations/{evaluation_id}/closeClose evaluation
GET/api/v1/evaluations/{evaluation_id}/reportEvaluation report

Activity

MethodPathPurpose
GET/api/v1/activityActivity

Public keys

MethodPathPurpose
GET/.well-known/graypass-proof-keys.jsonProof jwks

Verify

MethodPathPurpose
POST/api/v1/verifyVerify

Machine-readable contract

The OpenAPI document for this build is published at /docs/openapi.json and served live at GET /api/v1/openapi.json. Capability states and reason codes are published at GET /api/v1/meta. Proof verification keys are published at GET /.well-known/graypass-proof-keys.json.

Generated from the API contract in contracts/ and the source in docs/. The build fails if this page disagrees with the running API.