# Query EviSign messages

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.

Endpoint: GET /v1/evisign/query
Version: 1.0
Security: basicAuth

## Security:

  - `basicAuth` (unknown)
    http basic

## Query parameters:

  - `WithUniqueIds` (array)
    Filters results by EviSign unique identifiers.

  - `WithLookupKeys` (array)
    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.

  - `OnState` (string)
    Filters results by current processing state.

  - `WithOutcome` (string)
    Filters results by processing outcome.

  - `OrderResultsBy` (string)
    Sort order used for the query results.

  - `Offset` (integer)
    Number of entries to skip.

  - `Limit` (integer)
    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.

  - `IncludeAffidavitsOnResult` (boolean)
    Includes affidavit entries in each result. Defaults to false. Set IncludeAffidavitBlobsOnResult to false for metadata only.

  - `IncludeEventsOnResult` (boolean)
    Includes event metadata in each result. Defaults to false.

  - `IncludeAttachmentsOnResult` (boolean)
    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.

  - `IncludeAttachmentBlobsOnResult` (boolean)
    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.

  - `IncludeAffidavitBlobsOnResult` (boolean)
    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.

  - `IncludeDocumentsOnResult` (boolean)
    Includes generated document metadata in each result. Defaults to false.

## Response 200:

  - `200` (unknown)
    Query executed successfully.

