Create an eSignature Transaction

This endpoint creates a new eSignature transaction, which represents a set of documents that need to be signed by one or more recipients. A transaction is the top-level container for managing the eSignature process. Authorization (http bearer token) is required.

Request Body — REQUIRED
documents object[] — REQUIRED List of documents id string id of the document from response from POST /document/upload title string — REQUIRED document title description string document description xfdf string document xfdf string gcsRefId string — REQUIRED gcsRefId of document from response POST /document/upload sessionType string — REQUIRED Possible values: [esign] type string — REQUIRED Possible values: [acknowledgment, oath, undetermined] order number order the document is shown to participant pages number number of pages in the document readOnly boolean will this document be read only visible boolean will this document be visible to the participants tags object[] — REQUIRED List of tags to convert to xfdf type string — REQUIRED Possible values: [DATETEMPLATE, FULLNAMETEMPLATE, DOCUMENTIDTEMPLATE, NOTARYSESSIONIDTEMPLATE, COMMISSIONIDTEMPLATE, COMMISSIONEXPIRATIONTEMPLATE, DISCLAIMERTEMPLATE, COMMISSIONSTAMPTEMPLATE, SEALTAGTEMPLATEANNOTATION, NOTARYTITLETEMPLATE, NOTARYCOUNTYTEMPLATE, NOTARYSTATETEMPLATE, SIGNATURETEMPLATE, SIGNHERETAGTEMPLATEANNOTATION, INITIALSTEMPLATE, INITIALHERETAGTEMPLATEANNOTATION, FREEFORMTEXTTAGTEMPLATEANNOTATION, TEXTANNOT] x number — REQUIRED bottom-left x-coordinate of the tag annotation y number — REQUIRED bottom-left y-coordinate of the tag annotation width number — REQUIRED width of the tag annotation height number — REQUIRED height of the tag annotation signerId string — REQUIRED id of the signer this tag is assigned to customData object — REQUIRED page number — REQUIRED page number of the tag annotation required boolean tag is required to be applied stateFormat string tag is required to be applied dateFormat string Possible values: [MM/DD/YYYY, DD/MM/YYYY, MM/DD/YY, DD/MM/YY, MMMM do, yyyy, full, MMMM, do, yyyy, YYYY] tag is required to be applied fontSize number tag font size
participants object[] — REQUIRED list of participants to include in esign session id string — REQUIRED id of the signer this tag is assigned to order number order of participant email string — REQUIRED email of the signer firstName string — REQUIRED first name of signer middleName string middle name of signer lastName string — REQUIRED last name of signer address1 string address of signer address2 string address 2 of signer country string country of signer city string address 2 of signer state string state of signer zip string postal code of signer phone string phone number of signer kbaRequired boolean is KBA required for this signer credAnalysisRequired boolean is credential-analysis required for this signer externalId string consumer-provided external id authenticationType string — REQUIRED Possible values: [personal-password, two-factor-authentication, none] twoFactorContact string — REQUIRED Possible values: [sms, email] personalPasswordQuestion string personalPassword string inviteEmailSubject string
notifyParticipants object notification preferences email boolean send email notification to participants
status string — REQUIRED Possible values: [draft, esign_pending]
referenceId string — REQUIRED The unique identifier your organization assigned to this transaction.
signingOrder boolean The flag to enable signing order.
personalizedMessage string The personalized message to the email request sent to the client.

Responses
201 The record has been successfully created. Schema — OPTIONAL taggingOrganizationId string — OPTIONAL id of the organization assigned to tag this document evault string — OPTIONAL Possible values: [eOriginal] eVault to use. Defaults to eOriginal sendFinalEnoteTo string[] Possible values: [eOriginal] documents object[] List of documents id string — OPTIONAL id of the document from response from POST /document/upload title string document title description string — OPTIONAL document description xfdf string — OPTIONAL document xfdf string gcsRefId string gcsRefId of document from response POST /document/upload sessionType string Possible values: [esign] type string Possible values: [acknowledgment, oath, undetermined] order number — OPTIONAL order the document is shown to participant pages number — OPTIONAL number of pages in the document readOnly boolean — OPTIONAL will this document be read only visible boolean — OPTIONAL will this document be visible to the participants tags object[] List of tags to convert to xfdf type string Possible values: [DATETEMPLATE, FULLNAMETEMPLATE, DOCUMENTIDTEMPLATE, NOTARYSESSIONIDTEMPLATE, COMMISSIONIDTEMPLATE, COMMISSIONEXPIRATIONTEMPLATE, DISCLAIMERTEMPLATE, COMMISSIONSTAMPTEMPLATE, SEALTAGTEMPLATEANNOTATION, NOTARYTITLETEMPLATE, NOTARYCOUNTYTEMPLATE, NOTARYSTATETEMPLATE, SIGNATURETEMPLATE, SIGNHERETAGTEMPLATEANNOTATION, INITIALSTEMPLATE, INITIALHERETAGTEMPLATEANNOTATION, FREEFORMTEXTTAGTEMPLATEANNOTATION, TEXTANNOT] x number bottom-left x-coordinate of the tag annotation y number bottom-left y-coordinate of the tag annotation width number width of the tag annotation height number height of the tag annotation signerId string id of the signer this tag is assigned to customData object page number page number of the tag annotation required boolean — OPTIONAL tag is required to be applied stateFormat string — OPTIONAL tag is required to be applied dateFormat string — OPTIONAL Possible values: [MM/DD/YYYY, DD/MM/YYYY, MM/DD/YY, DD/MM/YY, MMMM do, yyyy, full, MMMM, do, yyyy, YYYY] tag is required to be applied fontSize number — OPTIONAL tag font size participants object[] list of participants to include in esign session id string id of the signer this tag is assigned to order number — OPTIONAL order of participant email string email of the signer firstName string first name of signer middleName string — OPTIONAL middle name of signer lastName string last name of signer address1 string — OPTIONAL address of signer address2 string — OPTIONAL address 2 of signer country string — OPTIONAL country of signer city string — OPTIONAL address 2 of signer state string — OPTIONAL state of signer zip string — OPTIONAL postal code of signer phone string — OPTIONAL phone number of signer kbaRequired boolean — OPTIONAL is KBA required for this signer credAnalysisRequired boolean — OPTIONAL is credential-analysis required for this signer externalId string — OPTIONAL consumer-provided external id authenticationType string Possible values: [personal-password, two-factor-authentication, none] twoFactorContact string Possible values: [sms, email] personalPasswordQuestion string — OPTIONAL personalPassword string — OPTIONAL inviteEmailSubject string — OPTIONAL
400 The request is invalid Schema — OPTIONAL error object statusCode number status code message string[] List of documents error string status code