다음을 통해 공유

Taktikal Core (Preview)

  • Reference

With Taktikal Core, you have the capability to sign, seal, authenticate, and obtain detailed information regarding your signing processes.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Taktikal
URL https://docs.taktikal.com/
Email help@taktikal.com
Connector Metadata
Publisher Taktikal
Website https://taktikal.com/
Privacy policy https://www.taktikal.com/privacy
Categories Productivity

Taktikal Core APIs is a powerful way to build new solutions in your own interface and to integrate with the solutions that are already in operation.

Documents can be sent for signature directly from your own systems, and after signing, the documents and related metadata can be automatically sent back to the document system. You can also monitor the status of documents in the signing process and call for status based on ID numbers or other unique identifiers.

Prerequisites

To use the Taktikal Core API, please reach out to our sales team at sales@taktikal.is to acquire the necessary API credentials.

How to get credentials

Reach out to our Sales team to create access and obtain your API credentials.

Get started with your connector

The core api can get documents signed, authenticate using Icelandic e-ID and manage all signing processes

  • For authentication use /Auth/Start to initiate a authentication process and then /Auth/Poll to check if the status of the authentication.
  • To sign a single document call /management/signing for a single document and /management/signing/sequential for a bulk signature of multiple documents.
  • To obtain detailed log about a signing process call /signing/activity/{ProcessKey}.

Known issues and limitations

  • The requests needs to have a Authorization header for Basic Auth. That is the companyKey and API-Key
  • At the moment only Qualified signatures are with an Icelandic e-Id.
  • The PDF provide should be ab Base64 string.
  • Signers must have a valid email and a mobile phone number.

Common errors and remedies

Currently only PDF are accepted for signature.

FAQ

Further information about the API can be found under https://docs.taktikal.com

Starting a signing process is a single POST request. To start a signing process a valid PDF document is needed and a list of Signees that need to sign the document. Taktikal will handle displaying the document to the signee, also if a communicationDeliveryType is selected, Taktikal will send the signee an SMS or Email with a link to sign. After the document is signed by all participants Taktikal will send the document to the relevant delivery paths that are registered.

A flowKey is a key provided by Taktikal. This key will tell Taktikal how to handle this request. For some flowKeys Taktikal will take care of creating the document. It will also control where the signed document is delivered after signing.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Company Key securestring The Company Key for this api True
API Key securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Cancel a Signing process

Cancel the Signing process based for a given Process Key.
Cancel the sequential Signing process

Cancel the sequential Signing process based for a given Sequence Key. A user (email) can be provided that cancels the sequential process.
Checks the status of authentication for a user using their Icelandic e-id

After a successful response from /Auth/Start a AuthRequestId is returned and is used to check if authentication is finished. If authentication is finished and is successful the customer object is populated depending on the LookupType. The lookup type indicates the type of information is retrieved for the Icelandic National Registry.

There are three different datasets returned depending on the LookupType:

  1. Name: Will only return the SSN and Name of the authenticated person. This has no additional lookup cost.

  2. NameAddress: Will return Name, SSN and address information. This has an additional lookup cost. This is the default value if no value is given for LookupType.

  3. NameAddressFamily: Returns Name, SSN, Address data, gender code, and family information.

If 'LookupType.NameAddressFamily' is selected then the extra values returned will be returned in 'Meta'.

If the response has errors or is not finished, the customer object will be null and a StatusMessage will have a detailed message.
Creates a new Sequential (Bulk) Signing processes

Creates a new Sequential Signing process (Bulk) with one or more Signing Processes. Each Signing process in a sequence has one or more signees.

Example:

  • A company wants document A and B signed. Signee X should sign document A and B, Signee Y should sign document A and Signee Z should sign Document B.
  • Then A new CreateSequentalSigning with array of two CreateSigningProcess object. Signees X and Y are added as signees for CreateSigningProcess for Document A and signees X and Z are added as signees for Document B.

Detailed documentation can be found on https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/
Creates a new Signing process with one or more signees

Creates a new Signing process with with one or more signees.
Gets activity log for a Company

Gets activity log for a Company
Gets activity log for a user (email) for a specific period

Gets activity log for a user for a period.
Gets activity log for Signing process

Get the the Activity Log for a Signing process.
Gets the signing process by processKey and signeeKey

