GRgraypass
canonical

Begin subject recovery

Move a revoked subject into the permitted re-enrollment path after your application establishes the required anchor.

post/api/v1/subjects/{subject_id}/recovery

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/subjects/{subject_id}/recovery
  • Auth
    HTTP bearer

Path parameters

subject_idstring required

Subject identifier resolved from your authenticated account mapping.

Request body

anchor'none' | 'customer_session' | 'idp' | 'passkey' | 'verified_identity' required

Account anchor established by the customer identity process and recorded by GrayPass.

anchor_evidence_refstring nullable

Reference to the customer’s anchor evidence; required for idp, passkey and verified_identity anchors. The customer identity process establishes the underlying claim. GrayPass retains the digest without independently verifying that identity claim.

Response

Subject reset to not_enrolled under the accepted replacement anchor.

adaptation_frozenboolean required

Whether online template adaptation is frozen; true prevents silent template adaptation.

anchorstring required

Account anchor established by the customer identity process and recorded by GrayPass.

created_atstring required

Creation time as an ISO 8601 timestamp.

enrollment_state'not_enrolled' | 'enrolling' | 'enrolled' | 'revoked' | 'deleted' required

Current enrollment lifecycle state. Revoked subjects need the configured recovery path; deleted subjects are no longer operationally retrievable.

environmentstring required

Environment identifier that scopes this record; sandbox and live resources are separate.

idstring required

Identifier of this record. Treat it as opaque and retain it for subsequent operations.

limitationsstring[]

Applicable limitations that must accompany interpretation of the result.

recovery_policystring required

Recovery rule governing whether re-enrollment requires an anchor or a separate manual-review process.

revoked_atstring nullable

Revocation time as an ISO 8601 timestamp, or null when not revoked.

Changes

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