Confirmação Anual de Dados Comerciais para Subcontas

Os dados comerciais das subcontas devem ser confirmados ou atualizados anualmente.

Acompanhe a expiração por Webhooks e atualize os dados antes da scheduledDate. Se o prazo expirar, o acesso da subconta às funcionalidades da API poderá ser restringido até a regularização.

Como funciona

O objeto commercialInfoExpiration informa o ciclo atual de confirmação:

CampoDescrição
isExpiredIndica se os dados comerciais estão expirados.
scheduledDateData programada para a próxima expiração dos dados comerciais.

Esse objeto é retornado ao criar uma subconta e nas operações de consulta e atualização dos dados comerciais.

Para acompanhar alterações automaticamente, priorize os Webhooks de situação da conta.

%%{init: {"flowchart": {"nodeSpacing": 28,"rankSpacing": 32,"diagramPadding": 8,"padding": 10}}}%%
flowchart TD
    A["Acompanhar Webhooks"] --> B["Receber<br/>ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRING_SOON"]
    B --> C["Confirmar dados<br/>com o titular"]
    C --> D{"Atualizou até<br/>scheduledDate?"}

    D --> DSim(("Sim"))
    D --> DNao(("Não"))

    DSim --> E["Definir nova<br/>scheduledDate"]
    DNao --> F["Receber<br/>ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED"]

    F --> G["Regularizar dados<br/>comercialInfo"]
    G --> H["Restabelecer acesso<br/>à API"]

    classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px,font-size:17px
    classDef decisao fill:#FEF3C7,stroke:#D97706,color:#78350F,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

    classDef respostaSim fill:#22C55E,stroke:#15803D,color:#FFFFFF,stroke-width:3px,font-size:16px
    classDef respostaNao fill:#EF4444,stroke:#B91C1C,color:#FFFFFF,stroke-width:3px,font-size:16px

    class A inicio
    class B,C,F,G validacao
    class D decisao
    class E,H sucesso

    class DSim respostaSim
    class DNao respostaNao

    linkStyle default stroke:#94A3B8,stroke-width:2px
    linkStyle 3 stroke:#22C55E,stroke-width:4px
    linkStyle 4 stroke:#EF4444,stroke-width:4px

1. Acompanhe a expiração por Webhooks

Configure os Webhooks de situação da conta e trate estes eventos:

  • ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRING_SOON: os dados comerciais estão próximos da expiração e devem ser confirmados ou atualizados;
  • ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED: o prazo expirou sem confirmação e as operações da subconta na API serão restringidas.

O evento ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRING_SOON é enviado 40 dias antes da scheduledDate.

Dados comerciais próximos da expiração

{
   "id":"evt_05b708f961d739ea7eba7e4db318f621&368604920",
   "event":"ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRING_SOON",
   "dateCreated":"2024-05-10 16:45:03",
   "accountStatus":{
      "id":"175027c1-029c-41e5-8b9a-e289b9788c33",
      "commercialInfo":"APPROVED",
      "bankAccountInfo":"APPROVED",
      "documentation":"APPROVED",
      "general":"APPROVED"
   },
   "additionalInfo":{
      "scheduledDate":"2025-06-20"
   }
}

Ao receber esse evento, solicite ao titular a confirmação ou atualização dos dados antes da data informada em additionalInfo.scheduledDate.

2. Consulte os dados que precisam ser confirmados

Recupere os dados atuais da subconta para apresentá-los ao titular:

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

Utilize essa consulta quando precisar exibir ou validar os dados antes da confirmação.

Evite consultas recorrentes apenas para descobrir se a data de expiração mudou.

📘

Nota sobre Rate Limits:

Lembre-se que a atualização é anual. Verificações proativas excessivas neste campo podem sobrecarregar sua cota de requisições à API (rate limit). Priorize o uso dos webhooks e, se fizer consultas proativas, faça-as com baixa frequência, ciente de que a data de expiração só muda anualmente ou após uma atualização.

3. Confirme ou atualize os dados comerciais

Após validar as informações com o titular, envie os dados comerciais da subconta:

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

Preencha novamente todas as informações exigidas pelo endpoint. Campos não enviados podem ser interpretados como null, e incomeValue é obrigatório.

Dependendo das informações alteradas, a conta pode passar por uma nova análise, com bloqueio temporário de algumas funcionalidades.

🚧

Importante:

Lembre-se que este endpoint deve ser chamado no contexto da subconta, ou seja, utilizando a access_token da subconta específica.

📘

Atenção

Ao realizar a atualização com sucesso, uma nova scheduledDate será definida no objeto commercialInfoExpiration (retornado na resposta e em consultas futuras) para um ano à frente, e o acesso às funcionalidades da API para aquela subconta permanecerá normal.

Se os dados expirarem

Se a atualização não ocorrer até a scheduledDate, o Asaas envia:

ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED

Dados comerciais expirados

{  
   "id":"evt_05b708f961d739ea7eba7e4db318f621&368604920",  
   "event":"ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED",  
   "dateCreated":"2024-05-10 02:00:00",  
   "accountStatus":{  
      "id":"175027c1-029c-41e5-8b9a-e289b9788c33",  
      "commercialInfo":"APPROVED",  
      "bankAccountInfo":"APPROVED",  
      "documentation":"APPROVED",  
      "general":"APPROVED"  
   },  
   "additionalInfo":{  
      "scheduledDate":"2025-05-10"  
   }  
}
🚧

Importante:

Mesmo quando o evento ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED é disparado, os campos commercialInfo e general dentro do objeto accountStatus (conforme exemplificado acima) podem continuar com o valor APPROVED.

A confirmação anual é independente do fluxo geral de aprovação cadastral. Por isso, commercialInfo e general podem permanecer como APPROVED mesmo com os dados comerciais expirados.

Para identificar a pendência, considere:

  • o evento ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED;
  • commercialInfoExpiration.isExpired igual a true.

O que acontece durante o bloqueio

🚧

Importante:

Ao tentar realizar chamadas para qualquer endpoint da API que esteja bloqueado devido à expiração dos dados comerciais (ou seja, qualquer endpoint diferente dos listados abaixo como acessíveis), sua integração receberá como resposta o código de status HTTP 403 Forbidden. O corpo da resposta de erro incluirá uma mensagem indicando que a ação não pode ser completada devido à pendência na confirmação/atualização dos dados comerciais e a necessidade de regularizá-los para restaurar o acesso.

Para permitir a regularização, estes endpoints permanecem acessíveis:

GET /v3/myAccount/commercialInfo/
POST /v3/myAccount/commercialInfo/

Recupere os dados atuais, confirme ou atualize as informações com o titular e envie novamente pelo POST.

Após a atualização:

  • o acesso às demais funcionalidades da API é restabelecido;
  • commercialInfoExpiration.isExpired volta para false;
  • uma nova scheduledDate é definida.

Como validar a confirmação

Após atualizar os dados, confirme na resposta ou em uma consulta posterior que:

  • commercialInfoExpiration.isExpired está como false;
  • commercialInfoExpiration.scheduledDate foi atualizada para o próximo ciclo anual;
  • as operações da subconta deixaram de retornar HTTP 403, caso ela estivesse bloqueada.

Continue acompanhando os Webhooks para tratar o próximo ciclo sem polling recorrente.

Próximos passos


Did this page help you?