Get's the signing process by processkey and signeeKey.
Initiates a authentication process with Icelandic e-id

Authenticating with the Icelandic e-id can be done with a mobile phone or Audkenni app.

  • Using Mobile Phone: The AuthenticationContextType should be set to 'Sim' and the phoneNumber must be set to an Icelandic mobile phone number. The ssn is ignored.
  • Using Audkenni App: The AuthenticationContextType should be set to 'App' and the ssn must be set to an Icdlandic social security number. The phoneNumber is ignored.

flowKey should always be provided and is acccessible in Taktikal portal.
Seals a PDF document

Seals a provided PDF document provided as a base64 string.
Seals an XML document

Seals a provided XML document provided as a base64 string.
Starts an auth process with Icelandic e-id for a sequential signing processes

Authenticating with the Icelandic e-id can be done with a mobile phone or Audkenni app.

  • Using Mobile Phone: The AuthenticationContextType should be set to 'Sim' and the phoneNumber must be set to an Ucelandic mobile phone number. The ssn is ignored.
  • Using Audkenni App: The AuthenticationContextType should be set to 'App' and the ssn must be set to an Icdlandic social security number. The phoneNumber is ignored.
Update a Signee for given ProcessKey and SigneeKey

Signee properties can be updated based having provided the ProcessKey and the SigneeKey.

Cancel a Signing process

Operation ID:
CancelSigningProcesssigning_Delete

Cancel the Signing process based for a given Process Key.

Parameters

Name Key Required Type Description
Unique identifier for a single document Signing process.
 ProcessKey string

Unique identifier for a single document Signing process.
String object, usually the email of the employee that has access to the portal.
 User string

String object, usually the email of the employee that has access to the portal.

Returns

SigningProcess

SigningProcess
SigningProcess

Cancel the sequential Signing process

Operation ID:
CancelSequenceSigningsigningsequential_Delete

Cancel the sequential Signing process based for a given Sequence Key. A user (email) can be provided that cancels the sequential process.

Parameters

Name Key Required Type Description
Sequential signing process identifier that has to be provided.
 SequenceKey True string

Sequential signing process identifier that has to be provided.
Only the user who started the signing process can cancel it.
 User True string

Only the user who started the signing process can cancel it.

Returns

SequentialSigning

SequentialSigning
SequentialSigning

Checks the status of authentication for a user using their Icelandic e-id

Operation ID:
AuthPollPoll_Post

After a successful response from /Auth/Start a AuthRequestId is returned and is used to check if authentication is finished. If authentication is finished and is successful the customer object is populated depending on the LookupType. The lookup type indicates the type of information is retrieved for the Icelandic National Registry.

There are three different datasets returned depending on the LookupType:

  1. Name: Will only return the SSN and Name of the authenticated person. This has no additional lookup cost.

  2. NameAddress: Will return Name, SSN and address information. This has an additional lookup cost. This is the default value if no value is given for LookupType.

  3. NameAddressFamily: Returns Name, SSN, Address data, gender code, and family information.

If 'LookupType.NameAddressFamily' is selected then the extra values returned will be returned in 'Meta'.

If the response has errors or is not finished, the customer object will be null and a StatusMessage will have a detailed message.

Parameters

Name Key Required Type Description
authRequestId
 authRequestId True string
flowKey
 flowKey True string

Unique identifier for a Flow that belongs to a Company.
lookupType
 lookupType True string

Returns

PollCustomer

PollCustomer
PollCustomer

Creates a new Sequential (Bulk) Signing processes

Operation ID:
CreateSequentialSigningsigningsequential_Post

Creates a new Sequential Signing process (Bulk) with one or more Signing Processes. Each Signing process in a sequence has one or more signees.

Example:

  • A company wants document A and B signed. Signee X should sign document A and B, Signee Y should sign document A and Signee Z should sign Document B.
  • Then A new CreateSequentalSigning with array of two CreateSigningProcess object. Signees X and Y are added as signees for CreateSigningProcess for Document A and signees X and Z are added as signees for Document B.

Detailed documentation can be found on https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/

Parameters

Name Key Required Type Description
pdfDocument
 pdfDocument string

is a base64 string of the document to sign. This is not required if the flowKey takes care of creating the document.
pdfFileName
 pdfFileName string

If PdfDocument is being used a value for the file name needs to be provided.
flowKey
 flowKey True string

