Skip to main content

Role

A Role defines a participant position on a Template. Each role has a type (signer, witness, or approver) and is linked to specific fields on the template via the signerIndex.

Fields

FieldTypeDescription
idID!Unique identifier
nameString!Descriptive title (e.g. "Tenant", "Witness")
roleTypeROLETYPESIGNER, WITNESS, or APPROVER
signerIndexInt!Field indicator linking this role to template elements
ordinalInt!Display order on the template
signerParentIDParent role ID (used for witnesses linked to a signer)
experienceIDExperience ID for this participant

Query

Roles are accessed as a field on Template:

query GetTemplateRoles {
template(id: "dHBsYjQ5YTg5NWQtYWRhMy0xMWYwLWIxZGMtMDY5NzZlZmU0MzIx") {
roles {
id
name
roleType
signerIndex
ordinal
signerParent
experience
}
}
}
  • Template — the template this role belongs to
  • Recipient — recipients are assigned roles when a document is sent
  • Experience — the signing experience for this role

Export This Article

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