## Response 200 fields (application/json):

  - `results` (array)
    Query results.

  - `results.evidenceId` (string)
    Unique identifier of the EviSign evidence. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

  - `results.lookupKey` (string)
    Client-provided lookup key.

  - `results.subject` (string)
    Subject associated with the EviSign entry.

  - `results.document` (string)
    Main document bytes when included in the response.

  - `results.state` (string)
    Current processing state.
    Enum: "Draft", "Submitted", "Processed", "Sent", "Closed", "Forwarded", "Received"

  - `results.outcome` (string)
    Current or final processing outcome.
    Enum: "None", "Signed", "Rejected", "Failed", "Expired", "Cancelled"

  - `results.creationDate` (string)
    Creation date of the EviSign entry.

  - `results.lastStateChangeDate` (string)
    Date of the most recent state transition.

  - `results.submittedOn` (string)
    Date when the EviSign was submitted.

  - `results.processedOn` (string)
    Date when the EviSign was processed.

  - `results.sentOn` (string)
    Date when signature requests were sent.

  - `results.closedOn` (string)
    Date when the EviSign lifecycle was closed.

  - `results.signedOn` (string)
    Date associated with closure with the Signed outcome.

  - `results.rejectedOn` (string)
    Date when the EviSign was rejected.

  - `results.failedOn` (string)
    Date when the EviSign failed.

  - `results.expiredOn` (string)
    Date when the EviSign expired.

  - `results.signingParties` (array)
    Signing parties linked to this EviSign entry.

  - `results.signingParties.partyId` (string)
    Unique identifier of the signing party. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

  - `results.signingParties.name` (string)
    Display name of the signing party.

  - `results.signingParties.address` (string)
    Notification address used to reach the signer.

  - `results.signingParties.signingMethod` (string)
    Signature method used by the party.
    Enum: "WebClick", "MobilePin", "EmailPin", "Challenge", "Handwriting", "ExternalHandwriting", "UserCertificate"

  - `results.signingParties.signatureFields` (array)
    Signature field values captured for the party.

  - `results.signingParties.signatureFields.key` (string)
    Field key.

  - `results.signingParties.signatureFields.value` (string)
    Field value.

  - `results.signingParties.signatureComments` (string)
    Optional signature comments configured for the party.

  - `results.signingParties.legalName` (string)
    Legal name of the signing party.

  - `results.signingParties.role` (string)
    Role assigned to the party in the signing flow.
    Enum: "Signer", "Reviewer", "Interested", "null"

  - `results.signingParties.finalNotificationAddress` (string)
    Address used for final notifications.

  - `results.signingParties.signingOrder` (integer)
    Sequential signing order assigned to this party.

  - `results.signingParties.personIdKind` (string)
    Type of personal identifier associated with the signer.

  - `results.signingParties.personId` (string)
    Value of the personal identifier associated with the signer.

  - `results.signingParties.entityIdKind` (string)
    Type of entity identifier associated with the signer.

  - `results.signingParties.entityId` (string)
    Value of the entity identifier associated with the signer.

  - `results.signingParties.signatureRequestPolicy` (string)
    Preferred channel policy for signature request notifications.
    Enum: "SmsOnly", "WhatsAppOnly", "SmsThenWhatsApp", "WhatsAppThenSms", "null"

  - `results.interestedParties` (array)
    Interested parties linked to this EviSign entry.

  - `results.interestedParties.partyId` (string)
    Unique identifier of the interested party. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

  - `results.interestedParties.address` (string)
    Notification address of the interested party.

  - `results.affidavits` (array)
    Affidavits linked to this EviSign entry.

  - `results.affidavits.uniqueId` (string)
    Unique identifier of the affidavit. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

  - `results.affidavits.date` (string)
    Date and time when the affidavit was issued.

  - `results.affidavits.evidenceUniqueId` (string)
    Unique identifier of the related evidence. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

  - `results.affidavits.partyUniqueId` (string)
    Unique identifier of the related party. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

  - `results.affidavits.bytes` (string)
    Raw affidavit document bytes.

  - `results.affidavits.description` (string)
    Affidavit description.

  - `results.affidavits.kind` (string)
    Affidavit kind identifier.

  - `results.affidavits.additionalData` (object)
    Additional affidavit metadata as key-value pairs.

  - `results.attachments` (array)
    Attachments included in the EviSign entry.

  - `results.attachments.uniqueId` (string)
    Unique identifier of the attachment. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

  - `results.attachments.creationDate` (string)
    Date and time when the attachment was created.

  - `results.attachments.evidenceUniqueId` (string)
    Unique identifier of the related evidence. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

  - `results.attachments.partyId` (string)
    Related party identifier, when available. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

  - `results.attachments.contentId` (string)
    Content identifier of the attachment.

  - `results.attachments.displayName` (string)
    Display name of the attachment.

  - `results.attachments.filename` (string)
    File name of the attachment.

  - `results.attachments.mimeType` (string)
    MIME type of the attachment content.

  - `results.attachments.contentDescription` (string)
    Content description.

  - `results.attachments.contentDisposition` (string)
    Content disposition.

  - `results.attachments.contentLocation` (string)
    Content location.

  - `results.attachments.contentEncoding` (string)
    Content encoding.

  - `results.attachments.contentLength` (integer)
    Content length in bytes.

  - `results.attachments.hash` (string)
    Content hash.

  - `results.attachments.data` (string)
    Raw attachment data.

  - `results.attachments.attributes` (array)
    Attachment attributes as key-value pairs.

  - `results.attachments.attributes.key` (string)
    Attribute key.

  - `results.attachments.attributes.value` (string)
    Attribute value.

  - `results.issuer` (string)
    Issuer associated with the EviSign entry.

  - `results.timeToLive` (integer)
    Time to live configured for the EviSign lifecycle.

  - `results.signatures` (array)
    Signatures captured for the EviSign parties.

  - `results.signatures.partyId` (string)
    Identifier of the party that produced the signature. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

  - `results.signatures.deliveredOn` (string)
    Date and time when the signature request was delivered.

  - `results.signatures.signedOn` (string)
    Date and time when the party signed.

  - `results.signatures.accepted` (boolean)
    Indicates whether the party accepted the document.

  - `results.signatures.signatureFields` (array)
    Signature field values submitted by the party.

  - `results.signatures.signatureComments` (string)
    Optional comments provided by the party when signing.

  - `results.signatures.additionalCommitments` (array)
    Additional commitments accepted by the party.

  - `results.costCentre` (string)
    Cost center associated with the EviSign entry.

  - `results.onlineRetentionPeriod` (integer)
    Online retention period configured for the evidence.

  - `results.notaryRetentionPeriod` (integer)
    Notary retention period configured for the evidence.

  - `results.notaryProfile` (string)
    Notary profile identifier used for retention.

  - `results.documents` (array)
    Documents generated for this EviSign entry.

  - `results.documents.id` (string)
    Unique identifier of the document. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

  - `results.documents.kind` (string)
    Document kind identifier.

  - `results.documents.createdOn` (string)
    Date and time when the document was created.

  - `results.documents.eventId` (string)
    Related event identifier when available. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

  - `results.documents.eventType` (string)
    Related event type when available.

  - `results.documents.partyId` (string)
    Related party identifier when available. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

  - `results.documents.hash` (string)
    Document content hash.

  - `results.documents.length` (integer)
    Document content length in bytes.

  - `results.sourceChannel` (string)
    Source channel used to create the EviSign entry.

  - `results.reminder` (object)
    Reminder configuration used for signer notifications.

  - `results.reminder.initial` (string)
    Initial delay before sending the first reminder.

  - `results.reminder.repeat` (string)
    Interval used to send repeated reminders.

  - `results.reminder.days` (array)
    Days of the week when reminders can be sent.

  - `results.reminder.timeRange` (array)
    Allowed daily time range for sending reminders.

  - `results.reminder.max` (integer)
    Maximum number of reminders to send.

  - `results.reminder.stop` (string)
    Condition or limit that stops reminder delivery.

  - `results.reminder.timeZone` (string)
    Time zone used to evaluate reminder schedule settings.

  - `results.cancelComments` (string)
    Comments provided when the EviSign was cancelled.

  - `results.affidavitKinds` (array)
    Requested affidavit kinds for this EviSign entry.

  - `results.from` (string)
    Sender address used in notifications.

  - `totalMatches` (integer)
    Total number of entries that match the query criteria.

