ConsentRecordInput

  • consentStatus
    Type: string ยท ConsentStatusenum
    required

    Status of the consent. Note: the platform does not produce expired automatically; a request that lapses unsigned stays pending. expired is accepted only as a createConsentRecord input. voided is written when a request is superseded (re-request, name correction, sibling grant) or the DocuSign envelope is voided.

    values
    • pending
    • granted
    • denied
    • expired
    • voided
    • withdrawn
  • occurredAtTime
    Type: string Format: date-time
    required

    Timestamp when the consent status change occurred

  • guardianId
    Type: string | null Format: uuid

    UUID of the parent/guardian providing consent. Nullable only for pending records where metadata.consentMethod is awaiting_guardian.

  • metadata
    Type: object | null

    Free-form audit context. Common keys the platform reads/writes: consentMethod, docusignEnvelopeId, docusignStatus, emailConsentInitiatedAt, returnUrl, and (on voided records) supersededBy and originalEnvelopeId. Additional keys are allowed.

    • propertyName
      Type: anything