WS320 - Send attachments for a tax key

WS320 - Our service for sending attachments to a fiscal key

This integration aims to open a request to attach files to a document in Comprovei

Click here to see version history

Update date	Service publication date	Changes
04/17/2026	04/17/2026	Availability of the webservice

Authentication

• Calls will have transport-level authentication (Basic Authentication);
• Request user / password from the account administrator.

Features

• URL

  <https://entregas-api.comprovei.com/v2/ws320>

• Method:

  POST

This integration returns a protocol for monitoring - WS301

Parameters

Example

{
    "documents": [{
        "key": "",
        "attachments": [{
            "filename": "arquivo.pdf",
            "link": "http://myurl/arquivo.pdf",
            "emission_date": "2026-03-23 00:00:00",
            "description": "Meu arquivo para anexar"
        }]
    }]
}

Parameter	Type	Description
key	Alphanumeric	(Mandatory) Key of the invoice sent to Comprovei
attachments	Array	(Required) Object array of type Attachment

Annex

Parameter	Type	Description
description	Alphanumeric	(Required) Description of the file being attached
emission_date	Alphanumeric	(Required) Annex issuance date
filename	Alphanumeric	(Required) File name
link	Uri	(Required) File access URL

Important

All optional fields will be validated if sent, that is, they cannot be blank. If you do not wish to send optional information, do not add the fields.

• Success:

  • Code: 202
    Content:

    {
        "message" : "OK",
        "protocol" : "<protocol>"
    }
    

• Error:

  • Code: 400
    Content:

    {
        "message": "Corpo da requisição está vazio"
    }
    

    {
        "message" : "Documento não encontrada" 
    }
    

    { 
        "message" : "Campos obrigatórios não preenchidos" 
    }