@oneblink/sdk
    Preparing search index...

    Type Alias LuminRequestSignatureConfiguration

    type LuminRequestSignatureConfiguration = {
        emailSubject?: LuminRequestSignatureValueMapping;
        emailTitle?: LuminRequestSignatureValueMapping;
        expiresAt: LuminRequestSignatureValueMapping;
        fieldMapping?: LuminRequestSignatureFieldMapping[];
        mergeTagMapping?: LuminRequestSignatureMergeTagMapping[];
        signers: LuminRequestSignatureSignerConfiguration[];
        template: { id: string; name: string };
        title: LuminRequestSignatureValueMapping;
        variableMapping?: LuminRequestSignatureVariableMapping[];
    }
    Index

    Properties

    emailSubject? emailTitle? expiresAt fieldMapping? mergeTagMapping? signers template title variableMapping?

    Properties

    emailSubject?: LuminRequestSignatureValueMapping

    Mapping for the signer email subject. Sent to Lumin as custom_email.subject_name.

    emailTitle?: LuminRequestSignatureValueMapping

    Mapping for the signer email title (heading in the custom email). Sent to Lumin as custom_email.title.

    expiresAt: LuminRequestSignatureValueMapping

    Mapping for when the signature request expires. Manual VALUE mappings should use an ISO 8601 datetime string. Converted to a Unix epoch timestamp in milliseconds when the signature request is sent.

    fieldMapping?: LuminRequestSignatureFieldMapping[]

    Mappings from form data to form fields on the template (Lumin fields).

    mergeTagMapping?: LuminRequestSignatureMergeTagMapping[]

    Mappings from form data to merge tags on the Lumin template (tags).

    signers: LuminRequestSignatureSignerConfiguration[]

    Signer configuration for each role defined on the Lumin template. The number of signers and signing order are inherited from the template.

    template: { id: string; name: string }

    The Lumin template used to create the signature request.

    Type Declaration

    • id: string

      The Lumin template id, including its prefix (e.g. sign_).

    • name: string

      The display name of the Lumin template.

    title: LuminRequestSignatureValueMapping

    Mapping for the signature request title sent to Lumin (shown as agreement name in the console).

    variableMapping?: LuminRequestSignatureVariableMapping[]

    Mappings from form data to variables on an AgreementGen template (Lumin variables).

    Settings

    Member Visibility

    On This Page

    Properties