Skip to content

Query EviSign messages

Request

Query EviSigns visible to the authenticated context. For metadata-only pages of up to 25, explicitly set IncludeAttachmentBlobsOnResult and IncludeAffidavitBlobsOnResult to false and enable the entry flags you need. ASP.NET defaults both file-content flags to false. The legacy service has deployment settings whose declared defaults enable both. Including attachment or affidavit entries with file bytes limits the request to one result. Use Bundle to retrieve a ZIP archive.

Security
basicAuth
Query
WithUniqueIdsArray of strings, (uuid)

Filters results by EviSign unique identifiers.

WithLookupKeysArray of strings

Filter by client lookup keys. Comma-separated values are supported; a lookup key containing a comma cannot be represented as one value in this form.

OnStatestring

Filters results by current processing state.

Enum:"Draft""Submitted""Processed""Sent""Closed""Forwarded""Received"
WithOutcomestring

Filters results by processing outcome.

Enum:"None""Signed""Rejected""Failed""Expired""Cancelled"
OrderResultsBystring

Sort order used for the query results.

Value:"CreationDate"
Offsetinteger or null, (int32)

Number of entries to skip.

Default:0
Limitinteger or null, (int32), <= 100

Maximum 1 when including attachment or affidavit entries with file bytes. To page metadata up to 25, explicitly enable the entry flags you need and set both file-content flags to false. Disable attachment and affidavit entries for pages up to 100. When omitted, the service selects a default limit from the effective inclusion flags.

IncludeAffidavitsOnResultboolean

Includes affidavit entries in each result. Defaults to false. Set IncludeAffidavitBlobsOnResult to false for metadata only.

Default:false
IncludeEventsOnResultboolean or null

Includes event metadata in each result. Defaults to false.

Default:false
IncludeAttachmentsOnResultboolean or null

Includes attachment entries in each result. Defaults to true on the ASP.NET API. The legacy service uses a deployment setting whose declared default is true. Set IncludeAttachmentBlobsOnResult to false for metadata only.

Default:true
IncludeAttachmentBlobsOnResultboolean

Compatibility flag for file bytes when attachment entries are included. Defaults to false on ASP.NET. The legacy service uses a deployment setting whose declared default is true. Set to false explicitly for metadata only.

IncludeAffidavitBlobsOnResultboolean

Compatibility flag for file bytes when affidavit entries are included. Defaults to false on ASP.NET. The legacy service uses a deployment setting whose declared default is true. Set to false explicitly for metadata only.

IncludeDocumentsOnResultboolean

Includes generated document metadata in each result. Defaults to false.

Default:false
curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.evicertia.com/v1/evisign/query?WithUniqueIds=497f6eca-6276-4993-bfeb-53cbbbba6f08&WithLookupKeys=string&OnState=Draft&WithOutcome=None&OrderResultsBy=CreationDate&Offset=0&Limit=100&IncludeAffidavitsOnResult=false&IncludeEventsOnResult=false&IncludeAttachmentsOnResult=true&IncludeAttachmentBlobsOnResult=true&IncludeAffidavitBlobsOnResult=true&IncludeDocumentsOnResult=false'

Responses

Query executed successfully.

Bodyapplication/json
resultsArray of objects or null(v1.EviSignQuery._Result._EviSign)

Query results.

totalMatchesinteger or null, (int32)

Total number of entries that match the query criteria.

Response
{ "results": [ { … } ], "totalMatches": 0 }