Envio e cancelamento da análise
Envia a análise para a QI Tech quando os dados, as partes relacionadas e os documentos estão prontos. Depois do envio, o cadastro fica travado: para corrigir algo, retire a análise da fila; para desistir, cancele.
Pré-requisitos do envio
A API confere, nesta ordem, e devolve 400 no primeiro item que faltar:
| Verificação | code |
|---|---|
E-mail do fornecedor informado (analysis_data.email). | VRG000103 |
| Pessoa jurídica: ao menos uma parte relacionada não inativa. | VRG000058 |
Pessoa jurídica: ao menos uma parte com is_representative: true. | VRG000051 |
Documentos obrigatórios do fornecedor: PJ social_contract ou company_statute; PF cnh, rg, rg_front + rg_back ou identification_document. | VRG000064 |
Cada representante com documento de identificação próprio (cnh, rg, rg_front + rg_back, identification_document ou passport). | VRG000066 |
Cada parte do tipo attorney com power_of_attorney próprio. | VRG000083 |
Documentos em valid, in_manual_analysis, inconclusive ou invalid contam para a verificação; canceled não. Conta bancária e grupo de assinantes não são exigidos para enviar.
Enviar para análise
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Escrita |
| Consultoria | consultant-api | Integração ativa |
URL base de cada host: Ambientes (Hosts).
Parâmetros de caminho
| Parâmetro | Tipo | Descrição |
|---|---|---|
analysis_key | string | Chave da análise (UUID). |
{
"status": "sent_to_analysis"
}
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
status | string | Sim | sent_to_analysis ou pending_submission. Nenhum outro valor é aceito. |
sent_to_analysisenvia a análise. Só a partir depending_submission.pending_submissionretira a análise da fila. Só a partir desent_to_analysisouin_manual_analysis. Com a análise já empending_submission, a chamada é aceita e não muda nada: só registra um novo evento no histórico.
Resposta
A análise, na estrutura da criação do fornecedor, com status: sent_to_analysis.
Depois do envio, a QI Tech valida documentos e pessoas e a análise segue sozinha para approved, in_manual_analysis ou in_compliance_analysis. Acompanhe pela consulta de análises.
Retirar da fila de análise
Usa a mesma chamada do envio, com status: pending_submission. Vale enquanto a análise está em sent_to_analysis ou in_manual_analysis; em in_compliance_analysis só é possível cancelar.
{
"status": "pending_submission"
}
A análise volta a pending_submission e o cadastro pode ser editado e reenviado. A validação já feita é descartada: grupos de assinantes pending ficam invalid e as pendências automáticas (ai_pending_reasons) são limpas.
Cancelar análise
Encerra a análise sem aprovação. Vale em qualquer status não final (pending_submission, sent_to_analysis, in_manual_analysis, in_compliance_analysis). O status do fornecedor não muda; um fornecedor active continua active.
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Escrita |
| Consultoria | consultant-api | Integração ativa |
URL base de cada host: Ambientes (Hosts).
Esta chamada não leva corpo.
Resposta
A análise com status: canceled, reproval_reason: null e reproval_details: null. Além disso:
- os apontamentos abertos são fechados;
- os agentes com acesso ao fornecedor recebem um e-mail com a conclusão, nos endereços cadastrados.
Para cadastrar o fornecedor de novo, abra uma nova análise.
Erros
Pré-requisito do envio não atendido
Um dos itens da tabela de pré-requisitos. Exemplo com e-mail ausente:
{
"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"
}
Exemplo com documento obrigatório ausente:
{
"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"
}
Transição de status não permitida
O status atual não permite a transição pedida: por exemplo, sent_to_analysis a partir de in_manual_analysis, pending_submission a partir de in_compliance_analysis, ou qualquer ação sobre uma análise canceled.
{
"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"
}
Análise já aprovada
A análise já está approved. Para mudar o cadastro, abra uma nova análise.
{
"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"
}
Análise já reprovada
A análise já está reproved. Se o motivo foi cadastral, abra uma nova análise.
{
"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"
}
Análise não encontrada
A analysis_key não existe. Se a análise é de um fornecedor que você não vê, o código é VRG000014 (ver erros comuns).
{
"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"
}
Erros de autenticação, permissão e host: veja Erros da API.
Próximo passo
Consulta de análises para acompanhar o resultado, e Apontamentos se a QI Tech pedir algo durante a revisão.