Get E-Sign MetaData

/esignmetadata/esigntransactions

GET

This endpoint returns the list of transactions that are available to work on. 

StartCreatedDate

EndCreatedDate

Example:
{     "StartCreatedDate": "2023-01-01T17:18:42.517",     "EndCreatedDate": "2022-02-14T17:18:42.517" }

Update E-Sign MetaData

/esignmetadata/esigntransactions/{transactionId}

PUT

This endpoint sets the status of a transaction record so that future calls to the GET esignmetadata/esigntransactions endpoint returns only the desired records (e.g. only the active records).

TransactionID

StatusID

StatusID

Integer

NO

The Status of the records to include:

1  Pending

2  Active

3  Inactive

4  Delete

5  In Process

StartCreatedDate

Date

NO

The start date to include results based on the date the record was created

EndCreatedDate

Date

NO

The end date to include results based on the date the record was created

AccountID

String

NO

Customer AccountID

BDID

String

YES

Customer Broker Dealer identifier

ClientID

String

YES

Customer ClientID

RepCode

String

3

YES

Customer RepCode

DocumentSetId

String

YES

Document SetId from e-sign vendor

AttachmentFlag

Boolean

YES

If TRUE then the record is an attachment and the FullFileName and PartialFileName fields will be identical and reliable for matching, and the FormID value will be 0. If FALSE then the record is a form with a valid FormID.

FormName

String

YES

Name or description of the form

PageCount

Integer

YES

Number of pages for the FormID

FormOrder

Integer

YES

Order of the documents in the package

CreateDate

Date

YES

The Date & Time the document ready for signing ceremony.

DocSetDescription

String

YES

The DocSetDescription Quik! sent to e-sign vendor

FullFileName

String

YES

The expected file name of the PDF sent to the e-sign vendor. (NOTE: The PDF file name for forms is not stored in Quik!, only attachment file names are stored. Therefore, to return this value for forms, the file name is estimated and could possibly change between the time the PDF is sent to the e-sign vendor and when this service is called. To reliably match the file name between Quik! and the e-sign vendor, use the PartialFileName and match the right-most portion of the filename.)

PartialFileName

String

YES

The right-most portion of the file name that will never change. Use this value for matching file names between Quik! and the e-sign vendor – match against the right-most portion of the e-sign vendor’s filename.

StatusID

Integer

YES

The status of the records to include (1 = Active, 2 = Inactive, 3 = Pending, 4 = Delete)

TransactionID

String

36

YES

The TransactionID value Quik! sent to e-sign vendor

FormID

Integer

YES

Unique form ID within Quik! to differentiate one form from another. If the record is an attachment the FormID will be a zero.

TransactionID

String

36

YES

The TransactionID who’s status will be set

StatusID

Integer

YES

The status of the records to include:
1        Pending

2        Active

3        Inactive

4        Delete