...
- LookupKey [optional]: Identifier allocated by the user. It can be used later to locate evidence through the query web service (Query).
- Body: Subject of the message to be sent.
- IssuerName: Name or corporate name of message issuer (por example, The name and Fiscal Identity Number (NIF) of the issuer company).
- Recipient: Data about the message’s recipient:
- LegalName [optional]: Name or corporate name of the recipient of the email (for example, The name and Fiscal Identity Number (NIF) of the recipient company).
- EmailAddress: E-mail address of the recipient of the message.
- CarbonCopy: Data relating to the recipient of the copy of the message:
- Name [optional]: Name or company name of the addressee recipient of the copy of the message (e.g. the name and VAT number of the addressee recipient company).
- EmailAddress: E-mail address of the recipient of the copy of the message.
- Options: Sending/processing options of the message:
- CostCentre [optional]: In terms of invoicing, it allows to group sendings. In order to automate invoicing and to allocate expense.
...
- AffidavitKinds: [optional]: List of Affidavit kinds. It specifies which Affidavits will be generated during the process. This parameter is important for invoicing purposes. Values to be displayed are as follows:
- Submitted: An Affidavit will be generated when the message has been processed locally, its contents certified and ready for further transmission.
- SubmittedAdvanced: An Affidavit will be generated when the message was processed locally, its contents certified and included in the Affidavit, ready for further transmission.
- TransmissionResult: An Affidavit will be generated when:
- The system successfully sent the message to the server of the organisation managing the recipient's mailbox.
- The system could not credit the sending of the message to the server of the organisation managing the recipient's mailbox.
- DeliveryResult: An Affidavit will be generated when:
- The system received confirmation of the delivery of the message.
- The system received confirmation that the message was undeliverable.
- Read: An Affidavit will be generated when the system confirmed the opening/reading of the message.
- Committed: An Affidavit will be generated when:
- The addressee recipient made a formal statement accepting the message and its contents.
- The addressee recipient made a formal statement rejecting the message and its contents.
- CommittedAdvanced: An Affidavit will be generated when:
- The addressee recipient made a formal statement accepting the message and its contents. The content will be included in the Affidavit.
- The addressee recipient made a formal statement rejecting the message and its contents. The content will be included in the Affidavit.
- Closed: An Affidavit will be generated when the system terminated the processing of the message when the tracking expiry date was reached.
- ClosedAdvanced: An Affidavit will be generated when the system terminated the processing of the message when the tracking expiry date was reached. The content will be included in the Affidavit.
- Complete: An Affidavit will be generated when the system terminated the processing of the message when the tracking expiry date was reached and generated a tracking summary.
- CompleteAdvanced: An Affidavit will be generated when the system terminated the processing of the message when the tracking expiry date was reached and generated a tracking summary. The content will be included in the Affidavit.
- OnDemand: An Affidavit will be generated when the system issued a new affidavit (on demand) at the request of the issuer with the information collected so far.
- Event: An Affidavit will be generated when the system received an event considered relevant that does not have a specific Kind of affidavit.
- Failed: An Affidavit will be generated when the system received a finalising error that makes it impossible to continue processing the file.
- AffidavitKinds: [optional]: List of Affidavit kinds. It specifies which Affidavits will be generated during the process. This parameter is important for invoicing purposes. Values to be displayed are as follows:
- 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.
- Attachments[optional]: List of message attachments:
- DisplayName: Name of the attachment.
- FileName: Name of the file.
- Data: Content (bytes) of the file to be attached.
- MimeType[optional]: Information on mime type of attachment.
- ContentId[optional]: Mime identifier of the attachment.
- ContentDescription[optional]: Mime description of the attachment.
- Attributes: Attributes that you want to indicate about the attachment [optional].
- Attribute: This property will contain as many Attribute nodes as necessary and within them different key-values will be assigned.
- Key: Name of the key.
- Value: Value for the previous key.
- The following are the key-values that can be used in this node:
- Key = IncludeOnAffidavits, Value = true, indicates that the annex will be included in the affidavits.
- An example of an attachment node with an attributes node is shown below.
Code Block title Example of request in JSON [ { "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: here would be the BASE64 of the attachment in PDF format.]", "Attributes": [ { "Key":"IncludeOnAffidavits", "Value":true } ] } ]
- Attribute: This property will contain as many Attribute nodes as necessary and within them different key-values will be assigned.
...