GRgraypass
canonical

Record or withdraw research consent

Record a separate, attributed subject decision about behavioral-model research participation.

post/api/v1/subjects/{subject_id}/research-consent

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}/research-consent
  • Auth
    HTTP bearer

Path parameters

subject_idstring required

Subject identifier resolved from your authenticated account mapping.

Request body

consentedboolean required

Strict JSON boolean: true records consent and false records withdrawal. The server fixes the receipt purpose and disclosure version. Deployment eligibility is configured separately.

Response

Current subject record. The consent receipt is stored separately; session research eligibility is reported when creating a session.

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.