Analysis Notes

During the review, the QI Tech team may open notes — requests for clarification or correction regarding the vendor data or the documents sent. The integrating agent must reply to these notes so that the analysis can proceed.

Note statuses

Status	Description
created	Note created by QI Tech
opened	Note opened, awaiting a reply
closed	Note answered or closed

---

List the notes of an analysis

ENDPOINT

/vendor_registry/analysis/{analysis_key}/annotations

METHOD

GET

Path params

Parameter	Type	Description
analysis_key	string	Unique key of the analysis (UUID)

Query params

Parameter	Type	Required	Description
status	string (list)	optional	Filters notes by status. Values: created, opened, closed. Accepts multiple values.
limit	integer	optional	Number of items per page. Minimum: 0. Maximum: 1000. Default: 10.
page	integer	optional	Page number (zero-based). Default: 0.

Response

STATUS

200

Response Body

{
    "data": [
        {
            "annotation_key": "f6a7b8c9-d0e1-2345-f678-90abcdef1234",
            "annotation_message": "Por favor, envie o contrato social atualizado com as últimas alterações societárias.",
            "annotation_response": null,
            "annotation_datetime": "2026-06-10 14:32:00",
            "analysis_key": "c3d4e5f6-a7b8-9012-cdef-345678901234",
            "status": "opened"
        }
    ],
    "limit": 10,
    "page": 0,
    "is_last_page": true
}

Response attributes

Field	Type	Description
data	array	List of notes.
limit	integer	Number of items per page used in the query.
page	integer	Current page number.
is_last_page	boolean	Indicates whether this is the last page of results.

Attributes of each note in data

Field	Type	Description
annotation_key	string	Unique key of the note (UUID).
annotation_message	string	Message of the note created by QI Tech.
annotation_response	string | null	Reply from the integrating agent, or null if not answered yet.
annotation_datetime	string	Date and time when the note was created.
analysis_key	string	Key of the analysis the note belongs to.
status	string	Note status: created, opened or closed.

---

Query note by key

ENDPOINT

/vendor_registry/analysis/{analysis_key}/annotation/{annotation_key}

METHOD

GET

Path params

Parameter	Type	Description
analysis_key	string	Unique key of the analysis (UUID)
annotation_key	string	Unique key of the note (UUID)

Response

STATUS

200

Response Body

{
    "annotation_key": "f6a7b8c9-d0e1-2345-f678-90abcdef1234",
    "annotation_message": "Por favor, envie o contrato social atualizado com as últimas alterações societárias.",
    "annotation_response": null,
    "annotation_datetime": "2026-06-10 14:32:00",
    "analysis_key": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "status": "opened"
}

---

Reply to a note

ENDPOINT

/vendor_registry/analysis/{analysis_key}/annotation/{annotation_key}/respond

METHOD

PUT

Path params

Parameter	Type	Description
analysis_key	string	Unique key of the analysis (UUID)
annotation_key	string	Unique key of the note (UUID)

Request Body

{
    "annotation_response": "O contrato social atualizado foi enviado no documento 'Contrato Social - AUDITORES EXEMPLO S.A.'."
}

Body attributes

Field	Type	Required	Description
annotation_response	string	required	Reply to the note. Maximum of 200 characters.

Response

STATUS

202

Response Body

{
    "annotation_key": "f6a7b8c9-d0e1-2345-f678-90abcdef1234",
    "annotation_message": "Por favor, envie o contrato social atualizado com as últimas alterações societárias.",
    "annotation_response": "O contrato social atualizado foi enviado no documento 'Contrato Social - AUDITORES EXEMPLO S.A.'.",
    "annotation_datetime": "2026-06-10 14:32:00",
    "analysis_key": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "status": "closed"
}

---

Possible errors

STATUS

404

Note not found

The annotation_key provided in the URL does not correspond to any note of this analysis.

{
  "title": "Annotation not found",
  "description": "Annotation with the key {annotation_key} was not found.",
  "translation": "A anotação com a chave {annotation_key} não foi encontrada.",
  "code": "VRG0000012"
}

STATUS

409

Note already answered

The provided note already has a registered reply.

{
  "title": "Annotation Already Responded",
  "description": "Annotation with key {annotation_key} is already responded.",
  "translation": "Anotação com chave {annotation_key} está respondida.",
  "code": "VRG0000013"
}

---

Next steps

After replying to the notes, wait for QI Tech to resume the analysis. Track the status via:

Query analysis by key — monitor the progress of the analysis.