Features of the ConfirmReceivedDocument Method

The ConfirmReceivedDocument method is used to mark one or multiple documents as received, allowing the system to formally register that the recipient has downloaded or processed these documents. This method is an essential component of the electronic document reception workflow.

General description: 

This method confirms the receipt of documents that have previously been identified as pending. Its primary function is to maintain proper traceability, ensuring the system records whether the document has been downloaded or acknowledged by the user.

This confirmation process is relevant for compliance, auditing, and internal control processes.

Relationship with the GetReceivedDocument method:

The ConfirmReceivedDocument method must be used together with the GetReceivedDocument method:

• GetReceivedDocument retrieves the list of documents that are pending receipt, including their corresponding GlobalDocumentId values.
• ConfirmReceivedDocument uses these IDs to mark the documents as successfully received.

Using both methods ensures that the reception process is handled in sequence and with the correct identifiers.

Method behavior based on the request:

The method returns different messages within the OtherData parameter, depending on the result of the request.

1. When the request is made for a valid document

If the document exists and the confirmation is successful, the response will contain:

"OK"

This indicates that the document has been correctly marked as received.

2. When the same document is confirmed multiple times

If an attempt is made to confirm a document that was already marked as received, the response will be:

"Document with GlobalDocumentId 025eb8e4-9d79-59c6-a40b-87e1ad6ce320 downloaded."

This message indicates that the document had already been processed previously and avoids duplicate tracking entries.

3. When the provided GlobalDocumentId does not exist

If the system cannot find the document associated with the identifier, it returns:

"Document with GlobalDocumentId 00000000-0000-0000-0000-000000000001 not found"

This response indicates that the document does not exist in the system and cannot be marked as received.

Summary: 

• Allows marking one or multiple documents as received.
• Requires obtaining the corresponding IDs through the GetReceivedDocument method.
• Returns clear status messages indicating whether the confirmation was successful, duplicated, or invalid.
• Ensures accurate traceability in the document reception workflow.