Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • SecurityTags: Security labels, and they serve to control access to an EviSign. Only users with the same tag will be able to access the same document.
    • It is important to note that tags must be less than 16 characters, and there can only be one tag per EviSign.
    • In the case of Rest/JSON it must be reported as indicated in the specifications below.
  • PushNotificationUrl: URL of contract’s issuer to which EVICERTIA will do a POST when an event related to the contract occurs, sending a JSON with information about the event Therefore, the issuer can develop a controller that allows to capture these requests and proceed to update the status of the contracts in its own information systems.
  • PushNotificationFilter: List of events you would like to be notified of in PushNotificationUrl. Possible values are:
    • Processed: The contract has been admitted in the system and is ready to be sent.
    • Sent: The signature notification has been sent to the signer.
    • Delivered: Confirmation of delivery of signature notification to the signer has been received.
    • Signed: The signer has signed the contract.
    • Rejected: The signer has rejected the contract.
    • FullySigned: All the signers have signed the contract.
    • FullySent: The signature request has been sent to all the signers.
    • FullyDelivered: The signature request has been delivered to all the signers.
    • Closed: The contract is closed, no further events are expected.
  • PushNotificationExtraData: Text field in which the issuer of the contract may indicate additional data. These data will be sent later in each push notification that is made.
  • Issuer: Name to overwrite the issuer of the contractAttachments: List [optional] with message attachments.
    • DisplayName: Name of the attachment.
    • FileName: Name of the file.
    • MimeType[optional]: Information on mime type of attachment.
    • ContentId[optional]: Mime identifier of the attachment.
    • ContentDescription[optional]: Mime description of the attachment.
    • Data: Content (bytes) of the file to be attached.
    • Attributes[optional]: Attributes that we want to indicate about the attachment:
      • Attribute: This property will contain as many Attribute nodes as needed and within them different key-values ​​are allocated:
        • Key: Name of the key.
        • Value: Value for the previous key.
      • Here below are the key-values ​​that can be used in this node:
        • Key = RequireContentCommitment, Value = true, indicates that attachments must be signed, regardless of the contract itself.
        • Key = RequireContentCommitmentOrder, Value = Number, indicates the order number in which the attachment will be displayed:
          • After the Main Document: Positive value greater than '0'.
          • Before the Main Document: Negative value lower than '0'.
          • Notes:
            • Values must be other than 0.
            • For multiple attachments, the values ​​must be different and will be are sorted from highest negative to highest positive.
      • Here below there is an example of a node attachment with a node attributes

        Code Block
         
        
        			[
        				{
        					"UniqueId":"00000000-0000-0000-0000-000000000000",
        					"CreationDate":"0001-01-01T00:00:00",
        					"EvidenceUniqueId":"00000000-0000-0000-0000-000000000000",
        					"DisplayName":"4kb.pdf",
        					"Filename":"4kb.pdf",
        					"Data":"[ATTENTION: attachment BASE64 in PDF format would appear here]",
        					"Attributes": [
        						{
        							"Key":"RequireContentCommitment",
        							"Value":true
        						},
        						{
        							"Key":"RequireContentCommitmentOrder",
        							"Value":1
        						}
        					]
        				}
        			]


...