Skip to main content

Experience

An Experience defines how a signing session looks and behaves for recipients. Each Group has a default Experience, and you can create additional ones for different languages, branding, or consent requirements.

Experiences control email content, signing page appearance, signature options, and witness settings.

Fields

Identity

FieldTypeDescription
idIDUnique identifier
nameStringName (must be unique within the group, >2 chars)
defaultExperienceBooleanWhether this is the group's default experience
languageStringLanguage code for the signing session
createdAWSDateTimeWhen the experience was created
modifiedAWSDateTimeWhen the experience was last modified

Signing Page

FieldTypeDescription
headerStringPage header text
text1StringCustom text block 1
text2StringCustom text block 2
text3StringCustom text block 3
signingPageTextStringText on the PDF download page (after signing)
signingPageAgreeTicksAWSJSONArray of agreement checkbox items
signingPageRejectButtonBooleanShow reject button
signingSessionTimeIntSession timeout duration
signatureDoneTextStringText shown after signing completes

Signature Options

FieldTypeDescription
signatureMouseBooleanAllow draw-to-sign
signatureTypeBooleanAllow type-to-sign
signatureUploadBooleanAllow upload signature image
signatureCertificateBooleanEnable certificate-based signing
signatureCertifiedTypeIntCertification level (4 = certification)
allowSignatureReuseBooleanAllow reuse of previous signature
signatureAppendIntName format on signature (0=none, 1=First initial Last, 2=First initial Last + email)
signatureAppendDateStringDate format appended to signature
signatureAppendExtraStringExtra tag format (1=date, 2=date+IP, 3=IP, 4=time+date+TZ)
penDiameterIntPen thickness for draw-to-sign
typedSignatureFixedSizeIntFixed font size for typed signatures

Email Settings

FieldTypeDescription
defaultSubjectStringDefault email subject line
defaultReminderSubjectStringDefault reminder subject
emailHeaderStringEmail header text
emailSubHeaderStringEmail sub-heading for signers
emailExtraStringAdditional email content
emailLogoStringEmail logo filename
emailSendSequenceIntSend sequence (0=all at once, 1=sequential)
emailRejectedToSignersSubjectStringSubject for rejection emails
emailSignedToSignersSubjectStringSubject for completion emails
finalSignerEmailSubHeaderStringSub-heading for final signer email
finalSignerEmailTextStringBody text for final signer email
rejectedEmailSubheaderStringSub-heading for rejection emails
senderNameStringSender name on emails
attachDraftBooleanAttach draft PDF to first email and reminders
postSignAttachBooleanAttach signed PDF to completion email
postSignEmailBooleanSend completion email

Branding

FieldTypeDescription
logoNameStringLogo filename
logoImageHeightIntLogo height on signing page
logoImageWidthIntLogo width on signing page
backgroundColourStringPage background colour
bordersColourStringBorder colour
buttonBarBackgroundColourStringButton bar background
buttonBackgroundColourStringButton background
buttonBorderColourStringButton border
buttonFontColourStringButton text colour
textBackgroundColourStringText area background
textFontColourStringText colour
footerTextColourStringFooter text colour

Recipient Options

FieldTypeDescription
canReassignBooleanSigner can reassign to someone else
canSignPageDownloadBooleanSigner can download draft PDF
forwardingBooleanAllow forwarding

Witnessing

FieldTypeDescription
witnessSameDeviceBooleanWitness must use same device as signer
witnessingRequiresSignerSMSBooleanSigner SMS verification for witnessing
witnessingRequiresWitnessSMSBooleanWitness SMS verification

Query

query GetExperience($id: ID!) {
experience(id: $id) {
id
name
language
defaultExperience
defaultSubject
}
}

Experiences are also accessed via Group.experienceConnection.

Example

Loading all experiences for a group (based on the Legalesign Console app):

query GetGroupExperiences {
group(id: "Z3JwbGVnYWxlc2lnbxRldg==") {
experienceConnection {
experiences {
id
name
defaultExperience
language
}
}
}
}

Export This Article

Save a copy of this page as PDF or plain text.