Vendor registration data

Updates the vendor's name, email and address in the analysis being filled in (pending_submission). The data is stored in analysis_data and is only carried over to the vendor (vendor.name, vendor.email, vendor.address) when the analysis is approved.

The email is required to submit the analysis. If it was already provided on creation and you do not need an address, skip this call.

Once the analysis is concluded (approved, reproved or canceled), this data no longer changes (409, VRG000010): open a new analysis to change it. The bank account does not depend on the analysis and remains editable.

Update registration data

Available on

Profile	Host	Required permission
Manager	manager-api	Write
Consultant	consultant-api	Active integration

Base URL for each host: Environments (Hosts).

ENDPOINT

/vendor_registry/analysis/{analysis_key}/analysis_data

METHOD

PUT

Path parameters

Parameter	Type	Description
analysis_key	string	Analysis key (UUID).

Request body

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

Body attributes

All three fields are required. The call replaces all three at once: always send the full set.

Field	Type	Required	Description
name	string	Yes	Name or corporate name. Maximum of 255 characters.
email	string	Yes	Vendor email. Maximum of 255 characters.
address	object	Yes	Address. See address attributes.

address attributes

Field	Type	Required	Description
postal_code	string	Yes	Postal code, from 1 to 20 characters. With country = BRA, a CEP in the NNNNN-NNN format.
street	string	Yes	Street, from 1 to 255 characters.
number	string	Yes	Number, from 1 to 20 characters.
complement	string	No	Complement, from 1 to 255 characters.
neighborhood	string	Yes	Neighborhood, from 1 to 255 characters.
city	string	Yes	City, from 1 to 255 characters.
uf	string	Yes	State (federative unit), from 1 to 20 characters. With country = BRA, the two-letter state code (SP, RJ, DF...).
country	string	Yes	Country as an ISO 3166-1 alpha-3 code (BRA, USA, PRT...).

Response

STATUS

200

The response is the analysis, with the structure of vendor creation and analysis_data updated.

Response excerpt

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

Errors

STATUS

409

Registration under QI Tech analysis

The analysis is in sent_to_analysis, in_manual_analysis or in_compliance_analysis. To make corrections, withdraw the analysis from the queue or wait for the result.

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

Analysis concluded

The analysis is in approved, reproved or canceled. Open a new analysis and update the data there.

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

Invalid country

country is not an ISO 3166-1 alpha-3 code, such as 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"
}

Invalid UF for an address in Brazil

With country set to BRA, uf is not the code of a Brazilian federative unit.

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

Invalid CEP for an address in Brazil

With country set to BRA, postal_code is not in the NNNNN-NNN format.

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

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

• Legal entity vendor: Related parties.
• Individual vendor: Documents.