Documentos do fornecedor

Envia, lista, baixa e cancela os documentos de uma análise. O arquivo vai em Base64 no corpo da requisição. Cada chamada existe em duas versões, com o mesmo contrato: para documentos do fornecedor e para documentos de cada parte relacionada.

Envio e cancelamento só são aceitos com a análise em pending_submission (409, VRG000072). Enquanto a análise está com a QI Tech, um documento só entra como resposta a um apontamento. Para corrigir por conta própria, retire a análise da fila.

Tipos de documento

`document_type`	Descrição	Fornecedor PF	Fornecedor PJ	Parte relacionada
`social_contract`	Contrato social		Sim	`parent_company`
`company_statute`	Estatuto social		Sim	`parent_company`
`board_election_record`	Ata de eleição da diretoria		Sim	`parent_company`
`commercial_board_certificate`	Certidão da junta comercial		Sim	`parent_company`
`organizational_chart`	Organograma societário		Sim	`parent_company`
`financial_statements`	Demonstrações financeiras		Sim	`parent_company`
`power_of_attorney`	Procuração		Sim	Sim
`cnh`	CNH	Sim		Sim
`rg`	RG (frente e verso em um arquivo)	Sim		Sim
`rg_front`	RG, frente	Sim		Sim
`rg_back`	RG, verso	Sim		Sim
`identification_document`	Documento de identificação sem tipo definido; a QI Tech reclassifica como `cnh` ou `rg`	Sim		Sim
`passport`	Passaporte			Sim, só com `passport_number`
`proof_of_residence`	Comprovante de endereço	Sim	Sim	Sim
`extra_document`	Documento adicional	Sim	Sim	Sim

Na coluna "Parte relacionada", "Sim" vale para as partes pessoa física. parent_company aceita os mesmos tipos do fornecedor PJ.

Obrigatórios para enviar a análise:

Fornecedor PJ: social_contract ou company_statute.
Fornecedor PF: cnh, rg, rg_front + rg_back ou identification_document.
Cada parte com is_representative: true: um desses mesmos documentos de identificação, ou passport quando tem passport_number.
Cada parte do tipo attorney: power_of_attorney próprio.

Regras do arquivo:

PDF, PNG, JPEG ou ZIP, até 20 MB;
um novo documento do mesmo tipo cancela o anterior. A exceção é extra_document, que pode se repetir.

Status do documento

Status	Descrição
`valid`	Aceito. Tipos sem leitura automática (`proof_of_residence`, `financial_statements`, `organizational_chart`, `extra_document`, `passport`) entram assim; documentos de identificação de pessoa física também, quando o CPF lido confere com o da pessoa.
`in_manual_analysis`	Aguardando a leitura ou a revisão da QI Tech. Status inicial dos demais documentos.
`invalid`	Recusado pela QI Tech.
`inconclusive`	A leitura automática não concluiu; um analista decide.
`canceled`	Cancelado pela gestora ou substituído por outro do mesmo tipo.

Enviar documento do fornecedor

Disponível em

Perfil	Host	Permissão exigida
Gestora	`manager-api`	Escrita
Consultoria	`consultant-api`	Integração ativa

URL base de cada host: Ambientes (Hosts).

ENDPOINT

/vendor_registry/analysis/{analysis_key}/document

MÉTODO

POST

Parâmetros de caminho

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

Corpo da requisição
{
    "name": "contrato_social.pdf",
    "document_type": "social_contract",
    "document_b64": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwKL0xlbmd0aCAzIDAgUgo..."
}

Atributos do corpo

Campo	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome do arquivo, de 1 a 255 caracteres.
`document_type`	string	Sim	Tipo do documento. Ver tipos.
`document_b64`	string	Sim	Conteúdo do arquivo em Base64.

Resposta

STATUS

201

Corpo da resposta
{
    "document_name": "contrato_social.pdf",
    "document_key": "d1e2f3a4-b5c6-4d7e-8f9a-0b1c2d3e4f5a",
    "document_type": "social_contract",
    "file_type": "pdf",
    "analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
    "status": "in_manual_analysis",
    "reference_date": null,
    "data": null
}

Atributos da resposta

Campo	Tipo	Descrição
`document_name`	string	Nome do arquivo.
`document_key`	string	Chave do documento (UUID).
`document_type`	string	Tipo do documento. `identification_document` pode voltar já reclassificado.
`file_type`	string	`pdf`, `png`, `jpeg` ou `zip`, detectado pelo conteúdo.
`analysis_key`	string	Chave da análise.
`status`	string	Status do documento. Ver status.
`reference_date`	string	Data de referência extraída do documento (última alteração consolidada ou data de emissão), `YYYY-MM-DD`, ou `null`.
`data`	object	Dados extraídos na leitura automática, ou `null`.
`document_url`	string	Só na consulta por chave: URL pré-assinada para baixar o arquivo, válida por 24 horas.

Enviar documento de parte relacionada

