Anotações da Análise

Durante a revisão, a equipe da QI Tech pode abrir anotações — solicitações de esclarecimento ou correção sobre os dados do fornecedor ou os documentos enviados. O agente integrador deve responder a essas anotações para que a análise prossiga.

Status das anotações

Status	Descrição
created	Anotação criada pela QI Tech
opened	Anotação aberta, aguardando resposta
closed	Anotação respondida ou encerrada

---

Listar anotações de uma análise

ENDPOINT

/vendor_registry/analysis/{analysis_key}/annotations

MÉTODO

GET

Path params

Parâmetro	Tipo	Descrição
analysis_key	string	Chave única da análise (UUID)

Query params

Parâmetro	Tipo	Obrigatoriedade	Descrição
status	string (lista)	opcional	Filtra anotações pelo status. Valores: created, opened, closed. Aceita múltiplos valores.
limit	integer	opcional	Número de itens por página. Mínimo: 0. Máximo: 1000. Padrão: 10.
page	integer	opcional	Número da página (base zero). Padrão: 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
}

Atributos da resposta

Campo	Tipo	Descrição
data	array	Lista de anotações.
limit	integer	Número de itens por página utilizado na consulta.
page	integer	Número da página atual.
is_last_page	boolean	Indica se esta é a última página de resultados.

Atributos de cada anotação em data

Campo	Tipo	Descrição
annotation_key	string	Chave única da anotação (UUID).
annotation_message	string	Mensagem da anotação criada pela QI Tech.
annotation_response	string | null	Resposta do agente integrador, ou null se ainda não respondida.
annotation_datetime	string	Data e hora em que a anotação foi criada.
analysis_key	string	Chave da análise à qual a anotação pertence.
status	string	Status da anotação: created, opened ou closed.

---

Consultar anotação por chave

ENDPOINT

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

MÉTODO

GET

Path params

Parâmetro	Tipo	Descrição
analysis_key	string	Chave única da análise (UUID)
annotation_key	string	Chave única da anotação (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"
}

---

Responder a uma anotação

ENDPOINT

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

MÉTODO

PUT

Path params

Parâmetro	Tipo	Descrição
analysis_key	string	Chave única da análise (UUID)
annotation_key	string	Chave única da anotação (UUID)

Request Body

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

Atributos do body

Campo	Tipo	Obrigatoriedade	Descrição
annotation_response	string	obrigatório	Resposta à anotação. Máximo de 200 caracteres.

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"
}

---

Possíveis erros

STATUS

404

Anotação não encontrada

A annotation_key informada na URL não corresponde a nenhuma anotação desta análise.

{
  "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

Anotação já respondida

A anotação informada já possui uma resposta registrada.

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

---

Próximos passos

Após responder às anotações, aguarde a QI Tech retomar a análise. Acompanhe o status via:

Consultar análise por chave — monitore o andamento da análise.