Offboarding de pessoa jurídica

O evento de offboarding de pessoa jurídica dispara uma mensagem que comunica ao destinatário o cancelamento do cadastro do cliente pessoa jurídica.

Como esses eventos chegam ao recebedor via webhook, é preciso realizar previamente a sua configuração.

Contexto e nome do evento

No evento de offboarding de pessoa jurídica, o campo context sempre informará “Business”, e o campo name será descrito conforme a tabela a seguir:

EntityId

O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão.

No contexto de pessoa física, o entityId é o identificador único do cliente.

Exemplo de evento

{
 "correlationId": "string",
 "entityId": "string",
 "companyKey": "string",
 "idempotencyKey": "string",
 "context": "Business",
 "name": "BUSINESS_WAS_CANCELED",
 "timestamp": "9999-99-99T23:59:59.999Z",
  "data": {
   "document": {
    "value": "00000000000000",
    "type": "CNPJ"
   },
   "businessName": "string",
   "tradingName": "string",
   "businessType": "MEI",
   "businessSize": "MEI",
   "address": {
    "zipcode": "00000000",
    "addressLine": "string",
    "buildingNumber": "string",
    "complement": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "country": "string"
    },
   "owners": 
   [{
    "document": {
     "value": "00000000000",
     "type": "CPF"
    },
    "registerName": "string",
    "socialName": "string",
    "birthDate": "9999-99-99",
    "phone": {
     "countryCode": "55",
     "number": "00999999999"
    },
    "address": {
     "zipcode": "00000000",
     "addressLine": "string",
     "buildingNumber": "string",
     "complement": "string",
     "neighborhood": "string",
     "city": "string",
     "state": "string",
     "country": "string"
    },
    "motherName": "string",
    "email": "[email protected]"
   }],
   "legalRepresentatives": 
   [{
    "document": {
     "value": "00000000000",
     "type": "CPF"
    },
    "registerName": "string",
    "socialName": "string",
    "birthDate": "9999-99-99",
    "phone": {
     "countryCode": "55",
     "number": "00999999999"
    },
    "address": {
     "zipcode": "00000000",
     "addressLine": "string",
     "buildingNumber": "string",
     "complement": "string",
     "neighborhood": "string",
     "city": "string",
     "state": "string",
     "country": "string"
    },
   "motherName": "string",
   "email": "[email protected]"
   }],
  "status": "CANCELED",
  "isBanklyPartner": false,
  "createdAt": "9999-99-99T23:59:59.999Z",
  "updatedAt": "9999-99-99T23:59:59.999Z"
 }
}

🚧

Importante

Para conhecer a estrutura básica dos eventos com os campos que chegarão à sua API, consulte nossa documentação específica de Eventos.

Objeto data no evento de offboarding de pessoa jurídica

O objeto data traz detalhes específicos do contexto em que o evento ocorre. No caso do evento de offboarding de pessoa jurídica, esse objeto trará os seguintes campos:

• document: objeto que contém o número e o tipo do documento, que neste contexto será o “CNPJ” da empresa;
• businessName: razão social da empresa;
• tradingName: nome fantasia, também conhecido como nome comercial;
• businessType: tipo de negócio;
• businessSize: porte da empresa;
• address: objeto que contém os dados do endereço comercial ou residencial;
• owners: lista dos donos da empresa, contendo o objeto address e os subcampos comuns;
• legalRepresentatives: lista dos representantes legais da empresa, contendo o objeto address e os subcampos comuns;
• isPoliticallyExposedPerson: informa se o dono ou representante legal da empresa é uma pessoa politicamente exposta;
• status: status do cadastro, o qual será: "CANCELED";
• isBanklyPartner: informa se a empresa tem parceria com o Bankly;
• updatedAt: data da última atualização do status de cadastro;
• createdAt: a data de cadastro do cliente.

Subcampos comuns aos campos owners e legalRepresentatives:

• registerName: nome do dono ou representante legal da empresa como consta no documento;
• socialName: nome social do dono ou representante legal da empresa;
• birthDate: data de nascimento do dono ou representante legal da empresa;
• phone: objeto que contém o DDD e o número do telefone do dono ou representante legal da empresa;
• motherName: nome da mãe do dono ou representante legal da empresa como consta no documento de identidade;
• email: e-mail do dono ou representante legal da empresa.