查询供应商

列出您可见的供应商，并通过 key 获取供应商的全部信息：已通过审核的信息、关联方、银行账户、签署人组以及最近一次审核。

列出供应商

适用范围

角色	主机	所需权限
管理人	manager-api	读取
顾问	consultant-api	有效集成

各主机的 Base URL：环境（主机）。

ENDPOINT

/vendor_registry/vendors

方法

GET

查询参数

参数	类型	必填	说明
status	string	否	供应商状态：pending_analysis、active、inactive、expired。可传入多个值，以逗号分隔。
name	string	否	供应商名称的开头部分，不区分大小写。
document_number	string	否	完整的 CPF 或 CNPJ，可带或不带标点。
analysis_status	string	否	供应商最近一次审核的状态。可传入多个值，以逗号分隔。参见审核状态。
annotation_status	string	否	最近一次审核中最新审核意见的状态：opened 或 closed。使用此筛选条件时，没有审核意见的供应商不会出现在结果中。
agent_document_number	string	否	拥有该供应商的主体的完整 CPF 或 CNPJ，可带或不带标点。
agent_name	string	否	拥有该供应商的主体名称的开头部分，不区分大小写。
limit	integer	否	每页条数，0 至 1000。默认值：10。
page	integer	否	页码，从 0 开始。默认值：0。

返回的供应商按从新到旧排序。包括：

• 您创建的供应商；
• 您通过顾问的合同看到的供应商；
• 代表您所属管理人自身、在其登记到服务时自动创建并通过审核的供应商。

status 或 analysis_status 中的未知值不会报错：只是查不到任何结果。

Exemplo de chamada

GET /vendor_registry/vendors?status=active,expired&limit=50

响应

STATUS

200

Corpo da resposta

{
    "data": [
        {
            "vendor_key": "5d2e7b9a-3c4f-4e8a-b1d6-9f0a2c3e4b57",
            "name": "AUDITORES EXEMPLO S.A.",
            "document_number": "44.555.666/0001-81",
            "email": "contato@auditoresexemplo.com.br",
            "address": {
                "postal_code": "01310-100",
                "street": "Avenida Paulista",
                "number": "1000",
                "complement": "10º andar",
                "neighborhood": "Bela Vista",
                "city": "São Paulo",
                "uf": "SP",
                "country": "BRA"
            },
            "person_type": "legal_person",
            "status": "active",
            "block_reason": null,
            "expiration_date": "2028-11-09",
            "agents": [
                {
                    "agent_key": "a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c",
                    "agent_type": "manager",
                    "name": "EXEMPLO GESTORA LTDA",
                    "document_number": "22.333.444/0001-81",
                    "permission_type": "owner"
                }
            ],
            "related_parties": [
                {
                    "related_party_key": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                    "name": "João da Silva",
                    "document_number": "123.456.789-09",
                    "email": "joao.silva@auditoresexemplo.com.br",
                    "related_party_type": "administrator",
                    "is_representative": true,
                    "ownership_percentage": 50.0,
                    "nationality": "BRA",
                    "passport_number": null,
                    "status": "active"
                }
            ],
            "bank_accounts": [
                {
                    "bank_account_key": "0f9e8d7c-6b5a-4f3e-2d1c-0b9a8f7e6d5c",
                    "transfer_type": "pix",
                    "main_account": true,
                    "status": "active",
                    "pix_key": "44555666000181"
                }
            ],
            "signer_groups": [
                {
                    "signer_group_key": "7e6d5c4b-3a2f-4e1d-9c8b-7a6f5e4d3c2b",
                    "minimum_required_signers": 1,
                    "is_default": true,
                    "signers": [
                        {
                            "name": "João da Silva",
                            "document_number": "123.456.789-09",
                            "email": "joao.silva@auditoresexemplo.com.br",
                            "is_required_signer": true
                        }
                    ],
                    "status": "valid",
                    "analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13"
                }
            ],
            "last_analysis": {
                "analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
                "analysis_number": 1,
                "status": "approved",
                "analysis_related_parties": [
                    {
                        "analysis_related_party_key": "c0ffee00-1111-4222-8333-444455556666",
                        "related_party_key": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                        "name": "João da Silva",
                        "document_number": "123.456.789-09"
                    }
                ],
                "documents": [
                    {
                        "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
                    }
                ],
                "annotations": [],
                "last_updated": "2026-11-09 14:03:21.123456",
                "reproval_reason": null,
                "reproval_details": null,
                "signer_groups": []
            }
        }
    ],
    "limit": 10,
    "page": 0,
    "is_last_page": true
}

供应商属性

字段	类型	说明
vendor_key	string	供应商的 key（UUID）。
name	string	已通过审核的名称；首次通过审核前为创建时提交的名称。
document_number	string	带标点的 CPF 或 CNPJ。
email	string	已通过审核的邮箱（首次通过审核前为创建时提交的邮箱），或 null。
address	object	已通过审核的地址；首次通过审核前为 null。结构与登记信息相同。
person_type	string	natural_person 或 legal_person。
status	string	pending_analysis、active、inactive 或 expired。参见供应商状态。
block_reason	string	供应商被最终拒绝时为 compliance_reproval；否则为 null。
expiration_date	string	登记有效期截止日，YYYY-MM-DD（审核通过后两年）；从未通过审核时以及代表该主体自身的供应商为 null。
agents	array	可访问该供应商的主体（管理人和顾问）：agent_key、agent_type、name、document_number 和 permission_type（owner 或 viewer）。
related_parties	array	任意状态的关联方。参见关联方。
bank_accounts	array	任意状态的银行账户。参见银行账户。
signer_groups	array	任意状态的签署人组。参见签署人组。
last_analysis	object	最近一次审核：analysis_key、analysis_number、status、analysis_related_parties（关联的关联方，含 analysis_related_party_key、related_party_key、name、document_number）、documents（不含 URL）、annotations、last_updated、reproval_reason、reproval_details、signer_groups。没有审核时为 null。

按 key 查询供应商

适用范围

角色	主机	所需权限
管理人	manager-api	读取
顾问	consultant-api	有效集成

各主机的 Base URL：环境（主机）。

ENDPOINT

/vendor_registry/vendor/{vendor_key}

方法

GET

路径参数

参数	类型	说明
vendor_key	string	供应商的 key（UUID）。

响应

STATUS

200

返回一个供应商，结构与列表中 data 的每一项相同。

错误

STATUS

404

未找到供应商

该 vendor_key 不存在，或您看不到该供应商。

{
  "title": "Vendor not found",
  "description": "Vendor with the key 5d2e7b9a-3c4f-4e8a-b1d6-9f0a2c3e4b57 was not found.",
  "translation": "O fornecedor com a chave 5d2e7b9a-3c4f-4e8a-b1d6-9f0a2c3e4b57 nao foi encontrada.",
  "code": "VRG000014"
}

管理人未在服务中登记

在列表查询中：您所属的管理人尚未在供应商服务中登记。请联系 integracao.dtvm@qitech.com.br。

{
  "title": "Agent not found",
  "description": "Agent with the key a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c was not found.",
  "translation": "O agente com a chave a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c nao foi encontrado.",
  "code": "VRG000043"
}

STATUS

400

code	发生情形
QIT000010	limit 或 page 超出范围或不是数字。

认证、权限和主机相关的错误：参见 API 错误。