Documentos da Análise

Após criar a análise, faça o upload dos documentos comprobatórios do fornecedor. É obrigatório ter ao menos um documento antes de submeter a análise para revisão.

Tipos de documento aceitos

• vendor_bylaws — Contrato social do fornecedor
• representative_document — Documento de identificação do representante legal

Status inicial

Documentos enviados via API entram automaticamente com status pending_adm_approval, aguardando revisão da QI Tech.

---

Upload de documento

ENDPOINT

/vendor_registry/analysis/{analysis_key}/document

MÉTODO

POST

Path params

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

Request Body

{
    "name": "Contrato Social - AUDITORES EXEMPLO S.A.",
    "document_type": "vendor_bylaws",
    "document_b64": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwKL0xlbmd0aCAzIDAgUgo..."
}

Atributos do body

Campo	Tipo	Obrigatoriedade	Descrição
name	string	obrigatório	Nome do documento. Máximo de 255 caracteres.
document_type	string	obrigatório	Tipo do documento: vendor_bylaws ou representative_document.
document_b64	string	obrigatório	Conteúdo do arquivo codificado em Base64.

Response

STATUS

201

Response Body

{
    "document_name": "Contrato Social - AUDITORES EXEMPLO S.A.",
    "document_key": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "document_type": "vendor_bylaws",
    "analysis_key": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "status": "pending_adm_approval"
}

Atributos da resposta

Campo	Tipo	Descrição
document_name	string	Nome do documento.
document_key	string	Chave única do documento (UUID).
document_type	string	Tipo do documento: vendor_bylaws ou representative_document.
analysis_key	string	Chave da análise à qual o documento pertence.
status	string	Status do documento. Sempre retorna pending_adm_approval.

---

Listar documentos de uma análise

ENDPOINT

/vendor_registry/analysis/{analysis_key}/documents

MÉTODO

GET

Path params

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

Response

STATUS

200

Response Body

{
    "data": [
        {
            "document_name": "Contrato Social - AUDITORES EXEMPLO S.A.",
            "document_key": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
            "document_type": "vendor_bylaws",
            "analysis_key": "c3d4e5f6-a7b8-9012-cdef-345678901234",
            "status": "pending_adm_approval"
        },
        {
            "document_name": "RG - João da Silva",
            "document_key": "e5f6a7b8-c9d0-1234-ef56-7890abcdef12",
            "document_type": "representative_document",
            "analysis_key": "c3d4e5f6-a7b8-9012-cdef-345678901234",
            "status": "approved"
        }
    ]
}

Atributos da resposta

Campo	Tipo	Descrição
data	array	Lista de documentos da análise.
data[].document_name	string	Nome do documento.
data[].document_key	string	Chave única do documento (UUID).
data[].document_type	string	Tipo do documento.
data[].analysis_key	string	Chave da análise.
data[].status	string	Status do documento: pending_adm_approval, approved ou rejected.

---

Consultar documento por chave

Recupere os dados de um documento específico, incluindo URL de download.

ENDPOINT

/vendor_registry/analysis/{analysis_key}/documents/{document_key}

MÉTODO

GET

Path params

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

Response

STATUS

200

Response Body

{
    "document_name": "Contrato Social - AUDITORES EXEMPLO S.A.",
    "document_key": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "document_type": "vendor_bylaws",
    "analysis_key": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "status": "approved",
    "document_url": "https://storage.example.com/documents/d4e5f6a7-b8c9-0123-def4-567890abcdef?X-Amz-Expires=86400&..."
}

Atributos adicionais

Campo	Tipo	Descrição
document_url	string	URL pré-assinada para download do arquivo. Válida por 24 horas.

---

Possíveis erros

STATUS

404

Análise não encontrada

A analysis_key informada na URL não corresponde a nenhuma análise cadastrada.

{
  "title": "Analysis not found",
  "description": "Analysis with the key {analysis_key} was not found.",
  "translation": "A análise com a chave {analysis_key} não foi encontrada.",
  "code": "VRG000007"
}

Documento não encontrado

A document_key informada na URL não corresponde a nenhum documento desta análise.

{
  "title": "Document not found",
  "description": "Document with the key {document_key} was not found.",
  "translation": "O documento com a chave {document_key} não foi encontrada.",
  "code": "VRG000003"
}

STATUS

400

Formato do documento inválido

O conteúdo em document_b64 não é um Base64 válido.

{
  "title": "Invalid document format",
  "description": "Invalid Document format",
  "translation": "Formato do documento invalido",
  "code": "VRG000004"
}

---

Próximos passos

Com ao menos um documento enviado, prossiga para:

Submeter a análise — encaminhe para revisão da QI Tech.