EviSignQuery

This operation allows to consult any EviSigns existing in the system by the following fields:

WithUniqueIds[optional]: List of identifiers (UniqueId) for evidences for query.
WithLookupKeys[optional]: List of locators (LookupKey) for evidences for query.
OnState[optional]: Return only those contracts that are in the processing state specified (Closed,Processed, Sent, Submitted, Unknown).
WithOutcome[optional]: Return only those contracts that have obtained the result specified (Cancelled, Expired, Failed, None, Rejected, Signed).
Limit[optional]: Number of items to be returned.
Offset[optional]: It allows to page the results and only those results from the specified result will be returned.
IncludeDocumentOnResult [optional] (True (1) o False (0): It specifies whether the document/contract should be included in the result delivered:
- True o 1: The document/contract must be included in the result.
- False o 0: The document/contract must not be included in the result.
IncludeAffidavitsOnResult[optional] (True (1) o False (0): It specifies whether your list of affidavits should be included in the result delivered:
- True o 1: The list of Affidavits must be included in the result.
- False o 0: The list of affidavits must not be included in the result.
IncludeAffidavitBlobsOnResult [optional] (True (1) o False (0): It specifies whether the bytes of Affidavits should be included in the result. Default value FALSE:
- True o 1: The bytes of the affidavits must be included in the result.
- False o 0: The bytes of the affidavits must not be included in the result.
IncludeAttachmentsOnResult [optional] (True (1) o False (0): It specifies whether your list of attachments should be included in the result delivered:
- True o 1: The list of attachments must be included in the result.
- False o 0: The list of attachments must not be included in the result.
IncludeAttachmentBlobsOnResult [optional] (True (1) o False (0): It specifies whether the bytes of attachments should be included in the result. Default value FALSE:
- True o 1: The bytes of the attachments must be included in the result.
- False o 0: The byte of the attachments must not be included in the result.

From all above mentioned, EVICERTIA recommends to search using the field WithUniqueiIds.

Example of request

GET https://app.ecertia.com/api/EviSign/Query?WithUniqueIds=568a7105-21f8-4be1-b4ea-a7f900c4bf59&includeAffidavitsOnResult=true&includeAttachmentsOnResult=true&includeAffidavitBlobsOnResult=false&includeAttachmentBlobsOnResult=false
Content-Type: application/json
Accept: application/json
Authorization: basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==
Host: app.ecertia.com

The result of this operation will include the following data:

TotalMatches: Number of logs (total) matching the query.
Results: List of EviSigns included in the response (depending on the Limit/Offset parameters of the original request):
- EvidenceId: Unique identifier allocated to the evidence.
- LookupKey: Locator allocated to the evidence by user at the time of submit.
  - When node is set to “true” EviSignSubmit.CustomFields.CustomField.IsLookupKey, this information will be displayed in node EviSignQuery.LookupKey.
    - Information appearing in node EviSignSubmit.LookupKey s the information included in the node: EviSignSubmit.CustomFields.CustomField.Value
    - It should be taken into account that like node EviSignSubmit EviSignSubmit.CustomFields.CustomField.Value can be repeated several times, so in node EviSignQuery.LookupKey it is separated by "::". Below is an example of LookupKey in a response of EviSignQuery.
    - As shown in the below example, two different EviSignSubmit.CustomFields.CustomField.Value , were issued, one with value A0000000 and the other one 7777A.
- Subject: Subject of the message.
- Document: Document or constitutive contract of this EviSign.
- SigningParties: List of signers of this EviSign, with the following data for each signer:
  - PartyId: Unique identifier associated to this signer.
  - Name: Full name of the signer.
  - Address: Email address or phone number of the signer.
  - SigningMethod: Type of signature to request (WebClick, EmailCode, DynamicSignature, and so on).
  - SignatureFields: List of data collected during the signature process:
    - Key: Question identifier, which will serve the transmitting system to find the answer given by the user.
    - Value: Text entered by the user as an answer to the question.
  - Role: The signer's role (Signer or Reviewer):
    - Signer: Signer of the document.
    - Reviewer: Reviewer of the document.
  - SigningOrder: The order in relation to the rest of signers in which the signature will take place. If it does not appear, an order will not have been specified for this signer.
- InterestedParties: List of interested parties in the signing process of this EviSign, with the following data for each interested party:
  - PartyId: Unique identifier associated to this interested party.
  - Address: Email address or phone number of the interested party.
- State: Current status of EviSign processing:
  - Closed : Tracking of evidence generation has ended.
  - Processed : The request has been processed and the signers will be notified.
  - Sent : The request has been notified to the signers and the system is waiting.
  - Submitted : The request has been received by the system, remaining to be processed by the system.
  - Unknown : Unknown state (Contact support).
- Outcome:Outcome of the contract processing.
  - Cancelled : The request was cancelled by the contract issuer.
  - Expired : The request has expired without being signed by all parties.
  - Failed : The request could not be delivered to all interested parties for signature.
  - None : The request has not been completed yet, so there is no result (yet).
  - Rejected : The request has been rejected by any of the parties.
  - Signed : LThe request has been signed by all parties.
- CreationDate: Creation time/date of the message.
- LastStateChangeDate: Fecha/Hora del último cambio de estado.
- Affidavits: List of affidavits associated to the message:
  - UniqueId: Date/time of last status change.
  - Date: Creation time/date of affidavit.
  - EvidenceUniqueId: Unique identifier of the evidence to which this affidavit belongs.
  - Description: Description of affidavit.
  - Bytes: Data (bytes) of affidavit.
  - Kind: Type identifier of the generated affidavit. Kinds of Affidavits.
- Attachments: List of attachments associated to message:
  - UniqueId: Unique identifier associated to the attachment.
  - Date: Creation time/date of attachment.
  - EvidenceUniqueId: Unique identifier of the evidence to which this affidavit belongs.
  - DisplayName: Description/Name of the attachment.
  - FileName: Name of the attachment file.
  - MimeType: Identifier of mime type of attachment.
  - Data: Data (bytes) of affidavit.
  - Hash: Cryptographic summary of the attachment.
- TimeToLive (minutes): Time (in minutes) that the message/contract will be available before proceeding to close the tracking of the message. In those cases in which the notification/contract is accessible via a link, once that period has elapsed and if it has never been accessed, this link is no longer available.
- OnlineRetentionPeriod: Time (in years) of online retention.
- NotaryRetentionPeriod: Time (in years) of retention at the notary's office.
- NotaryProfile: Notary’s identifier who will carry out custody at the notary’s office
- SourceChannel: Indicates the channel through which the evidence was issued (Web, Api, Smtp).
- Reminders: Setting up EviSign signature reminders
  - Initial: Specifies the time period (days or weeks) after which the first signature reminder will be sent. ( referenced to EviSignSubmit_InitialReminder.Period)
  - Repeat: Indicates the frequency with which the set configuration for signature reminders is repeated.
  - Days: Indicates the days of the week selected for sending signature reminders.
  - TimeRange: Indicates the range of hours selected for sending signature reminders.
  - Max: Indicates the maximum number of signature reminders that can be sent during the lifetime of the signature process.
  - Stop: Deadline for sending the last signature reminder.
  - TimeZone: Indicates the time zone configured for sending the reminders, by default it is Etc/GMT0.
- CancelComments: If the EviSign is cancelled and a reason is given as to why, it will appear in this property.
- AffidavitKinds: Displays the types of affidavits selected in the issue. Kinds of Affidavits.

Example of LookupKey

	{
		"results": [
			{
				"EvidenceId": "61d195aa-50c3-4e89-bd6a-a2f000abf656",
				"LookupKey": "A0000000::7777A",
				"Subject": "ES-Pers-Evide-AddiFields-IsLookupkey-true-NoLookupkey",
				"State": "Sent"
			}
		]
	}

Example of answer in JSON

{
	"Results":
	[
		{
			"EvidenceId":"4c77f058-3077-49b4-afe6-a1760001cc0d",
			"LookupKey":"EviSign",
			"Subject":"ContratoSOAP",
			"Document":"[ATTENTION: BASE64 of PDF file would follow here.]",
			"State":"Closed",
			"Outcome":"Signed",
			"CreationDate":"2013-03-03T00:06:32.581634+01:00",
			"LastStateChangeDate":"2013-03-03T00:09:55+01:00",
			"SubmittedOn":"2013-03-03T00:06:32+01:00",
			"ProcessedOn":"2013-03-03T00:06:34+01:00",
			"SentOn":"2013-03-03T00:06:37+01:00",
			"ClosedOn":"2013-03-03T00:09:55+01:00",
			"SignedOn":"2013-03-03T00:09:55+01:00",
			"SigningParties":
			[
				{
					"PartyId":"50070165-a3f9-4478-951e-a1760001cc38",
					"Name":"Pruebas_evi HOT",
					"Address":"pruebas_evi@hotmail.com",
					"SigningMethod":"EmailPin"
				}
			]
			"InterestedParties":
			[
				{
					"PartyId":"145fb68b-3e2e-45b0-bb83-a1760001cc38",
					"Address":"juan@gallegomolero.es"
				}
			]
			"Affidavits":
			[
				{
					"UniqueId":"00000000-0000-0000-0000-000000000000",
					"Date":"2013-03-03T00:09:55+01:00",
					"EvidenceUniqueId":"4c77f058-3077-49b4-afe6-a1760001cc0d",
					"PartyUniqueId":"00000000-0000-0000-0000-000000000000",
					"Bytes":"[ATTENTION: BASE64 of PDF file would follow here.]",
					"Description":"Signed document"
				}
				{
					"UniqueId":"00000000-0000-0000-0000-000000000000",
					"Date":"2013-03-03T00:08:09+01:00",
					"EvidenceUniqueId":"4c77f058-3077-49b4-afe6-a1760001cc0d",
					"PartyUniqueId":"50070165-a3f9-4478-951e-a1760001cc38",
					"Bytes":"[ATENCION: aquí vendría el BASE64 del archivo PDF]",
					"Description":"Signature of Tests_evi HOT"
				}
			]
			"Attachments":{}
		}
	}
"TotalMatches":1
}

Note: for a higher compression BASE64 of PDF file has been replaced by the tag "[ATTENTION: BASE64 for the PDF file would appear here]".

Page tree

EviSignQuery