Dados cadastrais do fornecedor

Atualiza nome, e-mail e endereço do fornecedor na análise em preenchimento (pending_submission). Os dados ficam em analysis_data e só passam para o fornecedor (vendor.name, vendor.email, vendor.address) quando a análise é aprovada.

O e-mail é obrigatório para enviar a análise. Se ele já foi informado na criação e você não precisa de endereço, pule esta chamada.

Com a análise concluída (approved, reproved ou canceled), estes dados não mudam mais (409, VRG000010): abra uma nova análise para alterá-los. A conta bancária não depende da análise e continua editável.

Atualizar dados cadastrais

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}/analysis_data

MÉTODO

PUT

Parâmetros de caminho

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

Corpo da requisição

{
    "name": "AUDITORES EXEMPLO S.A.",
    "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"
    }
}

Atributos do corpo

Os três campos são obrigatórios. A chamada substitui os três de uma vez: envie sempre o conjunto completo.

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome ou razão social. Máximo de 255 caracteres.
email	string	Sim	E-mail do fornecedor. Máximo de 255 caracteres.
address	object	Sim	Endereço. Ver atributos de address.

Atributos de address

Campo	Tipo	Obrigatório	Descrição
postal_code	string	Sim	Código postal, de 1 a 20 caracteres. Com country = BRA, CEP no formato NNNNN-NNN.
street	string	Sim	Logradouro, de 1 a 255 caracteres.
number	string	Sim	Número, de 1 a 20 caracteres.
complement	string	Não	Complemento, de 1 a 255 caracteres.
neighborhood	string	Sim	Bairro, de 1 a 255 caracteres.
city	string	Sim	Cidade, de 1 a 255 caracteres.
uf	string	Sim	Unidade federativa, de 1 a 20 caracteres. Com country = BRA, a sigla de dois caracteres do estado (SP, RJ, DF...).
country	string	Sim	País no código ISO 3166-1 alpha-3 (BRA, USA, PRT...).

Resposta

STATUS

200

A resposta é a análise, na estrutura da criação do fornecedor, com analysis_data atualizado.

Trecho da resposta

{
    "analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
    "status": "pending_submission",
    "analysis_data": {
        "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"
        },
        "ai_pending_reasons": null,
        "ai_pending_reason_details": null
    }
}

Erros

STATUS

409

Cadastro em análise pela QI Tech

A análise está em sent_to_analysis, in_manual_analysis ou in_compliance_analysis. Para corrigir, retire a análise da fila ou aguarde o resultado.

{
  "title": "Vendor Registration Under Analysis",
  "description": "The registration of the vendor 5d2e7b9a-3c4f-4e8a-b1d6-9f0a2c3e4b57 is under analysis by QI Tech and cannot be changed until the analysis ends.",
  "translation": "O cadastro deste fornecedor esta em analise pela QI Tech e nao pode ser alterado ate a analise terminar.",
  "code": "VRG000104"
}

Análise concluída

A análise está em approved, reproved ou canceled. Abra uma nova análise e atualize os dados nela.

{
  "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"
}

STATUS

400

País inválido

country não é um código ISO 3166-1 alpha-3, como BRA.

{
  "title": "Invalid Address Country",
  "description": "Address country 'BR' must be a valid ISO 3166-1 alpha-3 country code.",
  "translation": "O pais 'BR' do endereco deve ser um codigo de pais ISO 3166-1 alpha-3 valido.",
  "code": "VRG000088"
}

UF inválida para endereço no Brasil

Com country igual a BRA, uf não é a sigla de uma unidade federativa brasileira.

{
  "title": "Invalid Brazilian Address Uf",
  "description": "Address uf 'XX' must be a valid Brazilian federative unit code when country is BRA.",
  "translation": "A UF 'XX' do endereco deve ser uma unidade federativa brasileira valida quando o pais e BRA.",
  "code": "VRG000056"
}

CEP inválido para endereço no Brasil

Com country igual a BRA, postal_code não está no formato NNNNN-NNN.

{
  "title": "Invalid Brazilian Address Postal Code",
  "description": "Address postal_code '01310100' must match the 'NNNNN-NNN' CEP format when country is BRA.",
  "translation": "O CEP '01310100' do endereco deve seguir o formato 'NNNNN-NNN' quando o pais e BRA.",
  "code": "VRG000057"
}

STATUS

404

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

• Fornecedor pessoa jurídica: Partes relacionadas.
• Fornecedor pessoa física: Documentos.