DigitalSignature | Object Reference for the Salesforce Platform

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete()

Special Access Rules

Field Service must be enabled.

Fields

Field Name	Details
DigitalSignatureNumber	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number identifying the signature.
DocumentBody	Type base64 Properties Create Description The captured signature image.
DocumentContentType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The data type of the captured signature. Possible values are: `audio/acc` `audio/amr` `audio/ogg` `video/3gpp2` `video/3gpp` `image/avif` `text/calendar` `audio/x-caf` `image/webp`
DocumentLength	Type int Properties Filter, Group, Nillable, Sort Description The length of the captured signature.
DocumentName	Type string Properties Create, Filter, Group, Sort Description The name of the captured signature image.
ParentId	Type reference Properties Create, Filter, Group, Sort Description ID of the service appointment, work order, or work order line item that the service report is generated for. This is a polymorphic relationship field. Relationship Name Parent Relationship Type Lookup Refers To AuthorizationFormConsent, Order, ServiceAppointment, WorkOrder, WorkOrderLineItem
Place	Type string Properties Create, Filter, Group, Nillable, Sort Description The place where the report was signed.
SignatureType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description The role of the person signing the service report. Your org comes with one signature type, Default. A service report template can only contain one signature per type. If you plan to collect multiple signatures on service reports, create additional values for the Signature Type field. Create at least one value for every role that might need to sign a service report. For example, Technician, Customer, Supervisor, or Supplier. If some service reports will be signed by multiple people in one role—for example, all technicians present at an appointment—create numbered types: Technician 1, Technician 2, and so forth. You can create up to 1,000 signature types. You can’t delete signature types, but you can deactivate them so they can’t be used in service report templates. When you deactivate a type, it still appears on service report templates that used it, but you can’t use it on new service report templates. Note
SignedBy	Type string Properties Create, Filter, Group, Nillable, Sort Description The name of the person signing.
SignedDate	Type dateTime Properties Create, Filter, Nillable, Sort Description The date and time of the signing.

Usage

Add signature blocks to service report templates to determine which signatures need to be gathered on reports that use the template. Service report templates can contain up to 20 signatures, and each signature must use a different Signature Type. For example, create a standard service report template that contains a customer signature and a technician signature.

To learn more about digital signatures, see Guidelines for Using Signatures on Service Reports.

Associated Objects

This object has the following associated objects. Unless noted, they’re available in the same API version as this object.

DigitalSignatureChangeEvent (Available in API version 57.0): Change events are available for the object.