Vendor analysis retrieval
Use these calls to track the registration progress after the analysis submission: the analysis by key, a vendor's current analysis, the list of analyses and the history of status changes.
List analyses
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Read |
| Consultant | consultant-api | Active integration |
Base URL for each host: Environments (Hosts).
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | No | Analysis status. Accepts several comma-separated values. See analysis status. |
vendor_key | string | No | Only the analyses of this vendor. |
owner_agent_key | string | No | Only the analyses of the vendors owned by this agent. |
limit | integer | No | Items per page, from 0 to 1000. Default: 10. |
page | integer | No | Page, starting at 0. Default: 0. |
Returns the analyses from the most recent to the oldest. Only vendors visible to you are included: the ones you created, the one that represents you and the ones you see through a consultant's contract.
GET /vendor_registry/analyses?status=in_manual_analysis,in_compliance_analysis
Response
{
"data": [],
"limit": 10,
"page": 0,
"is_last_page": true
}
Each item of data is a full analysis, with the structure described in analysis attributes, with vendor nested.
Retrieve an analysis by key
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Read |
| Consultant | consultant-api | Active integration |
Base URL for each host: Environments (Hosts).
Path parameters
| Parameter | Type | Description |
|---|---|---|
analysis_key | string | Analysis key (UUID). |
Response
An analysis, with the structure described in analysis attributes. In a rejected analysis, reproval_reason and reproval_details give the reason; in in_manual_analysis, ai_pending_reasons in analysis_data lists the issues flagged by the automated validation.
Retrieve the vendor's current analysis
Returns the most recent analysis that is neither reproved nor canceled: the analysis in progress, if any, or the last approved one. If all analyses were rejected or canceled, returns the most recent one.
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Read |
| Consultant | consultant-api | Active integration |
Base URL for each host: Environments (Hosts).
Response
An analysis, with the same structure as the retrieval by key.
Vendor status history
Lists all status changes of all the vendor's analyses, from oldest to newest. Not paginated.
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Read |
| Consultant | consultant-api | Active integration |
Base URL for each host: Environments (Hosts).
Response
{
"data": [
{
"analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
"status": "pending_submission",
"event_datetime": "2026-11-01 12:00:00.418302",
"author_type": "qitech",
"author_name": null,
"reproval_reason": null,
"reproval_details": null
},
{
"analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
"status": "sent_to_analysis",
"event_datetime": "2026-11-01 12:30:05.913477",
"author_type": "manager",
"author_name": "Maria Souza",
"reproval_reason": null,
"reproval_details": null
},
{
"analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
"status": "reproved",
"event_datetime": "2026-11-02 09:10:41.207815",
"author_type": "qitech",
"author_name": null,
"reproval_reason": "missing_documents",
"reproval_details": "Falta o comprovante de endereço atualizado."
}
]
}
Attributes of each event
| Field | Type | Description |
|---|---|---|
analysis_key | string | Analysis the event belongs to. |
status | string | Status the analysis moved to. |
event_datetime | string | When the change happened. |
author_type | string | manager or consultant when the change was made by a portal user; qitech in all other cases, including automatic transitions, QI Tech decisions and calls made through the API with an integration key. |
author_name | string | Portal user's name, or null when author_type is qitech. |
reproval_reason | string | Filled only in the last reproved event of each analysis; null in the others. |
reproval_details | string | Filled only in the last reproved event of each analysis; null in the others. |
Registration summary
Counts your vendors by status and the analyses by situation within a period. Only your own vendors are included: the ones you created and the one that represents you.
There are two calls: GET /vendor_registry/agent returns your agent_key, which goes in the path of GET /vendor_registry/agent/{agent_key}/summary.
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Read |
| Consultant | consultant-api | Active integration |
Base URL for each host: Environments (Hosts).
{
"agent_key": "a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c",
"agent_type": "manager",
"name": "EXEMPLO GESTORA LTDA",
"document_number": "22.333.444/0001-81"
}
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
date_range_start | string | No | Period start, YYYY-MM-DD. |
date_range_end | string | No | Period end, YYYY-MM-DD. |
If either date is missing, the period runs from the first day of the current month until today.
{
"period": {
"start": "2026-11-01",
"end": "2026-11-09"
},
"vendors": {
"total": 12,
"active": 7,
"inactive": 1,
"pending_analysis": 3,
"expired": 1
},
"analyses": {
"total": 12,
"pending_submission": 2,
"sent_to_analysis": 1,
"in_manual_analysis": 1,
"in_compliance_analysis": 0,
"approved": 7,
"reproved": 1,
"canceled": 0,
"approved_in_period": 2,
"pending_annotation": 1
}
}
Summary attributes
| Field | Description |
|---|---|
vendors.* | The agent's vendors by status, across the whole history. |
analyses.approved | Vendors whose last analysis is approved, across the whole history. |
analyses.pending_submission to analyses.canceled | Vendors whose last analysis is in that status and changed status within the period. |
analyses.total | Sum of the seven statuses above. |
analyses.approved_in_period | Approvals that took place in the period, from any analysis. |
analyses.pending_annotation | Vendors whose most recent annotation in the last analysis is opened. |
Errors
code | When it happens |
|---|---|
VRG000007 | The analysis_key does not exist. |
VRG000014 | The vendor_key does not exist or the vendor is not visible to you. Also when the analysis_key exists but belongs to a vendor you cannot see. |
VRG000043 | Your manager is not registered in the vendor service yet. Contact integracao.dtvm@qitech.com.br. |
Another agent's summary
The agent_key in the path is not yours. Use the one returned by GET /vendor_registry/agent.
{
"title": "Forbidden",
"description": "The selected agent is not allowed to access this agent's resources.",
"translation": "O agente selecionado nao tem permissao para acessar os recursos deste agente.",
"code": "VRG000033"
}
code | When it happens |
|---|---|
QIT000010 | limit, page or one of the dates is in an invalid format. |
Authentication, permission and host errors: see API Errors.