Form Object

The form object is a container for form data. It includes properties that are common to all form types, as well as a reference string, which is useful for tracking and making follow-up queries.

{
  "id": "RCBrLQKLYAuMg5k9UGCSxC",
  "reference": "ab0b12e2-979c-47be-97d8-acf614685d57",
  "signerEmail": "name@example.com",
  "type": "w9Oct2018",
  "brandId": "7m4PEATbjCe7rwUbxwSeS5",
  "data": {},
  "signatures": []
}

Form object properties

id string

A unique identifier for authenticated access to the form.

reference string

If a reference id was provided with the session, it will be carried over to the form object.

signerEmail string

If a signer enters their email address when they digitally sign the form, or if a signer email was provided with the session, it will be carried over to the form object.

type string

A string representing the type and version of the form. Official bodies revise forms from time to time. Our forms are designed to target a specific form type to avoid unexpected new or deprecated fields in the data object.

brandId string

If a brand was specified when the form was created, the brand id will be carried over to the form object.

data object

Includes the data for the completed form. Refer to the appropriate object for more information.

signatures array of objects

Each signature contains information about the individual signing the form including the text of their signature and their email address. The signatures property is an array for cases where more than one signature is required. Refer to the signature object guide for more information.