FlowKey is provided by Taktikal. This key will tell Taktikal how to handle this request. For some flowKeys Taktikal will take care of creating the document. It will also control where the signed document is delivered after signing.
processKey
 processKey string
name
 name string
ssn
 ssn string
phoneNumber
 phoneNumber string
email
 email string
address
 address string
postalCode
 postalCode string
city
 city string
reason
 reason string
hidePersonalCode
 hidePersonalCode boolean
communicationDeliveryType
 communicationDeliveryType string
customSmsText
 customSmsText string
signatureType
 signatureType string
language
 language string
Dictionary
 meta object

Dictionary<String,String>
fileName
 fileName string
fileContent
 fileContent string
id
 id string
fileName
 fileName string
contentLength
 contentLength integer
contentType
 contentType string
url
 url string
description
 description string
processKey
 processKey string
attachmentType
 attachmentType string
signeeKey
 signeeKey string
requiresAuth
 requiresAuth boolean

Default value is false. If set to true then all signers need to use there e-Id to authenticate before being able to view the document.
signInOrder
 signInOrder boolean

Default value is false. Will control the order of signers. It will only send a signing request to the first person in the signers list to begin with. After he has signed the next signee and so on.
signatureLocation
 signatureLocation string

Can be BottomLastPage or the default value TopFirstPage. Will control where to display the signature in the document.
user
 user string

email address of the user that send the request. Can be empty.
sequenceKey
 sequenceKey string
activityDisplayName
 activityDisplayName string
flattenDocument
 flattenDocument boolean

Default value is false. If set to true then we will attempt to flatten the documents input fields.
reminderRule
 reminderRule string

