SendReminderRequest

Details of the KYC or document-signing reminder to email an application's applicants

  • reminderType
    Type: "KYC" or "DocumentSigning"enum
    required

    Which reminder to send. Picks both the email template and its subject line.

  • customMessage
    Type: string

    Free text rendered into the email's required-information block. Omit for the standard copy.

  • selectedRecipients
    Type: array of string

    Applicant email addresses to send to. Omit to email every applicant on the application; send the array to chase one applicant on a joint application. Every address must belong to an applicant on this application, otherwise the call is rejected with a 400 naming the offending addresses.