SignatureRequest.md

DocSpring::SignatureRequest

Properties

Name	Type	Description	Notes
id	String	The signature request's ID.
submission_id	String	The ID of the submission the signature request belongs to.
name	String	The name of the person the request is for.
email	String	Their email address.
fields	Array<String>	The fields this person fills in. Null for a signature request created with API v1 without a field list: it asks for every field the submission's data doesn't have.
metadata	Hash<String, Object>	Your own data about the signature request, such as an ID from your app.
role	String	Which of the template's signers the person is. Until templates have roles of their own, a template's signers are Signer 1, Signer 2 and so on, up to Signer 100: Signer 1 is the one whose details the template's @@signature_requests/0 fields print.
sort_order	Integer	The signer's position, from 0: Signer 1 is 0. The template's @@signature_requests/&lt;sort_order&gt; fields print this signature request's details.
state	SignatureRequestState	pending until the person completes the signature request (completed) or declines it (declined).
data	Hash<String, Object>	The values this person entered for their own fields (fields). Null when their submission's data is left out: in lists without include_data=true, in the events of a webhook that leaves out submission data, and once the submission has expired.
viewed_at	Time	When the person first opened the signature request.
completed_at	Time	When they completed it.
declined_at	Time	When they declined it.
auth_type	SignatureRequestAuthType	How your app authenticated the person before it showed them the signature request.
auth_second_factor_type	SignatureRequestAuthSecondFactorType	The second factor your app authenticated them with, if any.
auth_provider	String	The service that authenticated them, such as google. Required when auth_type is oauth.
auth_session_started_at	Time	When your app authenticated them. Set for you with email_link.
auth_session_id_hash	String	A hash of your app's session ID, for the audit trail.
auth_user_id_hash	String	Their user ID in your app, or a SHA-256 hash of a salt and the user ID.
auth_username_hash	String	Their username in your app, or a SHA-256 hash of a salt and the username.
auth_phone_number_hash	String	The phone number they authenticated with, or a SHA-256 hash of a salt and the phone number.
ip_address	String	The IP address they completed the signature request from. Null in the events of a webhook that leaves out submission data.
user_agent	String	The User-Agent header of the browser they completed the signature request with. Null in the events of a webhook that leaves out submission data.
created_at	Time	When the signature request was created.
updated_at	Time	When the signature request was last updated.

Example

require 'docspring'

instance = DocSpring::SignatureRequest.new(
  id: null,
  submission_id: null,
  name: null,
  email: null,
  fields: null,
  metadata: null,
  role: null,
  sort_order: null,
  state: null,
  data: null,
  viewed_at: null,
  completed_at: null,
  declined_at: null,
  auth_type: null,
  auth_second_factor_type: null,
  auth_provider: null,
  auth_session_started_at: null,
  auth_session_id_hash: null,
  auth_user_id_hash: null,
  auth_username_hash: null,
  auth_phone_number_hash: null,
  ip_address: null,
  user_agent: null,
  created_at: null,
  updated_at: null
)