## Response 400:

  - `400` (unknown)
    Invalid request or business rule failure.

## Response 400 fields (application/json):

  - `responseStatus` (object)

  - `responseStatus.errorCode` (string)
    Holds the custom ErrorCode enum if provided in ValidationException
otherwise will hold the name of the Exception type, e.g. typeof(Exception).Name

A value of non-null means the service encountered an error while processing the request.

  - `responseStatus.message` (string)
    A human friendly error message

  - `responseStatus.stackTrace` (string)

  - `responseStatus.errors` (array)
    For multiple detailed validation errors.
Can hold a specific error message for each named field.

  - `responseStatus.errors.errorCode` (string)

  - `responseStatus.errors.fieldName` (string)

  - `responseStatus.errors.message` (string)

## Response 401:

  - `401` (unknown)
    Authentication failed.

## Response 401 fields (application/json):

  - `responseStatus` (object)

  - `responseStatus.errorCode` (string)
    Holds the custom ErrorCode enum if provided in ValidationException
otherwise will hold the name of the Exception type, e.g. typeof(Exception).Name

A value of non-null means the service encountered an error while processing the request.

  - `responseStatus.message` (string)
    A human friendly error message

  - `responseStatus.stackTrace` (string)

  - `responseStatus.errors` (array)
    For multiple detailed validation errors.
Can hold a specific error message for each named field.

  - `responseStatus.errors.errorCode` (string)

  - `responseStatus.errors.fieldName` (string)

  - `responseStatus.errors.message` (string)

## Response 403:

  - `403` (unknown)
    API, EviSign service, or required operation permission is missing.

## Response 403 fields (application/json):

  - `responseStatus` (object)

  - `responseStatus.errorCode` (string)
    Holds the custom ErrorCode enum if provided in ValidationException
otherwise will hold the name of the Exception type, e.g. typeof(Exception).Name

A value of non-null means the service encountered an error while processing the request.

  - `responseStatus.message` (string)
    A human friendly error message

  - `responseStatus.stackTrace` (string)

  - `responseStatus.errors` (array)
    For multiple detailed validation errors.
Can hold a specific error message for each named field.

  - `responseStatus.errors.errorCode` (string)

  - `responseStatus.errors.fieldName` (string)

  - `responseStatus.errors.message` (string)

## Response 500:

  - `500` (unknown)
    Unexpected server failure.

## Response 500 fields (application/json):

  - `responseStatus` (object)

  - `responseStatus.errorCode` (string)
    Holds the custom ErrorCode enum if provided in ValidationException
otherwise will hold the name of the Exception type, e.g. typeof(Exception).Name

A value of non-null means the service encountered an error while processing the request.

  - `responseStatus.message` (string)
    A human friendly error message

  - `responseStatus.stackTrace` (string)

  - `responseStatus.errors` (array)
    For multiple detailed validation errors.
Can hold a specific error message for each named field.

  - `responseStatus.errors.errorCode` (string)

  - `responseStatus.errors.fieldName` (string)

  - `responseStatus.errors.message` (string)

## Response default:

  - `default` (unknown)
    Error

## Response default fields (application/json):

  - `responseStatus` (object)

  - `responseStatus.errorCode` (string)
    Holds the custom ErrorCode enum if provided in ValidationException
otherwise will hold the name of the Exception type, e.g. typeof(Exception).Name

A value of non-null means the service encountered an error while processing the request.

  - `responseStatus.message` (string)
    A human friendly error message

  - `responseStatus.stackTrace` (string)

  - `responseStatus.errors` (array)
    For multiple detailed validation errors.
Can hold a specific error message for each named field.

  - `responseStatus.errors.errorCode` (string)

  - `responseStatus.errors.fieldName` (string)

  - `responseStatus.errors.message` (string)

