LTDA, S.A. e TS

stable

Os eventos referentes a cliente pessoa jurídica LTDA, S.A. e TS disparam mensagens que comunicam ao destinatário informações sobre o seu processo de cadastro e descadastro, como o recebimento da solicitação, a aprovação, reprovação e o cancelamento.

Pré-requisitos

Para receber esses eventos, o parceiro deverá:

Informações sobre os eventos

Contexto e nome do evento

Os campos context e name poderão variar de acordo com a tabela a seguir:

Contexto (context)Nome do evento (name)Descrição
businessBUSINESS_WAS_RECEIVEDA solicitação de cadastro do cliente foi recebida.
businessBUSINESS_WAS_APPROVEDO cadastro do cliente foi aprovado.
businessBUSINESS_WAS_REPROVEDO cadastro do cliente foi reprovado.
businessBUSINESS_WAS_CANCELEDO cadastro do cliente foi cancelado.

Fluxo dos eventos

O fluxograma a seguir descreve a sequência em que os eventos ocorrem. Clique na imagem para ampliá-la:

Identificador (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 jurídica, o entityId é o identificador único do cliente (document.value).

Dados dos eventos

BUSINESS_WAS_RECEIVED

Este evento sinaliza que a solicitação de cadastro do cliente foi recebida.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
documentobjectObjeto que contém informações sobre o documento da empresa.
document.valuestringNúmero do documento.
document.typestringTipo do documento. Neste caso, “CNPJ”.
businessNamestringRazão social da empresa.
tradingNamestringNome fantasia da empresa, também conhecido como nome comercial.
businessTypestringTipo de negócio, o qual pode ser: LTDA, SA ou TS.
businessSizestringPorte da empresa, que pode ser SMALL, MEDIUM e LARGE.
cnaeCodestringCódigo CNAE (Classificação Nacional de Atividades Econômicas) da empresa.
legalNaturestringNatureza Jurídica da empresa.
openingDatestringData de abertura da empresa, no formato ISO 8601 - UTC.
declaredAnnualBillingstringFaixa de faturamento anual da empresa, descrito na tabela de faturamento anual.
phoneobjectObjeto que contém informações sobre o número de telefone da empresa.
phone.countryCodestringCódigo DDI do país.
phone.numberstringNúmero de telefone incluindo o DDD.
addressobjectObjeto que contém informações sobre o endereço comercial da empresa.
address.zipCodestringCódigo postal do endereço.
address.addressLinestringLogradouro (nome da rua, avenida etc.).
address.buildingNumberstringNúmero do imóvel.
address.complementstringComplemento do endereço.
address.neighborhoodstringNome do bairro.
address.citystringNome da cidade.
address.statestringNome do estado.
address.countrystringNome do país.
owners[] array of objectsLista de objetos que contém informações sobre os sócios da empresa, que podem ser do tipo pessoa física ou jurídica.
owners[].documentNumberstringNúmero do documento do sócio. Obsoleto. Considere o objeto document.
owners[].documentobjectObjeto que contém informações sobre o documento do sócio.
owners[].document.valuestringNúmero do documento.
owners[].document.typestringTipo de documento, o qual pode ser CPF, para pessoa física, e CNPJ, para pessoa jurídica.
owners[].registerNamestringNome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do sócio (em caso de sócio pessoa física).
owners[].socialNamestringNome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social (em caso de sócio pessoa física).
owners[].birthDatestringData de nascimento, no formato ISO 8601 - UTC (em caso de sócio pessoa física).
owners[].motherNamestringNome da mãe do sócio como consta no documento (em caso de sócio pessoa física).
owners[].pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978 (em caso de sócio pessoa física).
owners[].pep.levelstringNível de exposição política do cliente: "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente).
owners[].pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada no Bureau de informação. O valor padrão desse campo é "false".
owners[].occupationstringCódigo de ocupação do cliente (em caso de sócio pessoa física).
owners[].businessNamestringRazão social da empresa sócia (em caso de sócio pessoa jurídica).
owners[].tradingNamestringNome fantasia da empresa sócia, também conhecido como nome comercial (em caso de sócio pessoa jurídica).
owners[].businessTypestringTipo da empresa, o qual pode ser: LTDA, S.A. ou TS (em caso de sócio pessoa jurídica).
owners[].incomeDeclaredstringRenda declarada do sócio. Obsoleto. Considere o campo declaredIncome, para sócio pessoa física, e declaredAnnualBilling, para sócio pessoa jurídica.
owners[].declaredIncomestringFaixa de renda declarada pelo sócio, descrito na tabela de renda declarada(em caso de sócio pessoa física).
owners[].declaredAnnualBillingstringFaixa de faturamento anual da empresa, descrito na tabela de faturamento anual (em caso de sócio pessoa jurídica).
owners[].participationPercentagestringPercentual de participação na empresa (0 a 100).
owners[].emailstringEndereço de e-mail do sócio.
owners[].phoneobjectObjeto que contém informações sobre o número de telefone do sócio da empresa.
owners[].phone.countryCodestringCódigo DDI do país.
owners[].phone.numberstringNúmero de telefone incluindo o DDD.
owners[].addressobjectObjeto que contém informações sobre o endereço comercial ou residencial.
owners[].address.zipCodestringCódigo postal do endereço.
owners[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
owners[].address.buildingNumberstringNúmero do imóvel.
owners[].address.complementstringComplemento do endereço.
owners[].address.neighborhoodstringNome do bairro.
owners[].address.citystringNome da cidade.
owners[].address.statestringNome do estado.
owners[].address.countrystringNome do país.
owners[].owners[]array of objectsLista de objetos que contém informações sobre os sócios da empresa. Essa lista será recebida caso o sócio descrito anteriormente seja pessoa jurídica. Ela conterá todos os campos descritos na lista de objetos owner[].
owners[]legalRepresentatives[] array of objectsLista de objetos que contém informações sobre os representantes legais da empresa (em caso de sócio pessoa jurídica).
owners[]legalRepresentatives[].documentNumberstringNúmero do documento do representante legal. Obsoleto. Considere o objeto document.
owners[]legalRepresentatives[].documentobjectObjeto que contém informações sobre o documento do representante legal.
owners[]legalRepresentatives[].document.valuestringNúmero do documento.
owners[]legalRepresentatives[].document.typestringTipo do documento, que, nesse caso, será CPF.
owners[]legalRepresentatives[].registerNamestringNome do representante legal conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
owners[]legalRepresentatives[].socialNamestringNome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social.
owners[]legalRepresentatives[].birthDatestringData de nascimento do representante legal, no formato ISO 8601 - UTC.
owners[]legalRepresentatives[].motherNamestringNome da mãe do representante legal como consta no documento.
owners[]legalRepresentatives[].pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978.
owners[]legalRepresentatives[].pep.levelstringNível de exposição política do sócio: "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente).
owners[]legalRepresentatives[].pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada no Bureau de informação. O valor padrão desse campo é "false".
owners[]legalRepresentatives[].occupationstringCódigo de ocupação do cliente (em caso de sócio pessoa física).
owners[]legalRepresentatives[].declaredIncomestringFaixa de renda declarada pelo representante legal, descrito na tabela de renda declarada.
owners[]legalRepresentatives[].memberQualificationstringQualificação da pessoa física, conforme a tabela do Anexo 5 da Instrução Normativa RFB nº 1863/2018.
owners[]legalRepresentatives[].powerOfAttorneyobjectObjeto que contém informações sobre as datas referentes à Procuração Pública Legal.
owners[]legalRepresentatives[].powerOfAttorney.startDatestringData de início da Procuração, no formato ISO 8601 - UTC.
owners[]legalRepresentatives[].powerOfAttorney.endDatestringData de fim da Procuração, no formato ISO 8601 - UTC.
owners[]legalRepresentatives[].emailstringEndereço de e-mail do representante legal.
owners[]legalRepresentatives[].phoneobjectObjeto que contém informações sobre o número de telefone do representante legal.
owners[]legalRepresentatives[].phone.countryCodestringCódigo DDI do país.
owners[]legalRepresentatives[].phone.numberstringNúmero de telefone incluindo DDD.
owners[]legalRepresentatives[].addressobjectObjeto que contém informações sobre o endereço do representante legal.
owners[]legalRepresentatives[].address.zipCodestringCódigo postal do endereço.
owners[]legalRepresentatives[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
owners[]legalRepresentatives[].address.buildingNumberstringNúmero do imóvel.
owners[]legalRepresentatives[].address.complementstringComplemento do endereço.
owners[]legalRepresentatives[].address.neighborhoodstringNome do bairro.
owners[]legalRepresentatives[].address.citystringNome da cidade.
owners[]legalRepresentatives[].address.statestringNome do estado.
owners[]legalRepresentatives[].address.countrystringNome do país.
legalRepresentatives[]array of objectsLista que contém os representantes legais da empresa. Ela trará todos os campos contidos em owners[]legalRepresentatives
statusstringSituação do cadastro, o qual pode ser: “PENDINGAPPROVAL”, "APPROVED", "REPROVED” ou “CANCELED”. Nesse caso, o status será “PENDING_APPROVAL”.
isBanklyPartnerbooleanInforma se a empresa tem parceria com o Bankly.
createdAtstringData de cadastro do cliente, no formato ISO 8601 - UTC.
updatedAtstringData da última atualização do status de cadastro, no formato ISO 8601 - UTC.

Payload do evento

payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload
{
      "correlationId": "37613585-a0b1-4b74-8448-fc017b75b21b",
      "entityId": "34183937000161",
      "companyKey": "FLORESTA_ED",
      "idempotencyKey": "4f7bf424-e86f-44b8-a420-7634a0f2fada",
      "context": "Business",
      "name": "BUSINESS_WAS_RECEIVED",
      "timestamp": "2022-07-29T18:17:35.1555629Z",
      "data": {
         "document": {
            "value": "34183937000161",
            "type": "CNPJ"
         },
         "businessName": "Nísia Floresta Edições LTDA",
         "tradingName": "Editora Nísia Floresta",
         "businessType": "LTDA",
         "businessSize": "MEDIUM",
         "cnaeCode": "5811500",
         "legalNature": "LTDA",
         "openingDate": "2022-03-05",
         "declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
         "phone": {
            "countryCode": "55",
            "number": "23415162342"
         },
         "address": {
            "zipCode": "68060100",
            "addressLine": "Rua 6 de Março",
            "buildingNumber": "2500",
            "complement": "",
            "neighborhood": "Alter do Chão",
            "city": "Santarém",
            "state": "PA",
            "country": "BR"
         },
         "owners": [
            {
               "documentNumber": "53647974000128",
               "document": {
                  "value": "53647974000128",
                  "type": "CNPJ"
               },
               "businessName": "Gráfica Floresta SA",
               "tradingName": "Floresta Impressões",
               "businessType": "SA",
               "incomeDeclared": "",
               "declaredAnnualBilling": "NOT_DECLARED",
               "participationPercentage": "45",
               "email": "[email protected]",
               "phone": {
                  "countryCode": "55",
                  "number": "23415162342"
               },
               "address": {
                  "zipCode": "68060100",
                  "addressLine": "Rua 6 de Março",
                  "buildingNumber": "2500",
                  "complement": "",
                  "neighborhood": "Alter do Chão",
                  "city": "Santarém",
                  "state": "PA",
                  "country": "BR"
               },
               "owners": [
                  {
                     "documentNumber": "47742663023",
                     "document": {
                        "value": "47742663023",
                        "type": "CPF"
                     },
                     "registerName": "Nísia Floresta",
                     "socialName": "",
                     "birthDate": "1810-10-12T00:00:00Z",
                     "motherName": "Dionísia Gonçalves Pinto",
                     "pep": {
                        "level": "NONE",
                        "verified": false
                     },
                     "occupation": "OCP0001",
                     "declaredIncome": "LESS_THAN_ONE_THOUSAND",
                     "participationPercentage": "50",
                     "email": "[email protected]",
                     "phone": {
                        "countryCode": "55",
                        "number": "23415162342"
                     },
                     "address": {
                        "zipCode": "68060100",
                        "addressLine": "Rua 6 de Março",
                        "buildingNumber": "2500",
                        "complement": "",
                        "neighborhood": "Alter do Chão",
                        "city": "Santarém",
                        "state": "PA",
                        "country": "BR"
                     }
                  }
               ],
               "legalRepresentatives": [
                  {
                     "documentNumber": "47742663023",
                     "document": {
                        "value": "78982373748",
                        "type": "CPF"
                     },
                     "registerName": "Nísia Floresta",
                     "socialName": "",
                     "birthDate": "1810-10-12T00:00:00Z",
                     "motherName": "Dionísia Gonçalves Pinto",
                     "pep": {
                        "level": "NONE",
                        "verified": false
                     },
                     "occupation": "OCP0001",
                     "declaredIncome": "LESS_THAN_ONE_THOUSAND",
                     "memberQualification": "432-1",
                     "powerOfAttorney": {
                        "startDate": "2022-11-28T00:00:00Z",
                        "endDate": "2023-03-16T00:00:00Z"
                     },
                     "email": "[email protected]",
                     "phone": {
                        "countryCode": "55",
                        "number": "23415162342"
                     },
                     "address": {
                        "zipCode": "68060100",
                        "addressLine": "Rua 6 de Março",
                        "buildingNumber": "2500",
                        "complement": "",
                        "neighborhood": "Alter do Chão",
                        "city": "Santarém",
                        "state": "PA",
                        "country": "BR"
                     }
                  }
               ]
            }
         ],
         "legalRepresentatives": [
            {
               "documentNumber": "47742663023",
               "document": {
                  "value": "78982373748",
                  "type": "CPF"
               },
               "registerName": "Nísia Floresta",
               "socialName": "",
               "birthDate": "1810-10-12T00:00:00Z",
               "motherName": "Dionísia Gonçalves Pinto",
               "pep": {
                  "level": "NONE",
                  "verified": false
               },
               "occupation": "OCP0001",
               "declaredIncome": "LESS_THAN_ONE_THOUSAND",
               "memberQualification": "432-1",
               "powerOfAttorney": {
                  "startDate": "2022-06-28T00:00:00Z",
                  "endDate": "2022-08-31T00:00:00Z"
               },
               "email": "[email protected]",
               "phone": {
                  "countryCode": "55",
                  "number": "23415162342"
               },
               "address": {
                  "zipCode": "68060100",
                  "addressLine": "Rua 6 de Março",
                  "buildingNumber": "2500",
                  "complement": "",
                  "neighborhood": "Alter do Chão",
                  "city": "Santarém",
                  "state": "PA",
                  "country": "BR"
               }
            }
         ],
         "status": "PENDING_APPROVAL",
         "isBanklyPartner": false,
         "createdAt": "2022-07-29T18:17:35.121211Z",
         "updatedAt": "2022-07-29T18:17:35.1212361Z"
      }
 }

🚧

Importante

É possível que o campo owners varie dependendo do tipo da empresa, podendo apresentar até três níveis referentes ao quadro societário. Para compreender melhor as variações na estrutura do campo owners, consulte a documentação Onboarding pessoa jurídica LTDA, S.A., TS.

BUSINESS_WAS_APPROVED

Este evento sinaliza que o cadastro do cliente foi aprovado.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
documentobjectObjeto que contém informações sobre o documento da empresa.
document.valuestringNúmero do documento.
document.typestringTipo do documento. Neste caso, “CNPJ”.
businessNamestringRazão social da empresa.
tradingNamestringNome fantasia da empresa, também conhecido como nome comercial.
businessTypestringTipo de negócio, o qual pode ser: LTDA, SA ou TS.
businessSizestringPorte da empresa, que pode ser SMALL, MEDIUM e LARGE.
cnaeCodestringCódigo CNAE (Classificação Nacional de Atividades Econômicas) da empresa.
legalNaturestringNatureza Jurídica da empresa.
openingDatestringData de abertura da empresa, no formato ISO 8601 - UTC.
declaredAnnualBillingstringFaixa de faturamento anual da empresa, descrito na tabela de faturamento anual.
phoneobjectObjeto que contém informações sobre o número de telefone da empresa.
phone.countryCodestringCódigo DDI do país.
phone.numberstringNúmero de telefone incluindo o DDD.
addressobjectObjeto que contém informações sobre o endereço comercial da empresa.
address.zipCodestringCódigo postal do endereço.
address.addressLinestringLogradouro (nome da rua, avenida etc.).
address.buildingNumberstringNúmero do imóvel.
address.complementstringComplemento do endereço.
address.neighborhoodstringNome do bairro.
address.citystringNome da cidade.
address.statestringNome do estado.
address.countrystringNome do país.
owners[] array of objectsLista de objetos que contém informações sobre os sócios da empresa, que podem ser do tipo pessoa física ou jurídica.
owners[].documentNumberstringNúmero do documento do sócio. Obsoleto. Considere o objeto document.
owners[].documentobjectObjeto que contém informações sobre o documento do sócio.
owners[].document.valuestringNúmero do documento.
owners[].document.typestringTipo de documento, o qual pode ser CPF, para pessoa física, e CNPJ, para pessoa jurídica.
owners[].registerNamestringNome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do sócio (em caso de sócio pessoa física).
owners[].socialNamestringNome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social (em caso de sócio pessoa física).
owners[].birthDatestringData de nascimento, no formatoISO 8601 - UTC (em caso de sócio pessoa física).
owners[].motherNamestringNome da mãe do sócio como consta no documento (em caso de sócio pessoa física).
owners[].pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978 (em caso de sócio pessoa física).
owners[].pep.levelstringNível de exposição política do cliente: "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente).
owners[].pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada no Bureau de informação. O valor padrão desse campo é "false".
owners[].occupationstringCódigo de ocupação do cliente (em caso de sócio pessoa física).
owners[].businessNamestringRazão social da empresa sócia (em caso de sócio pessoa jurídica).
owners[].tradingNamestringNome fantasia da empresa sócia, também conhecido como nome comercial (em caso de sócio pessoa jurídica).
owners[].businessTypestringTipo da empresa, o qual pode ser: LTDA, S.A. ou TS (em caso de sócio pessoa jurídica).
owners[].incomeDeclaredstringRenda declarada do sócio. Obsoleto. Considere o campo declaredIncome, para sócio pessoa física, e declaredAnnualBilling, para sócio pessoa jurídica.
owners[].declaredIncomestringFaixa de renda declarada pelo sócio, descrito na tabela de renda declarada(em caso de sócio pessoa física).
owners[].declaredAnnualBillingstringFaixa de faturamento anual da empresa, descrito na tabela de faturamento anual (em caso de sócio pessoa jurídica).
owners[].participationPercentagestringPercentual de participação na empresa (0 a 100).
owners[].emailstringEndereço de e-mail do sócio.
owners[].phoneobjectObjeto que contém informações sobre o número de telefone do sócio da empresa.
owners[].phone.countryCodestringCódigo DDI do país.
owners[].phone.numberstringNúmero de telefone incluindo o DDD.
owners[].addressobjectObjeto que contém informações sobre o endereço comercial ou residencial.
owners[].address.zipCodestringCódigo postal do endereço.
owners[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
owners[].address.buildingNumberstringNúmero do imóvel.
owners[].address.complementstringComplemento do endereço.
owners[].address.neighborhoodstringNome do bairro.
owners[].address.citystringNome da cidade.
owners[].address.statestringNome do estado.
owners[].address.countrystringNome do país.
owners[].owners[]array of objectsLista de objetos que contém informações sobre os sócios da empresa. Essa lista será recebida caso o sócio descrito anteriormente seja pessoa jurídica. Ela conterá todos os campos descritos na lista de objetos owner[].
owners[]legalRepresentatives[] array of objectsLista de objetos que contém informações sobre os representantes legais da empresa (em caso de sócio pessoa jurídica).
owners[]legalRepresentatives[].documentNumberstringNúmero do documento do representante legal. Obsoleto. Considere o objeto document.
owners[]legalRepresentatives[].documentobjectObjeto que contém informações sobre o documento do representante legal.
owners[]legalRepresentatives[].document.valuestringNúmero do documento.
owners[]legalRepresentatives[].document.typestringTipo do documento, que, nesse caso, será CPF.
owners[]legalRepresentatives[].registerNamestringNome do representante legal conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
owners[]legalRepresentatives[].socialNamestringNome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social.
owners[]legalRepresentatives[].birthDatestringData de nascimento do representante legal. no formato ISO 8601 - UTC.
owners[]legalRepresentatives[].motherNamestringNome da mãe do representante legal como consta no documento.
owners[]legalRepresentatives[].pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978.
owners[]legalRepresentatives[].pep.levelstringNível de exposição política do sócio: "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente).
owners[]legalRepresentatives[].pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada no Bureau de informação. O valor padrão desse campo é "false".
owners[]legalRepresentatives[].occupationstringCódigo de ocupação do cliente (em caso de sócio pessoa física).
owners[]legalRepresentatives[].declaredIncomestringFaixa de renda declarada pelo representante legal, descrito na tabela de renda declarada.
owners[]legalRepresentatives[].memberQualificationstringQualificação da pessoa física, conforme a tabela do Anexo 5 da Instrução Normativa RFB nº 1863/2018.
owners[]legalRepresentatives[].powerOfAttorneyobjectObjeto que contém informações sobre as datas referentes à Procuração Pública Legal.
owners[]legalRepresentatives[].powerOfAttorney.startDatestringData de início da Procuração, no formato ISO 8601 - UTC.
owners[]legalRepresentatives[].powerOfAttorney.endDatestringData de fim da Procuração, no formato ISO 8601 - UTC.
owners[]legalRepresentatives[].emailstringEndereço de e-mail do representante legal.
owners[]legalRepresentatives[].phoneobjectObjeto que contém informações sobre o número de telefone do representante legal.
owners[]legalRepresentatives[].phone.countryCodestringCódigo DDI do país.
owners[]legalRepresentatives[].phone.numberstringNúmero de telefone incluindo DDD.
owners[]legalRepresentatives[].addressobjectObjeto que contém informações sobre o endereço do representante legal.
owners[]legalRepresentatives[].address.zipCodestringCódigo postal do endereço.
owners[]legalRepresentatives[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
owners[]legalRepresentatives[].address.buildingNumberstringNúmero do imóvel.
owners[]legalRepresentatives[].address.complementstringComplemento do endereço.
owners[]legalRepresentatives[].address.neighborhoodstringNome do bairro.
owners[]legalRepresentatives[].address.citystringNome da cidade.
owners[]legalRepresentatives[].address.statestringNome do estado.
owners[]legalRepresentatives[].address.countrystringNome do país.
legalRepresentatives[]array of objectsLista que contém os representantes legais da empresa. Ela trará todos os campos contidos em owners[]legalRepresentatives
statusstringSituação do cadastro, o qual pode ser: “PENDING_APPROVAL”, "APPROVED", "REPROVED” ou “CANCELED”. Nesse caso, o status será “APPROVED”.
isBanklyPartnerbooleanInforma se a empresa tem parceria com o Bankly.
createdAtstringData de cadastro do cliente, no formato ISO 8601 - UTC.
updatedAtstringData da última atualização do status de cadastro, no formato ISO 8601 - UTC.

Payload do evento

payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload
{
      "correlationId": "37613585-a0b1-4b74-8448-fc017b75b21b",
      "entityId": "34183937000161",
      "companyKey": "FLORESTA_ED",
      "idempotencyKey": "4f7bf424-e86f-44b8-a420-7634a0f2fada",
      "context": "Business",
      "name": "BUSINESS_WAS_APPROVED",
      "timestamp": "2022-07-29T18:17:35.1555629Z",
      "data": {
         "document": {
            "value": "34183937000161",
            "type": "CNPJ"
         },
         "businessName": "Nísia Floresta Edições LTDA",
         "tradingName": "Editora Nísia Floresta",
         "businessType": "LTDA",
         "businessSize": "MEDIUM",
         "cnaeCode": "5811500",
         "legalNature": "LTDA",
         "openingDate": "2022-03-05",
         "declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
         "phone": {
            "countryCode": "55",
            "number": "23415162342"
         },
         "address": {
            "zipCode": "68060100",
            "addressLine": "Rua 6 de Março",
            "buildingNumber": "2500",
            "complement": "",
            "neighborhood": "Alter do Chão",
            "city": "Santarém",
            "state": "PA",
            "country": "BR"
         },
         "owners": [
            {
               "documentNumber": "53647974000128",
               "document": {
                  "value": "53647974000128",
                  "type": "CNPJ"
               },
               "businessName": "Gráfica Floresta SA",
               "tradingName": "Floresta Impressões",
               "businessType": "SA",
               "incomeDeclared": "",
               "declaredAnnualBilling": "NOT_DECLARED",
               "participationPercentage": "45",
               "email": "[email protected]",
               "phone": {
                  "countryCode": "55",
                  "number": "23415162342"
               },
               "address": {
                  "zipCode": "68060100",
                  "addressLine": "Rua 6 de Março",
                  "buildingNumber": "2500",
                  "complement": "",
                  "neighborhood": "Alter do Chão",
                  "city": "Santarém",
                  "state": "PA",
                  "country": "BR"
               },
               "owners": [
                  {
                     "documentNumber": "47742663023",
                     "document": {
                        "value": "47742663023",
                        "type": "CPF"
                     },
                     "registerName": "Nísia Floresta",
                     "socialName": "",
                     "birthDate": "1810-10-12T00:00:00Z",
                     "motherName": "Dionísia Gonçalves Pinto",
                     "pep": {
                        "level": "NONE",
                        "verified": false
                     },
                     "occupation": "OCP0001",
                     "declaredIncome": "LESS_THAN_ONE_THOUSAND",
                     "participationPercentage": "50",
                     "email": "[email protected]",
                     "phone": {
                        "countryCode": "55",
                        "number": "23415162342"
                     },
                     "address": {
                        "zipCode": "68060100",
                        "addressLine": "Rua 6 de Março",
                        "buildingNumber": "2500",
                        "complement": "",
                        "neighborhood": "Alter do Chão",
                        "city": "Santarém",
                        "state": "PA",
                        "country": "BR"
                     }
                  }
               ],
               "legalRepresentatives": [
                  {
                     "documentNumber": "47742663023",
                     "document": {
                        "value": "78982373748",
                        "type": "CPF"
                     },
                     "registerName": "Nísia Floresta",
                     "socialName": "",
                     "birthDate": "1810-10-12T00:00:00Z",
                     "motherName": "Dionísia Gonçalves Pinto",
                     "pep": {
                        "level": "NONE",
                        "verified": false
                     },
                     "occupation": "OCP0001",
                     "declaredIncome": "LESS_THAN_ONE_THOUSAND",
                     "memberQualification": "432-1",
                     "powerOfAttorney": {
                        "startDate": "2022-11-28T00:00:00Z",
                        "endDate": "2023-03-16T00:00:00Z"
                     },
                     "email": "[email protected]",
                     "phone": {
                        "countryCode": "55",
                        "number": "23415162342"
                     },
                     "address": {
                        "zipCode": "68060100",
                        "addressLine": "Rua 6 de Março",
                        "buildingNumber": "2500",
                        "complement": "",
                        "neighborhood": "Alter do Chão",
                        "city": "Santarém",
                        "state": "PA",
                        "country": "BR"
                     }
                  }
               ]
            }
         ],
         "legalRepresentatives": [
            {
               "documentNumber": "47742663023",
               "document": {
                  "value": "78982373748",
                  "type": "CPF"
               },
               "registerName": "Nísia Floresta",
               "socialName": "",
               "birthDate": "1810-10-12T00:00:00Z",
               "motherName": "Dionísia Gonçalves Pinto",
               "pep": {
                  "level": "NONE",
                  "verified": false
               },
               "occupation": "OCP0001",
               "declaredIncome": "LESS_THAN_ONE_THOUSAND",
               "memberQualification": "432-1",
               "powerOfAttorney": {
                  "startDate": "2022-06-28T00:00:00Z",
                  "endDate": "2022-08-31T00:00:00Z"
               },
               "email": "[email protected]",
               "phone": {
                  "countryCode": "55",
                  "number": "23415162342"
               },
               "address": {
                  "zipCode": "68060100",
                  "addressLine": "Rua 6 de Março",
                  "buildingNumber": "2500",
                  "complement": "",
                  "neighborhood": "Alter do Chão",
                  "city": "Santarém",
                  "state": "PA",
                  "country": "BR"
               }
            }
         ],
         "status": "APPROVED",
         "isBanklyPartner": false,
         "createdAt": "2022-07-29T18:17:35.121211Z",
         "updatedAt": "2022-07-29T18:17:35.1212361Z"
      }
 }

🚧

Importante

É possível que o campo owners varie dependendo do tipo da empresa, podendo apresentar até três níveis referentes ao quadro societário. Para compreender melhor as variações na estrutura do campo owners, consulte a documentação Onboarding pessoa jurídica LTDA, S.A., TS.

BUSINESS_WAS_REPROVED

Este evento sinaliza que o cadastro do cliente foi reprovado.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
documentobjectObjeto que contém informações sobre o documento da empresa.
document.valuestringNúmero do documento.
document.typestringTipo do documento. Neste caso, “CNPJ”.
businessNamestringRazão social da empresa.
tradingNamestringNome fantasia da empresa, também conhecido como nome comercial.
businessTypestringTipo de negócio, o qual pode ser: LTDA, SA ou TS.
businessSizestringPorte da empresa, que pode ser SMALL, MEDIUM e LARGE.
cnaeCodestringCódigo CNAE (Classificação Nacional de Atividades Econômicas) da empresa.
legalNaturestringNatureza Jurídica da empresa.
openingDatestringData de abertura da empresa, no formato ISO 8601 - UTC.
declaredAnnualBillingstringFaixa de faturamento anual da empresa, descrito na tabela de faturamento anual.
phoneobjectObjeto que contém informações sobre o número de telefone da empresa.
phone.countryCodestringCódigo DDI do país.
phone.numberstringNúmero de telefone incluindo o DDD.
addressobjectObjeto que contém informações sobre o endereço comercial da empresa.
address.zipCodestringCódigo postal do endereço.
address.addressLinestringLogradouro (nome da rua, avenida etc.).
address.buildingNumberstringNúmero do imóvel.
address.complementstringComplemento do endereço.
address.neighborhoodstringNome do bairro.
address.citystringNome da cidade.
address.statestringNome do estado.
address.countrystringNome do país.
owners[] array of objectsLista de objetos que contém informações sobre os sócios da empresa, que podem ser do tipo pessoa física ou jurídica.
owners[].documentNumberstringNúmero do documento do sócio. Obsoleto. Considere o objeto document.
owners[].documentobjectObjeto que contém informações sobre o documento do sócio.
owners[].document.valuestringNúmero do documento.
owners[].document.typestringTipo de documento, o qual pode ser CPF, para pessoa física, e CNPJ, para pessoa jurídica.
owners[].registerNamestringNome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do sócio (em caso de sócio pessoa física).
owners[].socialNamestringNome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social (em caso de sócio pessoa física).
owners[].birthDatestringData de nascimento, no formatoISO 8601 - UTC (em caso de sócio pessoa física).
owners[].motherNamestringNome da mãe do sócio como consta no documento (em caso de sócio pessoa física).
owners[].pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978 (em caso de sócio pessoa física).
owners[].pep.levelstringNível de exposição política do cliente: "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente).
owners[].pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada no Bureau de informação. O valor padrão desse campo é "false".
owners[].occupationstringCódigo de ocupação do cliente (em caso de sócio pessoa física).
owners[].businessNamestringRazão social da empresa sócia (em caso de sócio pessoa jurídica).
owners[].tradingNamestringNome fantasia da empresa sócia, também conhecido como nome comercial (em caso de sócio pessoa jurídica).
owners[].businessTypestringTipo da empresa, o qual pode ser: LTDA, S.A. ou TS (em caso de sócio pessoa jurídica).
owners[].incomeDeclaredstringRenda declarada do sócio. Obsoleto. Considere o campo declaredIncome, para sócio pessoa física, e declaredAnnualBilling, para sócio pessoa jurídica.
owners[].declaredIncomestringFaixa de renda declarada pelo sócio, descrito na tabela de renda declarada(em caso de sócio pessoa física).
owners[].declaredAnnualBillingstringFaixa de faturamento anual da empresa, descrito na tabela de faturamento anual (em caso de sócio pessoa jurídica).
owners[].participationPercentagestringPercentual de participação na empresa (0 a 100).
owners[].emailstringEndereço de e-mail do sócio.
owners[].phoneobjectObjeto que contém informações sobre o número de telefone do sócio da empresa.
owners[].phone.countryCodestringCódigo DDI do país.
owners[].phone.numberstringNúmero de telefone incluindo o DDD.
owners[].addressobjectObjeto que contém informações sobre o endereço comercial ou residencial.
owners[].address.zipCodestringCódigo postal do endereço.
owners[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
owners[].address.buildingNumberstringNúmero do imóvel.
owners[].address.complementstringComplemento do endereço.
owners[].address.neighborhoodstringNome do bairro.
owners[].address.citystringNome da cidade.
owners[].address.statestringNome do estado.
owners[].address.countrystringNome do país.
owners[].owners[]array of objectsLista de objetos que contém informações sobre os sócios da empresa. Essa lista será recebida caso o sócio descrito anteriormente seja pessoa jurídica. Ela conterá todos os campos descritos na lista de objetos owner[].
owners[]legalRepresentatives[] array of objectsLista de objetos que contém informações sobre os representantes legais da empresa (em caso de sócio pessoa jurídica).
owners[]legalRepresentatives[].documentNumberstringNúmero do documento do representante legal. Obsoleto. Considere o objeto document.
owners[]legalRepresentatives[].documentobjectObjeto que contém informações sobre o documento do representante legal.
owners[]legalRepresentatives[].document.valuestringNúmero do documento.
owners[]legalRepresentatives[].document.typestringTipo do documento, que, nesse caso, será CPF.
owners[]legalRepresentatives[].registerNamestringNome do representante legal conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
owners[]legalRepresentatives[].socialNamestringNome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social.
owners[]legalRepresentatives[].birthDatestringData de nascimento do representante legal, no formato ISO 8601 - UTC.
owners[]legalRepresentatives[].motherNamestringNome da mãe do representante legal como consta no documento.
owners[]legalRepresentatives[].pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978.
owners[]legalRepresentatives[].pep.levelstringNível de exposição política do sócio: "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente).
owners[]legalRepresentatives[].pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada no Bureau de informação. O valor padrão desse campo é "false".
owners[]legalRepresentatives[].occupationstringCódigo de ocupação do cliente (em caso de sócio pessoa física).
owners[]legalRepresentatives[].declaredIncomestringFaixa de renda declarada pelo representante legal, descrito na tabela de renda declarada.
owners[]legalRepresentatives[].memberQualificationstringQualificação da pessoa física, conforme a tabela do Anexo 5 da Instrução Normativa RFB nº 1863/2018.
owners[]legalRepresentatives[].powerOfAttorneyobjectObjeto que contém informações sobre as datas referentes à Procuração Pública Legal.
owners[]legalRepresentatives[].powerOfAttorney.startDatestringData de início da Procuração, no formato ISO 8601 - UTC.
owners[]legalRepresentatives[].powerOfAttorney.endDatestringData de fim da Procuração, no formato ISO 8601 - UTC.
owners[]legalRepresentatives[].emailstringEndereço de e-mail do representante legal.
owners[]legalRepresentatives[].phoneobjectObjeto que contém informações sobre o número de telefone do representante legal.
owners[]legalRepresentatives[].phone.countryCodestringCódigo DDI do país.
owners[]legalRepresentatives[].phone.numberstringNúmero de telefone incluindo DDD.
owners[]legalRepresentatives[].addressobjectObjeto que contém informações sobre o endereço do representante legal.
owners[]legalRepresentatives[].address.zipCodestringCódigo postal do endereço.
owners[]legalRepresentatives[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
owners[]legalRepresentatives[].address.buildingNumberstringNúmero do imóvel.
owners[]legalRepresentatives[].address.complementstringComplemento do endereço.
owners[]legalRepresentatives[].address.neighborhoodstringNome do bairro.
owners[]legalRepresentatives[].address.citystringNome da cidade.
owners[]legalRepresentatives[].address.statestringNome do estado.
owners[]legalRepresentatives[].address.countrystringNome do país.
legalRepresentatives[]array of objectsLista que contém os representantes legais da empresa. Ela trará todos os campos contidos em owners[]legalRepresentatives
statusstringSituação do cadastro, o qual pode ser: “PENDING_APPROVAL”, "APPROVED", "REPROVED” ou “CANCELED”. Nesse caso, o status será “REPROVED”.
reprovedReasonsstringMotivo pelo qual o cadastro foi reprovado.
isBanklyPartnerbooleanInforma se a empresa tem parceria com o Bankly.
createdAtstringData de cadastro do cliente, no formato ISO 8601 - UTC.
updatedAtstringData da última atualização do status de cadastro, no formato ISO 8601 - UTC.

Payload do evento

payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload
{
      "correlationId": "37613585-a0b1-4b74-8448-fc017b75b21b",
      "entityId": "34183937000161",
      "companyKey": "FLORESTA_ED",
      "idempotencyKey": "4f7bf424-e86f-44b8-a420-7634a0f2fada",
      "context": "Business",
      "name": "BUSINESS_WAS_REPROVED",
      "timestamp": "2022-07-29T18:17:35.1555629Z",
      "data": {
         "document": {
            "value": "34183937000161",
            "type": "CNPJ"
         },
         "businessName": "Nísia Floresta Edições LTDA",
         "tradingName": "Editora Nísia Floresta",
         "businessType": "LTDA",
         "businessSize": "MEDIUM",
         "cnaeCode": "5811500",
         "legalNature": "LTDA",
         "openingDate": "2022-03-05",
         "declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
         "phone": {
            "countryCode": "55",
            "number": "23415162342"
         },
         "address": {
            "zipCode": "68060100",
            "addressLine": "Rua 6 de Março",
            "buildingNumber": "2500",
            "complement": "",
            "neighborhood": "Alter do Chão",
            "city": "Santarém",
            "state": "PA",
            "country": "BR"
         },
         "owners": [
            {
               "documentNumber": "53647974000128",
               "document": {
                  "value": "53647974000128",
                  "type": "CNPJ"
               },
               "businessName": "Gráfica Floresta SA",
               "tradingName": "Floresta Impressões",
               "businessType": "SA",
               "incomeDeclared": "",
               "declaredAnnualBilling": "NOT_DECLARED",
               "participationPercentage": "45",
               "email": "[email protected]",
               "phone": {
                  "countryCode": "55",
                  "number": "23415162342"
               },
               "address": {
                  "zipCode": "68060100",
                  "addressLine": "Rua 6 de Março",
                  "buildingNumber": "2500",
                  "complement": "",
                  "neighborhood": "Alter do Chão",
                  "city": "Santarém",
                  "state": "PA",
                  "country": "BR"
               },
               "owners": [
                  {
                     "documentNumber": "47742663023",
                     "document": {
                        "value": "47742663023",
                        "type": "CPF"
                     },
                     "registerName": "Nísia Floresta",
                     "socialName": "",
                     "birthDate": "1810-10-12T00:00:00Z",
                     "motherName": "Dionísia Gonçalves Pinto",
                     "pep": {
                        "level": "NONE",
                        "verified": false
                     },
                     "occupation": "OCP0001",
                     "declaredIncome": "LESS_THAN_ONE_THOUSAND",
                     "participationPercentage": "50",
                     "email": "[email protected]",
                     "phone": {
                        "countryCode": "55",
                        "number": "23415162342"
                     },
                     "address": {
                        "zipCode": "68060100",
                        "addressLine": "Rua 6 de Março",
                        "buildingNumber": "2500",
                        "complement": "",
                        "neighborhood": "Alter do Chão",
                        "city": "Santarém",
                        "state": "PA",
                        "country": "BR"
                     }
                  }
               ],
               "legalRepresentatives": [
                  {
                     "documentNumber": "47742663023",
                     "document": {
                        "value": "78982373748",
                        "type": "CPF"
                     },
                     "registerName": "Nísia Floresta",
                     "socialName": "",
                     "birthDate": "1810-10-12T00:00:00Z",
                     "motherName": "Dionísia Gonçalves Pinto",
                     "pep": {
                        "level": "NONE",
                        "verified": false
                     },
                     "occupation": "OCP0001",
                     "declaredIncome": "LESS_THAN_ONE_THOUSAND",
                     "memberQualification": "432-1",
                     "powerOfAttorney": {
                        "startDate": "2022-11-28T00:00:00Z",
                        "endDate": "2023-03-16T00:00:00Z"
                     },
                     "email": "[email protected]",
                     "phone": {
                        "countryCode": "55",
                        "number": "23415162342"
                     },
                     "address": {
                        "zipCode": "68060100",
                        "addressLine": "Rua 6 de Março",
                        "buildingNumber": "2500",
                        "complement": "",
                        "neighborhood": "Alter do Chão",
                        "city": "Santarém",
                        "state": "PA",
                        "country": "BR"
                     }
                  }
               ]
            }
         ],
         "legalRepresentatives": [
            {
               "documentNumber": "47742663023",
               "document": {
                  "value": "78982373748",
                  "type": "CPF"
               },
               "registerName": "Nísia Floresta",
               "socialName": "",
               "birthDate": "1810-10-12T00:00:00Z",
               "motherName": "Dionísia Gonçalves Pinto",
               "pep": {
                  "level": "NONE",
                  "verified": false
               },
               "occupation": "OCP0001",
               "declaredIncome": "LESS_THAN_ONE_THOUSAND",
               "memberQualification": "432-1",
               "powerOfAttorney": {
                  "startDate": "2022-06-28T00:00:00Z",
                  "endDate": "2022-08-31T00:00:00Z"
               },
               "email": "[email protected]",
               "phone": {
                  "countryCode": "55",
                  "number": "23415162342"
               },
               "address": {
                  "zipCode": "68060100",
                  "addressLine": "Rua 6 de Março",
                  "buildingNumber": "2500",
                  "complement": "",
                  "neighborhood": "Alter do Chão",
                  "city": "Santarém",
                  "state": "PA",
                  "country": "BR"
               }
            }
         ],
         "status": "REPROVED",
         "reprovedReasons": "DOCUMENT_RECUSED",
         "isBanklyPartner": false,
         "createdAt": "2022-07-29T18:17:35.121211Z",
         "updatedAt": "2022-07-29T18:17:35.1212361Z"
      }
 }

🚧

Importante

É possível que o campo owners varie dependendo do tipo da empresa, podendo apresentar até três níveis referentes ao quadro societário. Para compreender melhor as variações na estrutura do campo owners, consulte a documentação Onboarding pessoa jurídica LTDA, S.A., TS.

BUSINESS_WAS_CANCELED

Este evento sinaliza que o cadastro do cliente foi cancelado.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
documentobjectObjeto que contém informações sobre o documento da empresa.
document.valuestringNúmero do documento.
document.typestringTipo do documento. Neste caso, “CNPJ”.
businessNamestringRazão social da empresa.
tradingNamestringNome fantasia da empresa, também conhecido como nome comercial.
businessTypestringTipo de negócio, o qual pode ser: LTDA, SA ou TS.
businessSizestringPorte da empresa, que pode ser SMALL, MEDIUM e LARGE.
cnaeCodestringCódigo CNAE (Classificação Nacional de Atividades Econômicas) da empresa.
legalNaturestringNatureza Jurídica da empresa.
openingDatestringData de abertura da empresa, no formato ISO 8601 - UTC.
declaredAnnualBillingstringFaixa de faturamento anual da empresa, descrito na tabela de faturamento anual.
phoneobjectObjeto que contém informações sobre o número de telefone da empresa.
phone.countryCodestringCódigo DDI do país.
phone.numberstringNúmero de telefone incluindo o DDD.
addressobjectObjeto que contém informações sobre o endereço comercial da empresa.
address.zipCodestringCódigo postal do endereço.
address.addressLinestringLogradouro (nome da rua, avenida etc.).
address.buildingNumberstringNúmero do imóvel.
address.complementstringComplemento do endereço.
address.neighborhoodstringNome do bairro.
address.citystringNome da cidade.
address.statestringNome do estado.
address.countrystringNome do país.
owners[] array of objectsLista de objetos que contém informações sobre os sócios da empresa, que podem ser do tipo pessoa física ou jurídica.
owners[].documentNumberstringNúmero do documento do sócio. Obsoleto. Considere o objeto document.
owners[].documentobjectObjeto que contém informações sobre o documento do sócio.
owners[].document.valuestringNúmero do documento.
owners[].document.typestringTipo de documento, o qual pode ser CPF, para pessoa física, e CNPJ, para pessoa jurídica.
owners[].registerNamestringNome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do sócio (em caso de sócio pessoa física).
owners[].socialNamestringNome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social (em caso de sócio pessoa física).
owners[].birthDatestringData de nascimento, no formato ISO 8601 - UTC (em caso de sócio pessoa física).
owners[].motherNamestringNome da mãe do sócio como consta no documento (em caso de sócio pessoa física).
owners[].pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978 (em caso de sócio pessoa física).
owners[].pep.levelstringNível de exposição política do cliente: "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente).
owners[].pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada no Bureau de informação. O valor padrão desse campo é "false".
owners[].occupationstringCódigo de ocupação do cliente (em caso de sócio pessoa física).
owners[].businessNamestringRazão social da empresa sócia (em caso de sócio pessoa jurídica).
owners[].tradingNamestringNome fantasia da empresa sócia, também conhecido como nome comercial (em caso de sócio pessoa jurídica).
owners[].businessTypestringTipo da empresa, o qual pode ser: LTDA, S.A. ou TS (em caso de sócio pessoa jurídica).
owners[].incomeDeclaredstringRenda declarada do sócio. Obsoleto. Considere o campo declaredIncome, para sócio pessoa física, e declaredAnnualBilling, para sócio pessoa jurídica.
owners[].declaredIncomestringFaixa de renda declarada pelo sócio, descrito na tabela de renda declarada(em caso de sócio pessoa física).
owners[].declaredAnnualBillingstringFaixa de faturamento anual da empresa, descrito na tabela de faturamento anual (em caso de sócio pessoa jurídica).
owners[].participationPercentagestringPercentual de participação na empresa (0 a 100).
owners[].emailstringEndereço de e-mail do sócio.
owners[].phoneobjectObjeto que contém informações sobre o número de telefone do sócio da empresa.
owners[].phone.countryCodestringCódigo DDI do país.
owners[].phone.numberstringNúmero de telefone incluindo o DDD.
owners[].addressobjectObjeto que contém informações sobre o endereço comercial ou residencial.
owners[].address.zipCodestringCódigo postal do endereço.
owners[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
owners[].address.buildingNumberstringNúmero do imóvel.
owners[].address.complementstringComplemento do endereço.
owners[].address.neighborhoodstringNome do bairro.
owners[].address.citystringNome da cidade.
owners[].address.statestringNome do estado.
owners[].address.countrystringNome do país.
owners[].owners[]array of objectsLista de objetos que contém informações sobre os sócios da empresa. Essa lista será recebida caso o sócio descrito anteriormente seja pessoa jurídica. Ela conterá todos os campos descritos na lista de objetos owner[].
owners[]legalRepresentatives[] array of objectsLista de objetos que contém informações sobre os representantes legais da empresa (em caso de sócio pessoa jurídica).
owners[]legalRepresentatives[].documentNumberstringNúmero do documento do representante legal. Obsoleto. Considere o objeto document.
owners[]legalRepresentatives[].documentobjectObjeto que contém informações sobre o documento do representante legal.
owners[]legalRepresentatives[].document.valuestringNúmero do documento.
owners[]legalRepresentatives[].document.typestringTipo do documento, que, nesse caso, será CPF.
owners[]legalRepresentatives[].registerNamestringNome do representante legal conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
owners[]legalRepresentatives[].socialNamestringNome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social.
owners[]legalRepresentatives[].birthDatestringData de nascimento do representante legal, no formato ISO 8601 - UTC.
owners[]legalRepresentatives[].motherNamestringNome da mãe do representante legal como consta no documento.
owners[]legalRepresentatives[].pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978.
owners[]legalRepresentatives[].pep.levelstringNível de exposição política do sócio: "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente).
owners[]legalRepresentatives[].pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada no Bureau de informação. O valor padrão desse campo é "false".
owners[]legalRepresentatives[].occupationstringCódigo de ocupação do cliente (em caso de sócio pessoa física).
owners[]legalRepresentatives[].declaredIncomestringFaixa de renda declarada pelo representante legal, descrito na tabela de renda declarada.
owners[]legalRepresentatives[].memberQualificationstringQualificação da pessoa física, conforme a tabela do Anexo 5 da Instrução Normativa RFB nº 1863/2018.
owners[]legalRepresentatives[].powerOfAttorneyobjectObjeto que contém informações sobre as datas referentes à Procuração Pública Legal.
owners[]legalRepresentatives[].powerOfAttorney.startDatestringData de início da Procuração, no formato ISO 8601 - UTC.
owners[]legalRepresentatives[].powerOfAttorney.endDatestringData de fim da Procuração, no formato ISO 8601 - UTC.
owners[]legalRepresentatives[].emailstringEndereço de e-mail do representante legal.
owners[]legalRepresentatives[].phoneobjectObjeto que contém informações sobre o número de telefone do representante legal.
owners[]legalRepresentatives[].phone.countryCodestringCódigo DDI do país.
owners[]legalRepresentatives[].phone.numberstringNúmero de telefone incluindo DDD.
owners[]legalRepresentatives[].addressobjectObjeto que contém informações sobre o endereço do representante legal.
owners[]legalRepresentatives[].address.zipCodestringCódigo postal do endereço.
owners[]legalRepresentatives[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
owners[]legalRepresentatives[].address.buildingNumberstringNúmero do imóvel.
owners[]legalRepresentatives[].address.complementstringComplemento do endereço.
owners[]legalRepresentatives[].address.neighborhoodstringNome do bairro.
owners[]legalRepresentatives[].address.citystringNome da cidade.
owners[]legalRepresentatives[].address.statestringNome do estado.
owners[]legalRepresentatives[].address.countrystringNome do país.
legalRepresentatives[]array of objectsLista que contém os representantes legais da empresa. Ela trará todos os campos contidos em owners[]legalRepresentatives
statusstringSituação do cadastro, o qual pode ser: “PENDING_APPROVAL”, "APPROVED", "REPROVED” ou “CANCELED”. Nesse caso, o status será “CANCELED”.
isBanklyPartnerbooleanInforma se a empresa tem parceria com o Bankly.
createdAtstringData de cadastro do cliente, no formato ISO 8601 - UTC.
updatedAtstringData da última atualização do status de cadastro, no formato ISO 8601 - UTC.

Payload do evento

payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload
{
      "correlationId": "37613585-a0b1-4b74-8448-fc017b75b21b",
      "entityId": "34183937000161",
      "companyKey": "FLORESTA_ED",
      "idempotencyKey": "4f7bf424-e86f-44b8-a420-7634a0f2fada",
      "context": "Business",
      "name": "BUSINESS_WAS_CANCELED",
      "timestamp": "2022-07-29T18:17:35.1555629Z",
      "data": {
         "document": {
            "value": "34183937000161",
            "type": "CNPJ"
         },
         "businessName": "Nísia Floresta Edições LTDA",
         "tradingName": "Editora Nísia Floresta",
         "businessType": "LTDA",
         "businessSize": "MEDIUM",
         "cnaeCode": "5811500",
         "legalNature": "LTDA",
         "openingDate": "2022-03-05",
         "declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
         "phone": {
            "countryCode": "55",
            "number": "23415162342"
         },
         "address": {
            "zipCode": "68060100",
            "addressLine": "Rua 6 de Março",
            "buildingNumber": "2500",
            "complement": "",
            "neighborhood": "Alter do Chão",
            "city": "Santarém",
            "state": "PA",
            "country": "BR"
         },
         "owners": [
            {
               "documentNumber": "53647974000128",
               "document": {
                  "value": "53647974000128",
                  "type": "CNPJ"
               },
               "businessName": "Gráfica Floresta SA",
               "tradingName": "Floresta Impressões",
               "businessType": "SA",
               "incomeDeclared": "",
               "declaredAnnualBilling": "NOT_DECLARED",
               "participationPercentage": "45",
               "email": "[email protected]",
               "phone": {
                  "countryCode": "55",
                  "number": "23415162342"
               },
               "address": {
                  "zipCode": "68060100",
                  "addressLine": "Rua 6 de Março",
                  "buildingNumber": "2500",
                  "complement": "",
                  "neighborhood": "Alter do Chão",
                  "city": "Santarém",
                  "state": "PA",
                  "country": "BR"
               },
               "owners": [
                  {
                     "documentNumber": "47742663023",
                     "document": {
                        "value": "47742663023",
                        "type": "CPF"
                     },
                     "registerName": "Nísia Floresta",
                     "socialName": "",
                     "birthDate": "1810-10-12T00:00:00Z",
                     "motherName": "Dionísia Gonçalves Pinto",
                     "pep": {
                        "level": "NONE",
                        "verified": false
                     },
                     "occupation": "OCP0001",
                     "declaredIncome": "LESS_THAN_ONE_THOUSAND",
                     "participationPercentage": "50",
                     "email": "[email protected]",
                     "phone": {
                        "countryCode": "55",
                        "number": "23415162342"
                     },
                     "address": {
                        "zipCode": "68060100",
                        "addressLine": "Rua 6 de Março",
                        "buildingNumber": "2500",
                        "complement": "",
                        "neighborhood": "Alter do Chão",
                        "city": "Santarém",
                        "state": "PA",
                        "country": "BR"
                     }
                  }
               ],
               "legalRepresentatives": [
                  {
                     "documentNumber": "47742663023",
                     "document": {
                        "value": "78982373748",
                        "type": "CPF"
                     },
                     "registerName": "Nísia Floresta",
                     "socialName": "",
                     "birthDate": "1810-10-12T00:00:00Z",
                     "motherName": "Dionísia Gonçalves Pinto",
                     "pep": {
                        "level": "NONE",
                        "verified": false
                     },
                     "occupation": "OCP0001",
                     "declaredIncome": "LESS_THAN_ONE_THOUSAND",
                     "memberQualification": "432-1",
                     "powerOfAttorney": {
                        "startDate": "2022-11-28T00:00:00Z",
                        "endDate": "2023-03-16T00:00:00Z"
                     },
                     "email": "[email protected]",
                     "phone": {
                        "countryCode": "55",
                        "number": "23415162342"
                     },
                     "address": {
                        "zipCode": "68060100",
                        "addressLine": "Rua 6 de Março",
                        "buildingNumber": "2500",
                        "complement": "",
                        "neighborhood": "Alter do Chão",
                        "city": "Santarém",
                        "state": "PA",
                        "country": "BR"
                     }
                  }
               ]
            }
         ],
         "legalRepresentatives": [
            {
               "documentNumber": "47742663023",
               "document": {
                  "value": "78982373748",
                  "type": "CPF"
               },
               "registerName": "Nísia Floresta",
               "socialName": "",
               "birthDate": "1810-10-12T00:00:00Z",
               "motherName": "Dionísia Gonçalves Pinto",
               "pep": {
                  "level": "NONE",
                  "verified": false
               },
               "occupation": "OCP0001",
               "declaredIncome": "LESS_THAN_ONE_THOUSAND",
               "memberQualification": "432-1",
               "powerOfAttorney": {
                  "startDate": "2022-06-28T00:00:00Z",
                  "endDate": "2022-08-31T00:00:00Z"
               },
               "email": "[email protected]",
               "phone": {
                  "countryCode": "55",
                  "number": "23415162342"
               },
               "address": {
                  "zipCode": "68060100",
                  "addressLine": "Rua 6 de Março",
                  "buildingNumber": "2500",
                  "complement": "",
                  "neighborhood": "Alter do Chão",
                  "city": "Santarém",
                  "state": "PA",
                  "country": "BR"
               }
            }
         ],
         "status": "CANCELED",
         "isBanklyPartner": false,
         "createdAt": "2022-07-29T18:17:35.121211Z",
         "updatedAt": "2022-07-29T18:17:35.1212361Z"
      }
 }

🚧

Importante

É possível que o campo owners varie dependendo do tipo da empresa, podendo apresentar até três níveis referentes ao quadro societário. Para compreender melhor as variações na estrutura do campo owners, consulte a documentação Onboarding pessoa jurídica LTDA, S.A., TS.

Faixa de faturamento anual da empresa

FaturamentoDescrição
UP_TO_FIFTY_THOUSANDAté 50 mil.
MORE_THAN_FIFTY_THOUSAND_UP_TO_ONE_HUNDRED_THOUSANDDe 50 mil a 100 mil.
MORE_THAN_ONE_HUNDRED_THOUSAND_UP_TO_TWO_HUNDRED_AND_FIFTY_THOUSANDDe 100 mil a 250 mil.
MORE_THAN_TWO_HUNDRED_AND_FIFTY_THOUSAND_UP_TO_FIVE_HUNDRED_THOUSANDDe 250 mil a 500 mil.
MORE_THAN_FIVE_HUNDRED_THOUSAND_UP_TO_ONE_MILLIONDe 500 mil a 1 milhão.
MORE_THAN_ONE_MILLION_UP_TO_TWO_MILLION_AND_FIVE_HUNDRED_THOUSANDDe 1 milhão a 2 milhões e 500 mil.
MORE_THAN_TWO_MILLION_AND_FIVE_HUNDRED_THOUSAND_UP_TO_FIVE_MILLIONDe 2 milhões e 500 mil a 5 milhões.
MORE_THAN_FIVE_MILLION_UP_TO_TEN_MILLIONDe 5 milhões a 10 milhões.
MORE_THAN_TEN_MILLION_UP_TO_TWENTY_FIVE_MILLIONDe 10 milhões a 25 milhões.
MORE_THAN_TWENTY_FIVE_MILLION_UP_TO_FIFTY_MILLIONDe 25 milhões a 50 milhões.
MORE_THAN_FIFTY_MILLION_UP_TO_ONE_HUNDRED_MILLIONDe 50 milhões a 100 milhões.
MORE_THAN_ONE_HUNDRED_MILLION_UP_TO_TWO_HUNDRED_AND_FIFTY_MILLIONDe 100 milhões a 250 milhões.
MORE_THAN_TWO_HUNDRED_AND_FIFTY_MILLION_UP_TO_FIVE_HUNDRED_MILLIONDe 250 milhões a 500 milhões.
MORE_THAN_FIVE_HUNDRED_MILLIONMais de 500 milhões.
NOT_DECLAREDNão declarada.
EXEMPT_COMPANYEmpresa isenta.
INACTIVE_COMPANYEmpresa inativa.

Faixa de renda declarada

FaturamentoDescrição
LESS_THAN_ONE_THOUSANDInferior a mil.
FROM_ONE_THOUSAND_TO_TWO_THOUSANDDe mil a dois mil.
FROM_TWO_THOUSAND_TO_THREE_THOUSANDDe 2 mil a 3 mil.
FROM_THREE_THOUSAND_TO_FIVE_THOUSANDDe 3 mil a 5 mil.
FROM_FIVE_THOUSAND_TO_TEN_THOUSANDDe 5 mil a 10 mil.
FROM_TEN_THOUSAND_TO_TWENTY_THOUSANDDe 10 mil a 20 mil.
OVER_TWENTY_THOUSANDAcima de 20 mil.