Sends reminders, leave empty for none. format should be "firstReminder after x days:Then every y days" e.g. "1:3" will send one reminder after 1 day, and then every three days after that. Leave empty or null for no reminders, valid values will be for first reminder to be sent between 0-30 days (0 means no reminder), and then send every 0-15 days (0, again, meaning no reminders, So 0:10 would only send reminder every 10 days, while 12:0 would send only one reminder after 12 days
user
 user True string

The user who starts the sequential signing process
requiresAuth
 requiresAuth boolean

Default value is false. If set to true then all signers need to use there e-Id to authenticate before being able to view the document.
signInOrder
 signInOrder boolean

Default value is false. Will control the order of signers. It will only send a signing request to the first person in the signers list to begin with. After he has signed the next signee and so on.

Returns

SequentialSigning

SequentialSigning
SequentialSigning

Creates a new Signing process with one or more signees

Operation ID:
CreateSigningProcesssigning_Post

Creates a new Signing process with with one or more signees.

Parameters

Name Key Required Type Description
pdfDocument
 pdfDocument string

is a base64 string of the document to sign. This is not required if the flowKey takes care of creating the document.
pdfFileName
 pdfFileName string

If PdfDocument is being used a value for the file name needs to be provided.
flowKey
 flowKey True string

FlowKey is provided by Taktikal. This key will tell Taktikal how to handle this request. For some flowKeys Taktikal will take care of creating the document. It will also control where the signed document is delivered after signing.
processKey
 processKey string
name
 name string
ssn
 ssn string
phoneNumber
 phoneNumber string
email
 email string
address
 address string
postalCode
 postalCode string
city
 city string
reason
 reason string
hidePersonalCode
 hidePersonalCode boolean
communicationDeliveryType
 communicationDeliveryType string
customSmsText
 customSmsText string
signatureType
 signatureType string
language
 language string
Dictionary
 meta object

Dictionary<String,String>
fileName
 fileName string
fileContent
 fileContent string
id
 id string
fileName
 fileName string
contentLength
 contentLength integer
contentType
 contentType string
url
 url string
description
 description string
processKey
 processKey string
attachmentType
 attachmentType string
signeeKey
 signeeKey string
requiresAuth
 requiresAuth boolean

Default value is false. If set to true then all signers need to use there e-Id to authenticate before being able to view the document.
signInOrder
 signInOrder boolean

Default value is false. Will control the order of signers. It will only send a signing request to the first person in the signers list to begin with. After he has signed the next signee and so on.
signatureLocation
 signatureLocation string

Can be BottomLastPage or the default value TopFirstPage. Will control where to display the signature in the document.
user
 user string

email address of the user that send the request. Can be empty.
sequenceKey
 sequenceKey string
activityDisplayName
 activityDisplayName string
flattenDocument
 flattenDocument boolean

Default value is false. If set to true then we will attempt to flatten the documents input fields.
reminderRule
 reminderRule string

Sends reminders, leave empty for none. format should be "firstReminder after x days:Then every y days" e.g. "1:3" will send one reminder after 1 day, and then every three days after that. Leave empty or null for no reminders, valid values will be for first reminder to be sent between 0-30 days (0 means no reminder), and then send every 0-15 days (0, again, meaning no reminders, So 0:10 would only send reminder every 10 days, while 12:0 would send only one reminder after 12 days

Returns

SigningProcess

SigningProcess
SigningProcess

Gets activity log for a Company

Operation ID:
GetSigningProcessActivityByCompanyactivitycompany_Get

Gets activity log for a Company

Parameters

Name Key Required Type Description
Start date of the log to be searched, must be a smaller date than EndDate.
 StartDate True date-time

Start date of the log to be searched, must be a smaller date than EndDate.
End date of the log to be searched, must be a bigger date than StartDate.
 EndDate True date-time

End date of the log to be searched, must be a bigger date than StartDate.
Used to page the result set and only return N many results.
 Take integer

Used to page the result set and only return N many results.
Used to page the result set and skip the first N results.
 Skip integer

Used to page the result set and skip the first N results.
The email of the user.
 User string

The email of the user.
Can be used to only get activity for a specific flow type.
 FlowType string

Can be used to only get activity for a specific flow type.
If it has a value we only return records that match this flowKey.
 FlowKey string

If it has a value we only return records that match this flowKey.

Returns

List<SigningProcessActivityLogWrapper>
array of SigningProcessActivityLogWrapper

Gets activity log for a user (email) for a specific period

Operation ID:
GetSigningProcessActivityForUseractivityuser_Get

Gets activity log for a user for a period.

Parameters

Name Key Required Type Description
The email of the user.
 User string

The email of the user.
Start date of the log to be searched, must be a smaller date than EndDate.
 StartDate True date-time

Start date of the log to be searched, must be a smaller date than EndDate.
End date of the log to be searched, must be a bigger date than StartDate.
 EndDate True date-time

End date of the log to be searched, must be a bigger date than StartDate.
Use if to be filtered on a single signing process.
 ProcessKey string

Use if to be filtered on a single signing process.
Can be used to only get activity for a specific flow type.
 FlowType string

Can be used to only get activity for a specific flow type.
Used to page the result set and only return N many results.
 Take integer

Used to page the result set and only return N many results.
Used to page the result set and skip the first N results.
 Skip integer

Used to page the result set and skip the first N results.
If it has a value we only return records that match this flowKey
 FlowKey string

If it has a value we only return records that match this flowKey.

Returns

List<SigningProcessActivityLogWrapper>
array of SigningProcessActivityLogWrapper

Gets activity log for Signing process

Operation ID:
GetSigningProcessActivityactivityProcessKey_Get

Get the the Activity Log for a Signing process.

Parameters

Name Key Required Type Description
The email of the user.
 User string

The email of the user.
Start date of the log to be searched, must be a smaller date than EndDate.
 StartDate True date-time

Start date of the log to be searched, must be a smaller date than EndDate.
End date of the log to be searched, must be a bigger date than StartDate.
 EndDate True date-time

End date of the log to be searched, must be a bigger date than StartDate.
Use if to be filtered on a single signing process.
 ProcessKey True string

Use if to be filtered on a single signing process.
Can be used to only get activity for a specific flow type.
 FlowType string

Can be used to only get activity for a specific flow type.
used to page the result set and only return N many results.
 Take integer

used to page the result set and only return N many results.
used to page the result set and skip the first N results.
 Skip integer

used to page the result set and skip the first N results.
If it has a value we only return records that match this flowKey.
 FlowKey string

If it has a value we only return records that match this flowKey.

Returns

List<SigningProcessActivityLogWrapper>
array of SigningProcessActivityLogWrapper

Gets the signing process by processKey and signeeKey

Operation ID:
GetSigningProcessBySigneeProcessKeysigneeSigneeKey_Get

Get's the signing process by processkey and signeeKey.

Parameters

Name Key Required Type Description
Unique identifier for a single document Signing process.
 ProcessKey True string

Unique identifier for a single document Signing process.
Unique identifier of a person signing a single signing process.
 SigneeKey True string

Unique identifier of a person signing a single signing process.
A User Agent is software acting for a user, like a web browser or email client.
 UserAgent string

A User Agent is software acting for a user, like a web browser or email client.

Returns

SigningProcess

SigningProcess
SigningProcess

Initiates a authentication process with Icelandic e-id

Operation ID:
AuthStartStart_Post

Authenticating with the Icelandic e-id can be done with a mobile phone or Audkenni app.

  • Using Mobile Phone: The AuthenticationContextType should be set to 'Sim' and the phoneNumber must be set to an Icelandic mobile phone number. The ssn is ignored.
  • Using Audkenni App: The AuthenticationContextType should be set to 'App' and the ssn must be set to an Icdlandic social security number. The phoneNumber is ignored.

flowKey should always be provided and is acccessible in Taktikal portal.

Parameters

Name Key Required Type Description
ssn
 ssn string
phoneNumber
 phoneNumber string
flowKey
 flowKey True string

Unique identifier for a Flow that belongs to a Company.
authenticationContextType
 authenticationContextType True string

Returns

StartAuthResponse

StartAuthResponse
StartAuthResponse

Seals a PDF document

Operation ID:
SealingRequestsealing_Post

Seals a provided PDF document provided as a base64 string.

Parameters

Name Key Required Type Description
pdfDocument
 pdfDocument True string

A Base64String of the PDF document to seal.
flowKey
 flowKey True string

Unique identifier for a Flow that belongs to a Company.
reason
 reason string

set the reason to display in the seal
languageType
 languageType string

Returns

SealingResponse

SealingResponse
SealingResponse

Seals an XML document

Operation ID:
SealingXmlRequestsealingxml_Post

Seals a provided XML document provided as a base64 string.

Parameters

Name Key Required Type Description
xmlDocument
 xmlDocument True string

Base64String of the XML document to seal
flowKey
 flowKey True string

A valid flowKey provided by Taktikal that can be used for sealing

Returns

Object

response
object

Starts an auth process with Icelandic e-id for a sequential signing processes

Operation ID:
RequestToViewSequenceStartsequentialSequenceKeyauth_Post

Authenticating with the Icelandic e-id can be done with a mobile phone or Audkenni app.

  • Using Mobile Phone: The AuthenticationContextType should be set to 'Sim' and the phoneNumber must be set to an Ucelandic mobile phone number. The ssn is ignored.
  • Using Audkenni App: The AuthenticationContextType should be set to 'App' and the ssn must be set to an Icdlandic social security number. The phoneNumber is ignored.

Parameters

Name Key Required Type Description
Unique identifier for a sequence (Bulk) Signing processes.
 SequenceKey True string

Unique identifier for a sequence (Bulk) Signing processes.
sequenceKey
 sequenceKey True string
loginHint
 loginHint True string
authenticationContextType
 authenticationContextType True string

Returns

StartAuthResponse

StartAuthResponse
StartAuthResponse

Update a Signee for given ProcessKey and SigneeKey

Operation ID:
UpdateSigneeProcessKeysigneeSigneeKey_Create

Signee properties can be updated based having provided the ProcessKey and the SigneeKey.

Parameters

Name Key Required Type Description
Unique identifier of a person signing a single signing process.
 SigneeKey True string

Unique identifier of a person signing a single signing process.
Unique identifier for a single document Signing process.
 ProcessKey True string

Unique identifier for a single document Signing process.
email
 email string
address
 address string
postalCode
 postalCode string
city
 city string
signeeKey
 signeeKey True string
processKey
 processKey True string
reason
 reason string
user
 user string

Returns

Signee

Signee
Signee

Definitions

Signee

Signee

Name Path Type Description
name
 name string
ssn
 ssn string
phoneNumber
 phoneNumber string
email
 email string
address
 address string
postalCode
 postalCode string
city
 city string
key
 key string
signed
 signed boolean
signedAt
 signedAt date-time
processKey
 processKey string
reason
 reason string
hidePersonalCode
 hidePersonalCode boolean
communicationDeliveryType
 communicationDeliveryType string
url
 url string
signatureType
 signatureType string
language
 language string
customSmsText
 customSmsText string

SigningAttachment

SigningAttachment

Name Path Type Description
fileName
 fileName string
fileContent
 fileContent string

AttachmentReference

AttachmentReference

Name Path Type Description
id
 id string
fileName
 fileName string
contentLength
 contentLength integer
contentType
 contentType string
url
 url string
description
 description string
processKey
 processKey string
attachmentType
 attachmentType string
signeeKey
 signeeKey string

Dictionary_String_String_

Dictionary<String,String>

Name Path Type Description
Dictionary
 object

Dictionary<String,String>

SigningProcessActivityLogWrapper

SigningProcessActivityLogWrapper

Name Path Type Description
processKey
 processKey string
activityLog
 activityLog array of SigningProcessActivityLog
signees
 signees array of SigneeActivityLog
sequenceSignees
 sequenceSignees array of SequentialSigningSigneeActivityLog
attachmentReferences
 attachmentReferences array of AttachmentReference
activityDisplayName
 activityDisplayName string

SigningProcessActivityLog

SigningProcessActivityLog

Name Path Type Description
flowKey
 flowKey string

Unique identifier for a Flow that belongs to a Company.
processKey
 processKey string
signeeKey
 signeeKey string
status
 status string
description
 description string
userAgent
 userAgent string
fileName
 fileName string
createdAt
 createdAt date-time
createdBy
 createdBy string
requiresAuth
 requiresAuth boolean
signInOrder
 signInOrder boolean
signatureLocation
 signatureLocation string
sequenceKey
 sequenceKey string

SigneeActivityLog

SigneeActivityLog

Name Path Type Description
processKey
 processKey string
signeeKey
 signeeKey string
ssn
 ssn string
name
 name string
address
 address string
postalCode
 postalCode string
city
 city string
phone
 phone string
email
 email string
createdAt
 createdAt date-time
createdBy
 createdBy string
updatedAt
 updatedAt date-time
signatureType
 signatureType string

SequentialSigningSigneeActivityLog

SequentialSigningSigneeActivityLog

Name Path Type Description
sequenceKey
 sequenceKey string
signeeKey
 signeeKey string
url
 url string
signingKeys
 signingKeys array of SigneeKeys

SigneeKeys

SigneeKeys

Name Path Type Description
signeeKey
 signeeKey string
processKey
 processKey string

SequentialSigning

SequentialSigning

Name Path Type Description
key
 key string
status
 status string
requiresAuth
 requiresAuth boolean
user
 user string
signInOrder
 signInOrder boolean
signees
 signees array of SequentialSigningSignee
signingProcesses
 signingProcesses array of SigningProcess

SequentialSigningSignee

SequentialSigningSignee

Name Path Type Description
key
 key string
url
 url string
signingKeys
 signingKeys array of SigneeKeys

SigningProcess

SigningProcess

Name Path Type Description
key
 key string
signees
 signees array of Signee
flowKey
 flowKey string

Unique identifier for a Flow that belongs to a Company.
status
 status string
Dictionary
 meta Dictionary_String_String_

Dictionary<String,String>
pdfFileName
 pdfFileName string
attachments
 attachments array of SigningAttachment
attachmentReferences
 attachmentReferences array of AttachmentReference
requiresAuth
 requiresAuth boolean
user
 user string
signInOrder
 signInOrder boolean
signatureLocation
 signatureLocation string
sequenceKey
 sequenceKey string
flattenDocument
 flattenDocument boolean

StartAuthResponse

StartAuthResponse

Name Path Type Description
authRequestId
 authRequestId string
verificationCode
 verificationCode string

SealingResponse

SealingResponse

Name Path Type Description
pdfDocument
 pdfDocument string

Customer

Customer

Name Path Type Description
name
 name string
ssn
 ssn string
phoneNumber
 phoneNumber string
email
 email string
address
 address string
postalCode
 postalCode string
city
 city string
token
 token string
flowKey
 flowKey string

Unique identifier for a Flow that belongs to a Company.
Dictionary
 meta Dictionary_String_String_

Dictionary<String,String>

PollCustomer

PollCustomer

Name Path Type Description
Customer
 customer Customer

Customer
statusMessage
 statusMessage string
waitingForUserInput
 waitingForUserInput boolean

object

This is the type 'object'.