Mesmo corpo e mesma resposta do documento do fornecedor, com o campo adicional related_party_key na resposta. A parte precisa estar vinculada a esta análise e não pode estar inactive.

ENDPOINT

/vendor_registry/analysis/{analysis_key}/related_party/{related_party_key}/document

MÉTODO

POST

Permissão: Gestora (manager-api): Escrita. Consultoria (consultant-api): Integração ativa.

Listar documentos

Devolve todos os documentos da análise (ou da parte relacionada nesta análise), em qualquer status, sem URL de download e sem paginação.

ENDPOINT

/vendor_registry/analysis/{analysis_key}/documents

MÉTODO

GET

ENDPOINT

/vendor_registry/analysis/{analysis_key}/related_party/{related_party_key}/documents

MÉTODO

GET

Permissão: Gestora (manager-api): Leitura. Consultoria (consultant-api): Integração ativa.

Corpo da resposta
{
    "data": [
        {
            "document_name": "contrato_social.pdf",
            "document_key": "d1e2f3a4-b5c6-4d7e-8f9a-0b1c2d3e4f5a",
            "document_type": "social_contract",
            "file_type": "pdf",
            "analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
            "status": "valid",
            "reference_date": "2025-03-14",
            "data": null
        }
    ]
}

Consultar documento por chave

Devolve o documento com document_url, um link de download válido por 24 horas e servido com o tipo de conteúdo do arquivo. Depois desse prazo, consulte de novo para obter outro link.

ENDPOINT

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

MÉTODO

GET

ENDPOINT

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

MÉTODO

GET

Permissão: Gestora (manager-api): Leitura. Consultoria (consultant-api): Integração ativa.

Corpo da resposta
{
    "document_name": "cnh_joao.pdf",
    "document_key": "e2f3a4b5-c6d7-4e8f-9a0b-1c2d3e4f5a6b",
    "document_type": "cnh",
    "file_type": "pdf",
    "analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
    "status": "valid",
    "related_party_key": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "reference_date": null,
    "data": null,
    "document_url": "https://<link-temporario-de-download>"
}

Cancelar documento

Marca o documento como canceled. Exige a análise em pending_submission. Cancelar um documento já cancelado devolve 204 e não muda nada.

ENDPOINT

/vendor_registry/analysis/{analysis_key}/document/{document_key}

MÉTODO

DELETE

ENDPOINT

/vendor_registry/analysis/{analysis_key}/related_party/{related_party_key}/document/{document_key}

MÉTODO

DELETE

Permissão: Gestora (manager-api): Escrita. Consultoria (consultant-api): Integração ativa.

STATUS

204

Sem corpo na resposta.

Erros

STATUS

409

Cadastro já enviado para análise

A análise não está em pending_submission. Depois do envio, anexe o documento respondendo a um apontamento ou retire a análise da fila.

{
  "title": "Vendor Registration Already Submitted",
  "description": "The current analysis of the vendor 5d2e7b9a-3c4f-4e8a-b1d6-9f0a2c3e4b57 is no longer pending submission, so the registration cannot be edited.",
  "translation": "Cadastro ja enviado para analise.",
  "code": "VRG000072"
}

STATUS

400

`code`	Quando acontece
`VRG000081`	`document_type` não é aceito para o tipo de pessoa do fornecedor.
`VRG000082`	`document_type` não é aceito para o tipo da parte relacionada, ou `passport` para parte sem `passport_number`.
`VRG000080`	Arquivo maior que 20 MB.
`VRG000067`	`document_b64` não é Base64 válido.
`VRG000097`	O conteúdo não é PDF, PNG, JPEG nem ZIP.

Exemplo
{
  "title": "Invalid Document Type For Vendor",
  "description": "This person type of vendor does not accept the cnh document type.",
  "translation": "O tipo de pessoa deste fornecedor nao aceita documentos do tipo cnh.",
  "code": "VRG000081"
}

STATUS

404

`code`	Quando acontece
`VRG000007`	A `analysis_key` não existe. Se a análise é de um fornecedor que você não vê, o código é `VRG000014`.
`VRG000053`	A `related_party_key` não está vinculada a esta análise, ou a parte está `inactive`.
`VRG000003`	A `document_key` não pertence a esta análise (ou a esta parte).

Erros de autenticação, permissão e host: veja Erros da API.

Próximo passo

Conta bancária e Grupo de assinantes, ou vá direto para o envio da análise.

Tipos de documento​

Status do documento​

Enviar documento do fornecedor​

Parâmetros de caminho​

Atributos do corpo​

Resposta​

Atributos da resposta​

Enviar documento de parte relacionada​

Listar documentos​

Consultar documento por chave​

Cancelar documento​

Erros​

Próximo passo​

Tipos de documento

Status do documento

Enviar documento do fornecedor

Parâmetros de caminho

Atributos do corpo

Resposta

Atributos da resposta

Enviar documento de parte relacionada

Listar documentos

Consultar documento por chave

Cancelar documento

Erros

Próximo passo