Member Junction
    Preparing search index...

    Interface SendForSignatureOptions

    Input for SignatureEngine.SendForSignature.

    interface SendForSignatureOptions {
        artifactId?: string;
        artifactVersionId?: string;
        contextUser: UserInfo;
        documents: SignatureDocumentInput[];
        entityId?: string;
        message?: string;
        metadata?: Record<string, string>;
        provider?: IMetadataProvider;
        recipients: SignatureRecipientInput[];
        recordId?: string;
        sendImmediately?: boolean;
        signatureAccountId: string;
        title: string;
    }
    Index

    Properties

    artifactId? artifactVersionId? contextUser documents entityId? message? metadata? provider? recipients recordId? sendImmediately? signatureAccountId title

    Properties

    artifactId?: string

    Optional Artifact reference recorded against the (first) document for provenance.

    artifactVersionId?: string
    contextUser: UserInfo
    documents: SignatureDocumentInput[]

    Documents to sign. The caller resolves bytes (e.g. from an Artifact Version).

    entityId?: string

    Polymorphic originating record (entity half).

    message?: string
    metadata?: Record<string, string>

    Provider custom fields.

    provider?: IMetadataProvider
    recipients: SignatureRecipientInput[]

    Signers.

    recordId?: string

    Polymorphic originating record (record half).

    sendImmediately?: boolean

    true → send immediately; false → create as draft. Defaults to true.

    signatureAccountId: string

    Account (provider instance) to send through.

    title: string

    Envelope title / email subject.

    Settings

    Member Visibility

    On This Page

    Properties