ConsentRequestInput

  • guardians
    Type: array object[] · GuardianConsentRequest[] 1…
    required

    The parent/guardians to request consent from. Each entry carries the guardian's UUID and may optionally carry a corrected legal name.

    • id
      Type: string Format: uuid
      required

      UUID of the parent/guardian to request consent from.

    • correctedFirstName
      Type: string
      min length:  
      1      Pattern: \S

      Corrected legal first name for the guardian. Must be supplied together with correctedLastName (both-or-neither); supplying only one field rejects the whole request with 400. When the corrected name differs from the guardian's stored name, it is written back to the system of record before the envelope is generated; any live pending envelope for that guardian is voided and a new one is issued and emailed, so the guardian must use the newest signing link. An identical name is a no-op.

    • correctedLastName
      Type: string
      min length:  
      1      Pattern: \S

      Corrected legal last name for the guardian. Must be supplied together with correctedFirstName (both-or-neither); supplying only one field rejects the whole request with 400.

  • returnUrl
    Type: string Format: uri
    required

    URL the guardian's browser is redirected to after they finish signing in DocuSign. Applies to every guardian in this request. Required: the platform hosts no landing page, so the caller must supply where the guardian lands after signing.

  • forceResend
    Type: boolean

    Explicit signal that a repeat call is an intentional resend. With the default (false), a repeat call for a guardian who was already emailed reuses the envelope and sends no further email, regardless of elapsed time. Set true to re-email; a forced resend is still debounced by a short server-side window, so a double-click or retry cannot double-send. Applies to every guardian in this request.