Analysis submission and cancellation
Submits the analysis to QI Tech once the data, the related parties and the documents are ready. After submission, the registration is locked: to correct something, withdraw the analysis from the queue; to give up, cancel it.
Submission prerequisites
The API checks the following, in this order, and returns 400 on the first missing item:
| Check | code |
|---|---|
Vendor email provided (analysis_data.email). | VRG000103 |
| Legal entity: at least one related party that is not inactive. | VRG000058 |
Legal entity: at least one party with is_representative: true. | VRG000051 |
Required vendor documents: legal entity social_contract or company_statute; individual cnh, rg, rg_front + rg_back or identification_document. | VRG000064 |
Each representative with its own identification document (cnh, rg, rg_front + rg_back, identification_document or passport). | VRG000066 |
Each party of type attorney with its own power_of_attorney. | VRG000083 |
Documents in valid, in_manual_analysis, inconclusive or invalid count for the check; canceled ones do not. Bank account and signer group are not required to submit.
Submit for analysis
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Write |
| Consultant | consultant-api | Active integration |
Base URL for each host: Environments (Hosts).
Path parameters
| Parameter | Type | Description |
|---|---|---|
analysis_key | string | Analysis key (UUID). |
{
"status": "sent_to_analysis"
}
| Field | Type | Required | Description |
|---|---|---|---|
status | string | Yes | sent_to_analysis or pending_submission. No other value is accepted. |
sent_to_analysissubmits the analysis. Only frompending_submission.pending_submissionwithdraws the analysis from the queue. Only fromsent_to_analysisorin_manual_analysis. With the analysis already inpending_submission, the call is accepted and changes nothing: it only records a new event in the history.
Response
The analysis, with the structure of vendor creation, with status: sent_to_analysis.
After submission, QI Tech validates documents and people and the analysis moves on its own to approved, in_manual_analysis or in_compliance_analysis. Track it through the analysis retrieval.
Withdraw from the analysis queue
Uses the same call as the submission, with status: pending_submission. Available while the analysis is in sent_to_analysis or in_manual_analysis; in in_compliance_analysis the only option is to cancel.
{
"status": "pending_submission"
}
The analysis returns to pending_submission and the registration can be edited and resubmitted. The validation already performed is discarded: pending signer groups become invalid and the automated issues (ai_pending_reasons) are cleared.
Cancel the analysis
Closes the analysis without approval. Available in any non-final status (pending_submission, sent_to_analysis, in_manual_analysis, in_compliance_analysis). The vendor status does not change; an active vendor stays active.
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Write |
| Consultant | consultant-api | Active integration |
Base URL for each host: Environments (Hosts).
This call takes no body.
Response
The analysis with status: canceled, reproval_reason: null and reproval_details: null. In addition:
- open annotations are closed;
- the agents with access to the vendor receive an email with the outcome, at their registered addresses.
To register the vendor again, open a new analysis.
Errors
Submission prerequisite not met
One of the items in the prerequisites table. Example with a missing email:
{
"title": "Analysis Submission Must Have Email",
"description": "The analysis 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 has no vendor email and cannot be submitted.",
"translation": "Informe o e-mail do fornecedor antes de enviar o cadastro para analise.",
"code": "VRG000103"
}
Example with a missing required document:
{
"title": "Analysis Submission Must Have Required Documents",
"description": "The analysis 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 does not have every document required for a legal_person vendor.",
"translation": "A analise 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 nao possui todos os documentos obrigatorios para um fornecedor legal_person.",
"code": "VRG000064"
}
Status transition not allowed
The current status does not allow the requested transition: for example, sent_to_analysis from in_manual_analysis, pending_submission from in_compliance_analysis, or any action on a canceled analysis.
{
"title": "Analysis Status Transition Denied",
"description": "Analysis with key 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 is not allowed to switch status from in_compliance_analysis to pending_submission.",
"translation": "Analise com chave 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 nao pode trocar de status de in_compliance_analysis para pending_submission.",
"code": "VRG000008"
}
Analysis already approved
The analysis is already approved. To change the registration, open a new analysis.
{
"title": "Completed Analysis",
"description": "Analysis with key 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 is already completed, it can't be updated.",
"translation": "Analise com chave 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 esta finalizada, nao pode ser atualizada.",
"code": "VRG000010"
}
Analysis already rejected
The analysis is already reproved. If the reason was a registration one, open a new analysis.
{
"title": "Reproved Analysis",
"description": "The analysis 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 was already reproved and cannot change status.",
"translation": "A analise 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 ja foi reprovada e nao pode mudar de status.",
"code": "VRG000065"
}
Analysis not found
The analysis_key does not exist. If the analysis belongs to a vendor you cannot see, the code is VRG000014 (see common errors).
{
"title": "Analysis not found",
"description": "Analysis with the key 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 was not found.",
"translation": "A analise com a chave 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 nao foi encontrada.",
"code": "VRG000007"
}
Authentication, permission and host errors: see API Errors.
Next step
Analysis retrieval to track the result, and Annotations if QI Tech asks for something during the review.