Alterar o nome de uma subconta PJ via API

Para alterar a Razão Social ou o Nome Fantasia de uma subconta PJ, primeiro consulte os nomes disponíveis para o CNPJ e depois atualize os dados comerciais utilizando exatamente um dos valores retornados.

Antes de começar

Realize as duas requisições com a access_token da subconta que será alterada.

O nome não pode ser definido livremente. O valor enviado deve corresponder a uma das opções disponíveis para o CNPJ da subconta.

Como funciona

%%{init: {"flowchart": {"nodeSpacing": 28,"rankSpacing": 32,"diagramPadding": 8,"padding": 10}}}%%
flowchart TD
    A["Consultar dados comerciais"] --> B["Obter availableCompanyNames"]
    B --> C["Escolher um nome disponível"]
    C --> D["Atualizar companyName"]
    D --> E["Validar o novo nome"]

    classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px,font-size:17px
    classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px,font-size:17px
    classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px,font-size:17px

    class A inicio
    class B,C,D validacao
    class E sucesso

    linkStyle default stroke:#94A3B8,stroke-width:2px

1. Consulte os nomes disponíveis

Consulte os dados comerciais da subconta:

GET /v3/myAccount/commercialInfo/
Confira a referência completa deste endpoint

A resposta contém o atributo availableCompanyNames, com as opções de Razão Social e Nome Fantasia disponíveis para o CNPJ.

{  
  "object": "commercialInfo",  
  "email": "[email protected]",  
  "companyName": "NOME ANTIGO DA EMPRESA LTDA",  
  "availableCompanyNames": [  
    "NOME ATUALIZADO DA EMPRESA LTDA",  
    "NOME FANTASIA ATUALIZADO"  
  ],  
  // ... outros campos  
}

Escolha um dos valores retornados em availableCompanyNames. Esse valor será utilizado no próximo passo.

2. Atualize o nome da empresa

Atualize os dados comerciais da mesma subconta:

POST /v3/myAccount/commercialInfo/
Confira a referência completa deste endpoint

Informe no campo companyName exatamente um dos valores retornados anteriormente em availableCompanyNames, junto aos demais atributos necessários para atualizar os dados comerciais.

Não envie um nome customizado que não tenha sido retornado pela consulta.

Como validar a alteração

Após a atualização, confirme que companyName possui o valor escolhido.

Se precisar recuperar o estado atual posteriormente, consulte novamente:

GET /v3/myAccount/commercialInfo/

A alteração está concluída quando o nome cadastrado corresponde ao valor selecionado em availableCompanyNames.

Próximos passos

• Recupere os dados comerciais da subconta
• Atualize os dados comerciais
• Implemente a Confirmação Anual de Dados Comerciais