Azure Connectors Node.js SDK
    Preparing search index...

    Definition: WorkflowRecipient

    interface WorkflowRecipient {
        delegatee?: string;
        delegatee_name?: string;
        delivery_method?: string;
        electronic_seal?: ElectronicSealRecipient;
        email_language_code?: string;
        gatekeepers?: WorkflowGatekeeperResponse;
        group_members?: GroupMemberResponse[];
        group_name?: string;
        guest_user: boolean;
        mobile_number?: string;
        order: number;
        placeholder?: string;
        process_status?: string;
        processed_as?: string;
        processed_by?: string;
        processed_on?: string;
        reason?: string;
        role?: string;
        signing_order: number;
        user_email?: string;
        user_name?: string;
        user_national_id?: string;
        user_photo_url?: string;
    }
    Index
    delegatee?: string

    Delegatee email address, if recipient is not a group.

    delegatee_name?: string

    Name of the delegatee user, if recipient is not a group.

    delivery_method?: string

    Delivery method of recipient Possible values: EMAIL, SMS, or EMAIL_AND_SMS

    electronic_seal?: ElectronicSealRecipient
    email_language_code?: string

    email language code

    group_members?: GroupMemberResponse[]

    A list of email addresses of the group members if recipient is a group.

    group_name?: string

    Group name of the recipient if recipient is a group.

    guest_user: boolean

    Gest user

    mobile_number?: string

    Mobile number

    order: number

    Order of the recipient in the workflow.

    placeholder?: string

    Placeholder text if the recipient is a placeholder

    process_status?: string

    Document processing status for the recipient. Possible values are "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDITED" or "INVALID".

    processed_as?: string

    User may processed the field as COLLABORATOR , DELEGATOR, GROUP_MEMBER or OWNER.

    processed_by?: string

    Email address of the user who processed the document.

    processed_on?: string

    Date and time on which the document was processed.

    reason?: string

    Reason provided by the user when declining, approving or submitting a document.

    role?: string

    Workflow role in which the recipient was added. This role is not the enterprise role. Possible values are "SIGNER", "REVIEWER","CARBON_COPY" and "EDITOR".

    signing_order: number

    Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

    user_email?: string

    Email address of the recipient if user is not a group.

    user_name?: string

    Name of the recipient if user is not a group.

    user_national_id?: string

    National identity number of the user. This helps to identify user in the workflow

    user_photo_url?: string

    API endpoint to access the resource, This will be provided only for main signers. e.g it will be null for group/delegator/gatekeeper etc. This URL does not make sure that signer image is exist. If image exist it will be provided by hitting the defined url otherwise it will be an empty string.