ConsentRecordOutput

  • consentStatus
    Type: 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
    pendinggranteddeniedexpiredvoidedwithdrawn
  • dateCreated
    Type: stringFormat: date-time
    required

    When the database record was created

  • dateLastModified
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • guardianId
    Type: string | nullFormat: uuid
    required
  • id
    Type: stringFormat: uuid
    required
  • occurredAtTime
    Type: stringFormat: date-time
    required

    Timestamp when the consent status change occurred

  • studentId
    Type: stringFormat: uuid
    required
  • metadata
    Type: object | null

    Free-form audit context. Common keys: consentMethod, docusignEnvelopeId, docusignStatus, emailConsentInitiatedAt, returnUrl, and (on voided records) supersededBy and originalEnvelopeId. Additional keys may be present.

    Properties: 1