InstitucionalBlogService DeskStatus Page

MEI, EI, EIRELI ou SLU

stable

Suggest Edits

Os eventos referentes a cliente pessoa jurídica MEI, EI, EIRELI ou SLU 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 do cliente.
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: MEI, EI, EIRELI ou SLU.
businessSizestringPorte da empresa, que pode ser MEI (para empresas do tipo MEI), ME (para empresas do tipo EI, EIRELI e SLU) e EPP (para empresas do tipo EI e EIRELI).
addressobjectObjeto que contém informações sobre o endereço comercial ou residencial.
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.
declaredAnnualBillingstringFaixa de faturamento anual da empresa.
confirmedAnnualBillingstringIndica se o valor de faturamento informado foi confirmado no Bureau de informação.
owners[]array of objectsLista de objetos que contém informações sobre os sócios da empresa.
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" ou "CNPJ".
owners[].registerNamestringNome do sócio da empresa como consta no documento.
owners[].socialNamestringNome pelo qual o sócio gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social.
owners[].birthDatestringData de nascimento do sócio da empresa.
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 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[].motherNamestringNome da mãe do sócio da empresa como consta no documento de identidade.
owners[].emailstringE-mail do sócio da empresa.
owners[].declaredIncomestringFaixa de renda declarada pelo sócio.
owners[].confirmedIncomestringIndica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é "null".
owners[].occupationstringCódigo de ocupação do sócio.
owners[].pepobjectObjeto que contém o nível de exposição política do sócio, atendendo a Circular nº 3.978.
owners[].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[].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[].documentationobjectObjeto que contém os tokens de referência dos documentos do sócio que foram enviados para análise.
owners[].selfiestringToken da análise da Selfie.
owners[].idCardFrontstringToken da análise da frente do documento.
owners[].idCardBackstringToken da análise do verso do documento.
legalRepresentatives[]array of objectsLista dos representantes legais da empresa e suas informações.
legalRepresentatives[].documentobjectObjeto que contém informações sobre o documento do representante legal.
legalRepresentatives[].document.valuestringNúmero do documento.
legalRepresentatives[].document.typestringTipo do documento, o qual pode ser "CPF" OU "CNPJ".
legalRepresentatives[].registerNamestringNome do representante legal da empresa como consta no documento.
legalRepresentatives[].socialNamestringNome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social.
legalRepresentatives[].birthDatestringData de nascimento do representante legal da empresa.
legalRepresentatives[].phoneobjectObjeto que contém informações sobre o número de telefone do representante legal da empresa.
legalRepresentatives[].phone.countryCodestringCódigo DDI do país.
legalRepresentatives[].phone.numberstringNúmero de telefone incluindo DDD.
legalRepresentatives[].addressobjectObjeto que contém informações sobre o endereço comercial ou residencial.
legalRepresentatives[].address.zipcodestringCódigo postal do endereço.
legalRepresentatives[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
legalRepresentatives[].address.buildingNumberstringNúmero do imóvel.
legalRepresentatives[].address.complementstringComplemento do endereço.
legalRepresentatives[].address.neighborhoodstringNome do bairro.
legalRepresentatives[].address.citystringNome da cidade.
legalRepresentatives[].address.statestringNome do estado.
legalRepresentatives[].address.countrystringNome do país.
legalRepresentatives[].motherNamestringNome da mãe do representante legal da empresa como consta no documento de identidade.
legalRepresentatives[].emailstringE-mail do representante legal da empresa.
legalRepresentatives[].declaredIncomestringFaixa de renda declarada pelo representante legal.
legalRepresentatives[].confirmedIncomestringIndica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é "null.
legalRepresentatives[].occupationstringCódigo de ocupação do representante legal.
legalRepresentatives[].pepobjectObjeto que contém o nível de exposição política do representante legal, atendendo a Circular nº 3.978.
legalRepresentatives[].levelstringNível de exposição política do representante legal: "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).
legalRepresentatives[].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".
legalRepresentatives[].documentationobjectObjeto que contém os tokens de referência dos documentos do representante legal que foram enviados para análise.
legalRepresentatives[].selfiestringToken da análise da selfie.
legalRepresentatives[].idCardFrontstringToken da análise da frente do documento.
legalRepresentatives[].idCardBackstringToken da análise do verso do documento.
statusstringSituação do cadastro, a qual neste caso será " PENDING_APPROVAL".
isBanklyPartnerbooleanInforma se a empresa tem parceria com o Bankly.
createdAtstringData de cadastro do cliente.
updatedAtstringData da última atualização do status de cadastro.

Payload do evento

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

Exemplo de payload 
{
      "entityId": "34183937000161",
      "companyKey": "FLORESTA_ED",
      "idempotencyKey": "47574a31-4456-4658-9fb7-851de6410286",
      "correlationId": "0142d29b-8910-4bb1-8b6c-faa13b59d3ce",
      "context": "Business",
      "name": "BUSINESS_WAS_RECEIVED",
      "timestamp": "9999-99-99T23:59:59.999Z",
      "data": {
         "document": {
            "value": "34183937000161",
            "type": "CNPJ"
         },
         "businessName": "Nísia Floresta 47742663023",
         "tradingName": "Editora Nísia Floresta",
         "businessType": "MEI",
         "businessSize": "MEI",
         "address": {
            "zipcode": "68060100",
            "addressLine": "Rua 6 de Março",
            "buildingNumber": "2500",
            "complement": "",
            "neighborhood": "Alter do Chão",
            "city": "Santarém",
            "state": "PA",
            "country": "BR"
         },
         "declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
         "confirmedAnnualBilling": "string",
         "owners": [
            {
               "document": [
                  "47742663023",
                  {
                     "value": "47742663023",
                     "type": "CPF"
                  }
               ],
               "registerName": "Nísia Floresta",
               "socialName": "Nísia Floresta",
               "birthDate": "1810-10-12",
               "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"
               },
               "motherName": "Dionísia Gonçalves Pinto",
               "email": "[email protected]",
               "declaredIncome": "LESS_THAN_ONE_THOUSAND",
               "confirmedIncome": "",
               "occupation": "OCP0082",
               "pep": {
                  "level": "NONE",
                  "verified": false
               },
               "documentation": {
                  "selfie": "fba7426490274d9b95343fb201b4a526",
                  "idCardFront": "d398c19b9c1f4b2196508d1ed0c14ec4",
                  "idCardBack": "787c5eb74f8a42278787cec851a54650"
               }
            }
         ],
         "legalRepresentatives": [
            {
               "document": [
                  "47742663023",
                  {
                     "value": "47742663023",
                     "type": "CPF"
                  }
               ],
               "registerName": "Nísia Floresta",
               "socialName": "Nísia Floresta",
               "birthDate": "1810-10-12",
               "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"
               },
               "motherName": "Dionísia Gonçalves Pinto",
               "email": "[email protected]",
               "declaredIncome": "LESS_THAN_ONE_THOUSAND",
               "confirmedIncome": "",
               "occupation": "OCP0082",
               "pep": {
                  "level": "NONE",
                  "verified": false
               },
               "documentation": {
                  "selfie": "fba7426490274d9b95343fb201b4a526",
                  "idCardFront": "d398c19b9c1f4b2196508d1ed0c14ec4",
                  "idCardBack": "787c5eb74f8a42278787cec851a54650"
               }
            }
         ],
         "status": "PENDING_APPROVAL",
         "isBanklyPartner": false,
         "createdAt": "9999-99-99T23:59:59.999Z",
         "updatedAt": "9999-99-99T23:59:59.999Z"
      }
 }

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 do cliente.
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: MEI, EI, EIRELI ou SLU.
businessSizestringPorte da empresa, que pode ser MEI (para empresas do tipo MEI), ME (para empresas do tipo EI, EIRELI e SLU) e EPP (para empresas do tipo EI e EIRELI).
addressobjectObjeto que contém informações sobre o endereço comercial ou residencial.
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.
declaredAnnualBillingstringFaixa de faturamento anual da empresa.
confirmedAnnualBillingstringIndica se o valor de faturamento informado foi confirmado no Bureau de informação.
owners[]array of objectsLista de objetos que contém informações sobre os sócios da empresa.
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" ou "CNPJ".
owners[].registerNamestringNome do sócio da empresa como consta no documento.
owners[].socialNamestringNome pelo qual o sócio gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social.
owners[].birthDatestringData de nascimento do sócio da empresa.
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 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[].motherNamestringNome da mãe do sócio da empresa como consta no documento de identidade.
owners[].emailstringE-mail do sócio da empresa.
owners[].declaredIncomestringFaixa de renda declarada pelo sócio.
owners[].confirmedIncomestringIndica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é "null".
owners[].occupationstringCódigo de ocupação do sócio.
owners[].pepobjectObjeto que contém o nível de exposição política do sócio, atendendo a Circular nº 3.978.
owners[].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[].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[].documentationobjectObjeto que contém os tokens de referência dos documentos do sócio que foram enviados para análise.
owners[].selfiestringToken da análise da selfie.
owners[].idCardFrontstringToken da análise da frente do documento.
owners[].idCardBackstringToken da análise do verso do documento.
legalRepresentatives[]array of objectsLista dos representantes legais da empresa e suas informações.
legalRepresentatives[].documentobjectObjeto que contém informações sobre o documento do representante legal.
legalRepresentatives[].document.valuestringNúmero do documento.
legalRepresentatives[].document.typestringTipo do documento, o qual pode ser "CPF" OU "CNPJ".
legalRepresentatives[].registerNamestringNome do representante legal da empresa como consta no documento.
legalRepresentatives[].socialNamestringNome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social.
legalRepresentatives[].birthDatestringData de nascimento do representante legal da empresa.
legalRepresentatives[].phoneobjectObjeto que contém informações sobre o número de telefone do representante legal da empresa.
legalRepresentatives[].phone.countryCodestringCódigo DDI do país.
legalRepresentatives[].phone.numberstringNúmero de telefone incluindo DDD.
legalRepresentatives[].addressobjectObjeto que contém informações sobre o endereço comercial ou residencial.
legalRepresentatives[].address.zipcodestringCódigo postal do endereço.
legalRepresentatives[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
legalRepresentatives[].address.buildingNumberstringNúmero do imóvel.
legalRepresentatives[].address.complementstringComplemento do endereço.
legalRepresentatives[].address.neighborhoodstringNome do bairro.
legalRepresentatives[].address.citystringNome da cidade.
legalRepresentatives[].address.statestringNome do estado.
legalRepresentatives[].address.countrystringNome do país.
legalRepresentatives[].motherNamestringNome da mãe do representante legal da empresa como consta no documento de identidade.
legalRepresentatives[].emailstringE-mail do representante legal da empresa.
legalRepresentatives[].declaredIncomestringFaixa de renda declarada pelo representante legal.
legalRepresentatives[].confirmedIncomestringIndica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é "null.
legalRepresentatives[].occupationstringCódigo de ocupação do representante legal.
legalRepresentatives[].pepobjectObjeto que contém o nível de exposição política do representante legal, atendendo a Circular nº 3.978.
legalRepresentatives[].levelstringNível de exposição política do representante legal: "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).
legalRepresentatives[].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".
legalRepresentatives[].documentationobjectObjeto que contém os tokens de referência dos documentos do representante legal que foram enviados para análise.
legalRepresentatives[].selfiestringToken da análise da selfie.
legalRepresentatives[].idCardFrontstringToken da análise da frente do documento.
legalRepresentatives[].idCardBackstringToken da análise do verso do documento.
statusstringSituação do cadastro, a qual neste caso será " APPROVED".
isBanklyPartnerbooleanInforma se a empresa tem parceria com o Bankly.
createdAtstringData de cadastro do cliente.
updatedAtstringData da última atualização do status de cadastro.

Payload do evento

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

Exemplo de payload 
{
      "entityId": "34183937000161",
      "companyKey": "FLORESTA_ED",
      "idempotencyKey": "47574a31-4456-4658-9fb7-851de6410286",
      "correlationId": "0142d29b-8910-4bb1-8b6c-faa13b59d3ce",
      "context": "Business",
      "name": "BUSINESS_WAS_APPROVED",
      "timestamp": "9999-99-99T23:59:59.999Z",
      "data": {
         "document": {
            "value": "34183937000161",
            "type": "CNPJ"
         },
         "businessName": "Nísia Floresta 47742663023",
         "tradingName": "Editora Nísia Floresta",
         "businessType": "MEI",
         "businessSize": "MEI",
         "address": {
            "zipcode": "68060100",
            "addressLine": "Rua 6 de Março",
            "buildingNumber": "2500",
            "complement": "",
            "neighborhood": "Alter do Chão",
            "city": "Santarém",
            "state": "PA",
            "country": "BR"
         },
         "declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
         "confirmedAnnualBilling": "string",
         "owners": [
            {
               "document": [
                  "47742663023",
                  {
                     "value": "47742663023",
                     "type": "CPF"
                  }
               ],
               "registerName": "Nísia Floresta",
               "socialName": "Nísia Floresta",
               "birthDate": "1810-10-12",
               "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"
               },
               "motherName": "Dionísia Gonçalves Pinto",
               "email": "[email protected]",
               "declaredIncome": "LESS_THAN_ONE_THOUSAND",
               "confirmedIncome": "",
               "occupation": "OCP0082",
               "pep": {
                  "level": "NONE",
                  "verified": false
               },
               "documentation": {
                  "selfie": "fba7426490274d9b95343fb201b4a526",
                  "idCardFront": "d398c19b9c1f4b2196508d1ed0c14ec4",
                  "idCardBack": "787c5eb74f8a42278787cec851a54650"
               }
            }
         ],
         "legalRepresentatives": [
            {
               "document": [
                  "47742663023",
                  {
                     "value": "47742663023",
                     "type": "CPF"
                  }
               ],
               "registerName": "Nísia Floresta",
               "socialName": "Nísia Floresta",
               "birthDate": "1810-10-12",
               "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"
               },
               "motherName": "Dionísia Gonçalves Pinto",
               "email": "[email protected]",
               "declaredIncome": "LESS_THAN_ONE_THOUSAND",
               "confirmedIncome": "",
               "occupation": "OCP0082",
               "pep": {
                  "level": "NONE",
                  "verified": false
               },
               "documentation": {
                  "selfie": "fba7426490274d9b95343fb201b4a526",
                  "idCardFront": "d398c19b9c1f4b2196508d1ed0c14ec4",
                  "idCardBack": "787c5eb74f8a42278787cec851a54650"
               }
            }
         ],
         "status": "APPROVED",
         "isBanklyPartner": false,
         "createdAt": "9999-99-99T23:59:59.999Z",
         "updatedAt": "9999-99-99T23:59:59.999Z"
      }
 }

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 do cliente.
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: MEI, EI, EIRELI ou SLU.
businessSizestringPorte da empresa, que pode ser MEI (para empresas do tipo MEI), ME (para empresas do tipo EI, EIRELI e SLU) e EPP (para empresas do tipo EI e EIRELI).
addressobjectObjeto que contém informações sobre o endereço comercial ou residencial.
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.
declaredAnnualBillingstringFaixa de faturamento anual da empresa.
confirmedAnnualBillingstringIndica se o valor de faturamento informado foi confirmado no Bureau de informação.
owners[]array of objectsLista de objetos que contém informações sobre os sócios da empresa.
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" ou "CNPJ".
owners[].registerNamestringNome do sócio da empresa como consta no documento.
owners[].socialNamestringNome pelo qual o sócio gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social.
owners[].birthDatestringData de nascimento do sócio da empresa.
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 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[].motherNamestringNome da mãe do sócio da empresa como consta no documento de identidade.
owners[].emailstringE-mail do sócio da empresa.
owners[].declaredIncomestringFaixa de renda declarada pelo sócio.
owners[].confirmedIncomestringIndica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é "null".
owners[].occupationstringCódigo de ocupação do sócio.
owners[].pepobjectObjeto que contém o nível de exposição política do sócio, atendendo a Circular nº 3.978.
owners[].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[].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[].documentationobjectObjeto que contém os tokens de referência dos documentos do sócio que foram enviados para análise.
owners[].selfiestringToken da análise da selfie.
owners[].idCardFrontstringToken da análise da frente do documento.
owners[].idCardBackstringToken da análise do verso do documento.
legalRepresentatives[]array of objectsLista dos representantes legais da empresa e suas informações.
legalRepresentatives[].documentobjectObjeto que contém informações sobre o documento do representante legal.
legalRepresentatives[].document.valuestringNúmero do documento.
legalRepresentatives[].document.typestringTipo do documento, o qual pode ser "CPF" OU "CNPJ".
legalRepresentatives[].registerNamestringNome do representante legal da empresa como consta no documento.
legalRepresentatives[].socialNamestringNome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social.
legalRepresentatives[].birthDatestringData de nascimento do representante legal da empresa.
legalRepresentatives[].phoneobjectObjeto que contém informações sobre o número de telefone do representante legal da empresa.
legalRepresentatives[].phone.countryCodestringCódigo DDI do país.
legalRepresentatives[].phone.numberstringNúmero de telefone incluindo DDD.
legalRepresentatives[].addressobjectObjeto que contém informações sobre o endereço comercial ou residencial.
legalRepresentatives[].address.zipcodestringCódigo postal do endereço.
legalRepresentatives[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
legalRepresentatives[].address.buildingNumberstringNúmero do imóvel.
legalRepresentatives[].address.complementstringComplemento do endereço.
legalRepresentatives[].address.neighborhoodstringNome do bairro.
legalRepresentatives[].address.citystringNome da cidade.
legalRepresentatives[].address.statestringNome do estado.
legalRepresentatives[].address.countrystringNome do país.
legalRepresentatives[].motherNamestringNome da mãe do representante legal da empresa como consta no documento de identidade.
legalRepresentatives[].emailstringE-mail do representante legal da empresa.
legalRepresentatives[].declaredIncomestringFaixa de renda declarada pelo representante legal.
legalRepresentatives[].confirmedIncomestringIndica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é "null.
legalRepresentatives[].occupationstringCódigo de ocupação do representante legal.
legalRepresentatives[].pepobjectObjeto que contém o nível de exposição política do representante legal, atendendo a Circular nº 3.978.
legalRepresentatives[].levelstringNível de exposição política do representante legal: "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).
legalRepresentatives[].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".
legalRepresentatives[].documentationobjectObjeto que contém os tokens de referência dos documentos do representante legal que foram enviados para análise.
legalRepresentatives[].selfiestringToken da análise da selfie.
legalRepresentatives[].idCardFrontstringToken da análise da frente do documento.
legalRepresentatives[].idCardBackstringToken da análise do verso do documento.
statusstringSituação do cadastro, a qual neste caso será " REPROVED".
isBanklyPartnerbooleanInforma se a empresa tem parceria com o Bankly.
createdAtstringData de cadastro do cliente.
updatedAtstringData da última atualização do status de cadastro.
reprovedReasonsarray of stringsLista dos motivos pelos quais o cadastro foi reprovado.

Payload do evento

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

Exemplo de payload 
{
      "entityId": "34183937000161",
      "companyKey": "FLORESTA_ED",
      "idempotencyKey": "47574a31-4456-4658-9fb7-851de6410286",
      "correlationId": "0142d29b-8910-4bb1-8b6c-faa13b59d3ce",
      "context": "Business",
      "name": "BUSINESS_WAS_REPROVED",
      "timestamp": "9999-99-99T23:59:59.999Z",
      "data": {
         "document": {
            "value": "34183937000161",
            "type": "CNPJ"
         },
         "businessName": "Nísia Floresta 47742663023",
         "tradingName": "Editora Nísia Floresta",
         "businessType": "MEI",
         "businessSize": "MEI",
         "address": {
            "zipcode": "68060100",
            "addressLine": "Rua 6 de Março",
            "buildingNumber": "2500",
            "complement": "",
            "neighborhood": "Alter do Chão",
            "city": "Santarém",
            "state": "PA",
            "country": "BR"
         },
         "declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
         "confirmedAnnualBilling": "string",
         "owners": [
            {
               "document": [
                  "47742663023",
                  {
                     "value": "47742663023",
                     "type": "CPF"
                  }
               ],
               "registerName": "Nísia Floresta",
               "socialName": "Nísia Floresta",
               "birthDate": "1810-10-12",
               "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"
               },
               "motherName": "Dionísia Gonçalves Pinto",
               "email": "[email protected]",
               "declaredIncome": "LESS_THAN_ONE_THOUSAND",
               "confirmedIncome": "",
               "occupation": "OCP0082",
               "pep": {
                  "level": "NONE",
                  "verified": false
               },
               "documentation": {
                  "selfie": "fba7426490274d9b95343fb201b4a526",
                  "idCardFront": "d398c19b9c1f4b2196508d1ed0c14ec4",
                  "idCardBack": "787c5eb74f8a42278787cec851a54650"
               }
            }
         ],
         "legalRepresentatives": [
            {
               "document": [
                  "47742663023",
                  {
                     "value": "47742663023",
                     "type": "CPF"
                  }
               ],
               "registerName": "Nísia Floresta",
               "socialName": "Nísia Floresta",
               "birthDate": "1810-10-12",
               "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"
               },
               "motherName": "Dionísia Gonçalves Pinto",
               "email": "[email protected]",
               "declaredIncome": "LESS_THAN_ONE_THOUSAND",
               "confirmedIncome": "",
               "occupation": "OCP0082",
               "pep": {
                  "level": "NONE",
                  "verified": false
               },
               "documentation": {
                  "selfie": "fba7426490274d9b95343fb201b4a526",
                  "idCardFront": "d398c19b9c1f4b2196508d1ed0c14ec4",
                  "idCardBack": "787c5eb74f8a42278787cec851a54650"
               }
            }
         ],
         "status": "REPROVED",
         "isBanklyPartner": false,
         "createdAt": "9999-99-99T23:59:59.999Z",
         "updatedAt": "9999-99-99T23:59:59.999Z",
         "reprovedReasons": [
            "SELFIE_RECUSED",
            "DOCUMENT_RECUSED"
         ]
      }
 }

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 do cliente.
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: MEI, EI, EIRELI ou SLU.
businessSizestringPorte da empresa, que pode ser MEI (para empresas do tipo MEI), ME (para empresas do tipo EI, EIRELI e SLU) e EPP (para empresas do tipo EI e EIRELI).
addressobjectObjeto que contém informações sobre o endereço comercial ou residencial.
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.
declaredAnnualBillingstringFaixa de faturamento anual da empresa.
confirmedAnnualBillingstringIndica se o valor de faturamento informado foi confirmado no Bureau de informação.
owners[]array of objectsLista de objetos que contém informações sobre os sócios da empresa.
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" ou "CNPJ".
owners[].registerNamestringNome do sócio da empresa como consta no documento.
owners[].socialNamestringNome pelo qual o sócio gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social.
owners[].birthDatestringData de nascimento do sócio da empresa.
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 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[].motherNamestringNome da mãe do sócio da empresa como consta no documento de identidade.
owners[].emailstringE-mail do sócio da empresa.
owners[].declaredIncomestringFaixa de renda declarada pelo sócio.
owners[].confirmedIncomestringIndica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é "null".
owners[].occupationstringCódigo de ocupação do sócio.
owners[].pepobjectObjeto que contém o nível de exposição política do sócio, atendendo a Circular nº 3.978.
owners[].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[].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[].documentationobjectObjeto que contém os tokens de referência dos documentos do sócio que foram enviados para análise.
owners[].selfiestringToken da análise da Selfie.
owners[].idCardFrontstringToken da análise da frente do documento.
owners[].idCardBackstringToken da análise do verso do documento.
legalRepresentatives[]array of objectsLista dos representantes legais da empresa e suas informações.
legalRepresentatives[].document[]array of objectsLista de objetos contendo informações sobre o documento de cada representante legal.
legalRepresentatives[].document[].valuestringNúmero do documento.
legalRepresentatives[].document[].typestringTipo do documento, o qual pode ser "CPF" OU "CNPJ".
legalRepresentatives[].registerNamestringNome do representante legal da empresa como consta no documento.
legalRepresentatives[].socialNamestringNome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social.
legalRepresentatives[].birthDatestringData de nascimento do representante legal da empresa.
legalRepresentatives[].phoneobjectObjeto que contém informações sobre o número de telefone do representante legal da empresa.
legalRepresentatives[].phone.countryCodestringCódigo DDI do país.
legalRepresentatives[].phone.numberstringNúmero de telefone incluindo DDD.
legalRepresentatives[].addressobjectObjeto que contém informações sobre o endereço comercial ou residencial.
legalRepresentatives[].address.zipcodestringCódigo postal do endereço.
legalRepresentatives[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
legalRepresentatives[].address.buildingNumberstringNúmero do imóvel.
legalRepresentatives[].address.complementstringComplemento do endereço.
legalRepresentatives[].address.neighborhoodstringNome do bairro.
legalRepresentatives[].address.citystringNome da cidade.
legalRepresentatives[].address.statestringNome do estado.
legalRepresentatives[].address.countrystringNome do país.
legalRepresentatives[].motherNamestringNome da mãe do representante legal da empresa como consta no documento de identidade.
legalRepresentatives[].emailstringE-mail do representante legal da empresa.
legalRepresentatives[].declaredIncomestringFaixa de renda declarada pelo representante legal.
legalRepresentatives[].confirmedIncomestringIndica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é "null.
legalRepresentatives[].occupationstringCódigo de ocupação do representante legal.
legalRepresentatives[].pepobjectObjeto que contém o nível de exposição política do representante legal, atendendo a Circular nº 3.978.
legalRepresentatives[].levelstringNível de exposição política do representante legal: "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).
legalRepresentatives[].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".
legalRepresentatives[].documentationobjectObjeto que contém os tokens de referência dos documentos do representante legal que foram enviados para análise.
legalRepresentatives[].selfiestringToken da análise da selfie.
legalRepresentatives[].idCardFrontstringToken da análise da frente do documento.
legalRepresentatives[].idCardBackstringToken da análise do verso do documento.
statusstringSituação do cadastro, a qual neste caso será " CANCELED".
isBanklyPartnerbooleanInforma se a empresa tem parceria com o Bankly.
createdAtstringData de cadastro do cliente.
updatedAtstringData da última atualização do status de cadastro.

Payload do evento

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

Exemplo de payload 
{
      "entityId": "34183937000161",
      "companyKey": "FLORESTA_ED",
      "idempotencyKey": "47574a31-4456-4658-9fb7-851de6410286",
      "correlationId": "0142d29b-8910-4bb1-8b6c-faa13b59d3ce",
      "context": "Business",
      "name": "BUSINESS_WAS_CANCELED",
      "timestamp": "9999-99-99T23:59:59.999Z",
      "data": {
         "document": {
            "value": "34183937000161",
            "type": "CNPJ"
         },
         "businessName": "Nísia Floresta 47742663023",
         "tradingName": "Editora Nísia Floresta",
         "businessType": "MEI",
         "businessSize": "MEI",
         "address": {
            "zipcode": "68060100",
            "addressLine": "Rua 6 de Março",
            "buildingNumber": "2500",
            "complement": "",
            "neighborhood": "Alter do Chão",
            "city": "Santarém",
            "state": "PA",
            "country": "BR"
         },
         "declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
         "confirmedAnnualBilling": "string",
         "owners": [
            {
               "document": [
                  "47742663023",
                  {
                     "value": "47742663023",
                     "type": "CPF"
                  }
               ],
               "registerName": "Nísia Floresta",
               "socialName": "Nísia Floresta",
               "birthDate": "1810-10-12",
               "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"
               },
               "motherName": "Dionísia Gonçalves Pinto",
               "email": "[email protected]",
               "declaredIncome": "LESS_THAN_ONE_THOUSAND",
               "confirmedIncome": "",
               "occupation": "OCP0082",
               "pep": {
                  "level": "NONE",
                  "verified": false
               },
               "documentation": {
                  "selfie": "fba7426490274d9b95343fb201b4a526",
                  "idCardFront": "d398c19b9c1f4b2196508d1ed0c14ec4",
                  "idCardBack": "787c5eb74f8a42278787cec851a54650"
               }
            }
         ],
         "legalRepresentatives": [
            {
               "document": [
                  "47742663023",
                  {
                     "value": "47742663023",
                     "type": "CPF"
                  }
               ],
               "registerName": "Nísia Floresta",
               "socialName": "Nísia Floresta",
               "birthDate": "1810-10-12",
               "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"
               },
               "motherName": "Dionísia Gonçalves Pinto",
               "email": "[email protected]",
               "declaredIncome": "LESS_THAN_ONE_THOUSAND",
               "confirmedIncome": "",
               "occupation": "OCP0082",
               "pep": {
                  "level": "NONE",
                  "verified": false
               },
               "documentation": {
                  "selfie": "fba7426490274d9b95343fb201b4a526",
                  "idCardFront": "d398c19b9c1f4b2196508d1ed0c14ec4",
                  "idCardBack": "787c5eb74f8a42278787cec851a54650"
               }
            }
         ],
         "status": "CANCELED",
         "isBanklyPartner": false,
         "createdAt": "9999-99-99T23:59:59.999Z",
         "updatedAt": "9999-99-99T23:59:59.999Z"
      }
 }


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.

Updated 5 days ago