MEI, EI, EIRELI ou SLU

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á:

Configurar previamente o recebedor de eventos do webhook.
Conhecer a estrutura básica dos eventos que acompanha o objeto data.

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
`Business`	`BUSINESS_WAS_RECEIVED`	A solicitação de cadastro do cliente foi recebida.
`Business`	`BUSINESS_WAS_APPROVED`	O cadastro do cliente foi aprovado.
`Business`	`BUSINESS_WAS_REPROVED`	O cadastro do cliente foi reprovado.
`Business`	`BUSINESS_WAS_CANCELED`	O 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:

Nome	Tipo	Descrição
`document`	`object`	Objeto que contém informações sobre o documento do cliente.
`document.value`	`string`	Número do documento.
`document.type`	`string`	Tipo do documento. Neste caso, "CNPJ".
`businessName`	`string`	Razão social da empresa.
`tradingName`	`string`	Nome fantasia da empresa, também conhecido como nome comercial.
`businessType`	`string`	Tipo de negócio, que pode ser MEI, EI, EIRELI ou SLU.
`businessSize`	`string`	Porte da empresa, que pode ser MEI, ME ou EPP.
`address`	`object`	Objeto que contém informações sobre o endereço comercial ou residencial.
`address.zipcode`	`string`	Código postal do endereço.
`address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`address.buildingNumber`	`string`	Número do imóvel.
`address.complement`	`string`	Complemento do endereço.
`address.neighborhood`	`string`	Nome do bairro.
`address.city`	`string`	Nome da cidade.
`address.state`	`string`	Sigla do estado.
`address.country`	`string`	Sigla do país.
`declaredAnnualBilling`	`string`	Faixa de faturamento anual da empresa.
`confirmedAnnualBilling`	`string`	Indica se o valor de faturamento informado foi confirmado no Bureau de informação.
`owners[]`	`array of objects`	Lista de objetos contendo informações sobre os sócios da empresa.
`owners[].document`	`object`	Objeto que contém informações sobre o documento do sócio.
`owners[].document.value`	`string`	Número do documento.
`owners[].document.type`	`string`	Tipo do documento, que pode ser "CPF" ou "CNPJ".
`owners[].registerName`	`string`	Nome do sócio da empresa como consta no documento.
`owners[].socialName`	`string`	Nome pelo qual o sócio gostaria de ser chamado.
`owners[].birthDate`	`string`	Data de nascimento do sócio da empresa.
`owners[].phone`	`object`	Objeto que contém informações sobre o número de telefone do sócio da empresa.
`owners[].phone.countryCode`	`string`	Código DDI do país.
`owners[].phone.number`	`string`	Número de telefone incluindo DDD.
`owners[].address`	`object`	Objeto que contém informações sobre o endereço do sócio.
`owners[].address.zipcode`	`string`	Código postal do endereço.
`owners[].address.addressLine`	`string`	Logradouro.
`owners[].address.buildingNumber`	`string`	Número do imóvel.
`owners[].address.complement`	`string`	Complemento do endereço.
`owners[].address.neighborhood`	`string`	Nome do bairro.
`owners[].address.city`	`string`	Nome da cidade.
`owners[].address.state`	`string`	Sigla do estado.
`owners[].address.country`	`string`	Sigla do país.
`owners[].motherName`	`string`	Nome da mãe do sócio.
`owners[].email`	`string`	E-mail do sócio.
`owners[].declaredIncome`	`string`	Faixa de renda declarada pelo sócio.
`owners[].confirmedIncome`	`string`	Indica se o valor informado da renda foi confirmado no Bureau de informação.
`owners[].occupation`	`string`	Código de ocupação do sócio.
`owners[].pep`	`object`	Objeto que contém o nível de exposição política do sócio.
`owners[].level`	`string`	Nível de exposição política do sócio ("NONE", "SELF", "RELATED").
`owners[].verified`	`boolean`	Indica se a situação de PEP foi verificada.
`owners[].documentation`	`object`	Tokens de referência dos documentos do sócio enviados para análise.
`owners[].selfie`	`string`	Token da análise da selfie.
`owners[].idCardFront`	`string`	Token da análise da frente do documento.
`owners[].idCardBack`	`string`	Token da análise do verso do documento.
`legalRepresentatives[]`	`array of objects`	Lista de objetos contendo informações sobre os representantes legais da empresa.
`legalRepresentatives[].document`	`object`	Objeto que contém informações sobre o documento do representante legal.
`legalRepresentatives[].document.value`	`string`	Número do documento.
`legalRepresentatives[].document.type`	`string`	Tipo do documento, que pode ser "CPF" ou "CNPJ".
`legalRepresentatives[].registerName`	`string`	Nome do representante legal como consta no documento.
`legalRepresentatives[].socialName`	`string`	Nome pelo qual o representante legal gostaria de ser chamado.
`legalRepresentatives[].birthDate`	`string`	Data de nascimento do representante legal.
`legalRepresentatives[].phone`	`object`	Objeto que contém informações sobre o número de telefone do representante legal.
`legalRepresentatives[].phone.countryCode`	`string`	Código DDI do país.
`legalRepresentatives[].phone.number`	`string`	Número de telefone incluindo DDD.
`legalRepresentatives[].address`	`object`	Objeto que contém informações sobre o endereço do representante legal.
`legalRepresentatives[].address.zipcode`	`string`	Código postal do endereço.
`legalRepresentatives[].address.addressLine`	`string`	Logradouro.
`legalRepresentatives[].address.buildingNumber`	`string`	Número do imóvel.
`legalRepresentatives[].address.complement`	`string`	Complemento do endereço.
`legalRepresentatives[].address.neighborhood`	`string`	Nome do bairro.
`legalRepresentatives[].address.city`	`string`	Nome da cidade.
`legalRepresentatives[].address.state`	`string`	Sigla do estado.
`legalRepresentatives[].address.country`	`string`	Sigla do país.
`legalRepresentatives[].motherName`	`string`	Nome da mãe do representante legal.
`legalRepresentatives[].email`	`string`	E-mail do representante legal.
`legalRepresentatives[].declaredIncome`	`string`	Faixa de renda declarada pelo representante legal.
`legalRepresentatives[].confirmedIncome`	`string`	Indica se o valor informado da renda foi confirmado.
`legalRepresentatives[].occupation`	`string`	Código de ocupação do representante legal.
`legalRepresentatives[].pep`	`object`	Objeto que contém informações sobre o nível de exposição política do representante legal.
`legalRepresentatives[].level`	`string`	Nível de exposição política do representante legal ("NONE", "SELF", "RELATED").
`legalRepresentatives[].verified`	`boolean`	Indica se a situação de PEP foi verificada.
`legalRepresentatives[].documentation`	`object`	Tokens de referência dos documentos enviados para análise.
`legalRepresentatives[].selfie`	`string`	Token da análise da selfie.
`legalRepresentatives[].idCardFront`	`string`	Token da análise da frente do documento.
`legalRepresentatives[].idCardBack`	`string`	Token da análise do verso do documento.
`status`	`string`	Situação do cadastro ("PENDING_APPROVAL").
`isBanklyPartner`	`boolean`	Informa se a empresa tem parceria com o Hiperbanco.
`createdAt`	`string`	Data de cadastro da empresa (ISO 8601 - UTC).
`updatedAt`	`string`	Data da última atualização do status de cadastro (ISO 8601 - UTC).

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": "HIPERBANCO_SANDBOX",
 "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:

Nome	Tipo	Descrição
`document`	`object`	Objeto que contém informações sobre o documento do cliente.
`document.value`	`string`	Número do documento.
`document.type`	`string`	Tipo do documento. Neste caso, "CNPJ".
`businessName`	`string`	Razão social da empresa.
`tradingName`	`string`	Nome fantasia da empresa, também conhecido como nome comercial.
`businessType`	`string`	Tipo de negócio, que pode ser MEI, EI, EIRELI ou SLU.
`businessSize`	`string`	Porte da empresa: MEI, ME ou EPP.
`address`	`object`	Objeto que contém informações sobre o endereço comercial ou residencial.
`address.zipcode`	`string`	Código postal do endereço.
`address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`address.buildingNumber`	`string`	Número do imóvel.
`address.complement`	`string`	Complemento do endereço.
`address.neighborhood`	`string`	Nome do bairro.
`address.city`	`string`	Nome da cidade.
`address.state`	`string`	Sigla do estado.
`address.country`	`string`	Sigla do país.
`declaredAnnualBilling`	`string`	Faixa de faturamento anual da empresa.
`confirmedAnnualBilling`	`string`	Indica se o valor de faturamento informado foi confirmado no Bureau de informação.
`owners[]`	`array of objects`	Lista de objetos contendo informações sobre os sócios da empresa.
`owners[].document`	`object`	Objeto que contém informações sobre o documento do sócio.
`owners[].document.value`	`string`	Número do documento.
`owners[].document.type`	`string`	Tipo do documento, que pode ser "CPF" ou "CNPJ".
`owners[].registerName`	`string`	Nome do sócio como consta no documento.
`owners[].socialName`	`string`	Nome social do sócio.
`owners[].birthDate`	`string`	Data de nascimento do sócio.
`owners[].phone`	`object`	Objeto que contém informações sobre o número de telefone do sócio.
`owners[].phone.countryCode`	`string`	Código DDI do país.
`owners[].phone.number`	`string`	Número de telefone incluindo DDD.
`owners[].address`	`object`	Objeto que contém informações sobre o endereço do sócio.
`owners[].address.zipcode`	`string`	Código postal do endereço.
`owners[].address.addressLine`	`string`	Logradouro.
`owners[].address.buildingNumber`	`string`	Número do imóvel.
`owners[].address.complement`	`string`	Complemento do endereço.
`owners[].address.neighborhood`	`string`	Nome do bairro.
`owners[].address.city`	`string`	Nome da cidade.
`owners[].address.state`	`string`	Sigla do estado.
`owners[].address.country`	`string`	Sigla do país.
`owners[].motherName`	`string`	Nome da mãe do sócio.
`owners[].email`	`string`	E-mail do sócio.
`owners[].declaredIncome`	`string`	Faixa de renda declarada pelo sócio.
`owners[].confirmedIncome`	`string`	Valor confirmado da renda pelo Bureau de informação.
`owners[].occupation`	`string`	Código de ocupação do sócio.
`owners[].pep`	`object`	Objeto com informações sobre exposição política do sócio.
`owners[].level`	`string`	Nível de exposição política ("NONE", "SELF", "RELATED").
`owners[].verified`	`boolean`	Indica se a situação de PEP foi verificada.
`owners[].documentation`	`object`	Tokens de referência dos documentos enviados para análise.
`owners[].selfie`	`string`	Token da análise da selfie.
`owners[].idCardFront`	`string`	Token da análise da frente do documento.
`owners[].idCardBack`	`string`	Token da análise do verso do documento.
`legalRepresentatives[]`	`array of objects`	Lista de objetos contendo informações sobre os representantes legais da empresa.
`legalRepresentatives[].document`	`object`	Objeto que contém informações sobre o documento do representante legal.
`legalRepresentatives[].document.value`	`string`	Número do documento.
`legalRepresentatives[].document.type`	`string`	Tipo do documento, que pode ser "CPF" ou "CNPJ".
`legalRepresentatives[].registerName`	`string`	Nome do representante legal como consta no documento.
`legalRepresentatives[].socialName`	`string`	Nome social do representante legal.
`legalRepresentatives[].birthDate`	`string`	Data de nascimento do representante legal.
`legalRepresentatives[].phone`	`object`	Objeto que contém informações sobre o número de telefone do representante legal.
`legalRepresentatives[].phone.countryCode`	`string`	Código DDI do país.
`legalRepresentatives[].phone.number`	`string`	Número de telefone incluindo DDD.
`legalRepresentatives[].address`	`object`	Objeto que contém informações sobre o endereço do representante legal.
`legalRepresentatives[].address.zipcode`	`string`	Código postal do endereço.
`legalRepresentatives[].address.addressLine`	`string`	Logradouro.
`legalRepresentatives[].address.buildingNumber`	`string`	Número do imóvel.
`legalRepresentatives[].address.complement`	`string`	Complemento do endereço.
`legalRepresentatives[].address.neighborhood`	`string`	Nome do bairro.
`legalRepresentatives[].address.city`	`string`	Nome da cidade.
`legalRepresentatives[].address.state`	`string`	Sigla do estado.
`legalRepresentatives[].address.country`	`string`	Sigla do país.
`legalRepresentatives[].motherName`	`string`	Nome da mãe do representante legal.
`legalRepresentatives[].email`	`string`	E-mail do representante legal.
`legalRepresentatives[].declaredIncome`	`string`	Faixa de renda declarada pelo representante legal.
`legalRepresentatives[].confirmedIncome`	`string`	Valor confirmado da renda pelo Bureau de informação.
`legalRepresentatives[].occupation`	`string`	Código de ocupação do representante legal.
`legalRepresentatives[].pep`	`object`	Objeto com informações sobre exposição política do representante legal.
`legalRepresentatives[].level`	`string`	Nível de exposição política ("NONE", "SELF", "RELATED").
`legalRepresentatives[].verified`	`boolean`	Indica se a situação de PEP foi verificada.
`legalRepresentatives[].documentation`	`object`	Tokens de referência dos documentos enviados para análise.
`legalRepresentatives[].selfie`	`string`	Token da análise da selfie.
`legalRepresentatives[].idCardFront`	`string`	Token da análise da frente do documento.
`legalRepresentatives[].idCardBack`	`string`	Token da análise do verso do documento.
`status`	`string`	Situação do cadastro ("APPROVED").
`isBanklyPartner`	`boolean`	Indica se a empresa tem parceria com o Hiperbanco.
`createdAt`	`string`	Data de cadastro (ISO 8601 - UTC).
`updatedAt`	`string`	Data da última atualização do cadastro (ISO 8601 - UTC).

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": "HIPERBANCO_SANDBOX",
 "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:

Nome	Tipo	Descrição
`document`	`object`	Objeto que contém informações sobre o documento do cliente.
`document.value`	`string`	Número do documento.
`document.type`	`string`	Tipo do documento. Neste caso, "CNPJ".
`businessName`	`string`	Razão social da empresa.
`tradingName`	`string`	Nome fantasia da empresa, também conhecido como nome comercial.
`businessType`	`string`	Tipo de negócio, que pode ser MEI, EI, EIRELI ou SLU.
`businessSize`	`string`	Porte da empresa: MEI, ME ou EPP.
`address`	`object`	Objeto que contém informações sobre o endereço comercial ou residencial.
`address.zipcode`	`string`	Código postal do endereço.
`address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`address.buildingNumber`	`string`	Número do imóvel.
`address.complement`	`string`	Complemento do endereço.
`address.neighborhood`	`string`	Nome do bairro.
`address.city`	`string`	Nome da cidade.
`address.state`	`string`	Sigla do estado.
`address.country`	`string`	Sigla do país.
`declaredAnnualBilling`	`string`	Faixa de faturamento anual da empresa.
`confirmedAnnualBilling`	`string`	Indica se o valor de faturamento informado foi confirmado no Bureau de informação.
`owners[]`	`array of objects`	Lista de objetos contendo informações sobre os sócios da empresa.
`owners[].document`	`object`	Objeto que contém informações sobre o documento do sócio.
`owners[].document.value`	`string`	Número do documento.
`owners[].document.type`	`string`	Tipo de documento, que pode ser "CPF" ou "CNPJ".
`owners[].registerName`	`string`	Nome do sócio da empresa como consta no documento.
`owners[].socialName`	`string`	Nome social do sócio.
`owners[].birthDate`	`string`	Data de nascimento do sócio.
`owners[].phone`	`object`	Objeto que contém informações sobre o número de telefone do sócio.
`owners[].phone.countryCode`	`string`	Código DDI do país.
`owners[].phone.number`	`string`	Número de telefone incluindo DDD.
`owners[].address`	`object`	Objeto que contém informações sobre o endereço comercial ou residencial.
`owners[].address.zipcode`	`string`	Código postal do endereço.
`owners[].address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`owners[].address.buildingNumber`	`string`	Número do imóvel.
`owners[].address.complement`	`string`	Complemento do endereço.
`owners[].address.neighborhood`	`string`	Nome do bairro.
`owners[].address.city`	`string`	Nome da cidade.
`owners[].address.state`	`string`	Sigla do estado.
`owners[].address.country`	`string`	Sigla do país.
`owners[].motherName`	`string`	Nome da mãe do sócio da empresa.
`owners[].email`	`string`	E-mail do sócio.
`owners[].declaredIncome`	`string`	Faixa de renda declarada pelo sócio.
`owners[].confirmedIncome`	`string`	Valor confirmado da renda pelo Bureau de informação.
`owners[].occupation`	`string`	Código de ocupação do sócio.
`owners[].pep`	`object`	Objeto que contém informações sobre o nível de exposição política do sócio.
`owners[].level`	`string`	Nível de exposição política ("NONE", "SELF", "RELATED").
`owners[].verified`	`boolean`	Indica se a situação de vínculo com pessoa politicamente exposta foi verificada.
`owners[].documentation`	`object`	Tokens de referência dos documentos do sócio enviados para análise.
`owners[].selfie`	`string`	Token da análise da selfie.
`owners[].idCardFront`	`string`	Token da análise da frente do documento.
`owners[].idCardBack`	`string`	Token da análise do verso do documento.
`legalRepresentatives[]`	`array of objects`	Lista de objetos contendo informações sobre os representantes legais da empresa.
`legalRepresentatives[].document`	`object`	Objeto que contém informações sobre o documento do representante legal.
`legalRepresentatives[].document.value`	`string`	Número do documento.
`legalRepresentatives[].document.type`	`string`	Tipo do documento, que pode ser "CPF" ou "CNPJ".
`legalRepresentatives[].registerName`	`string`	Nome do representante legal como consta no documento.
`legalRepresentatives[].socialName`	`string`	Nome social do representante legal.
`legalRepresentatives[].birthDate`	`string`	Data de nascimento do representante legal.
`legalRepresentatives[].phone`	`object`	Objeto que contém informações sobre o número de telefone do representante legal.
`legalRepresentatives[].phone.countryCode`	`string`	Código DDI do país.
`legalRepresentatives[].phone.number`	`string`	Número de telefone incluindo DDD.
`legalRepresentatives[].address`	`object`	Objeto que contém informações sobre o endereço comercial ou residencial do representante legal.
`legalRepresentatives[].address.zipcode`	`string`	Código postal do endereço.
`legalRepresentatives[].address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`legalRepresentatives[].address.buildingNumber`	`string`	Número do imóvel.
`legalRepresentatives[].address.complement`	`string`	Complemento do endereço.
`legalRepresentatives[].address.neighborhood`	`string`	Nome do bairro.
`legalRepresentatives[].address.city`	`string`	Nome da cidade.
`legalRepresentatives[].address.state`	`string`	Sigla do estado.
`legalRepresentatives[].address.country`	`string`	Sigla do país.
`legalRepresentatives[].motherName`	`string`	Nome da mãe do representante legal.
`legalRepresentatives[].email`	`string`	E-mail do representante legal.
`legalRepresentatives[].declaredIncome`	`string`	Faixa de renda declarada pelo representante legal.
`legalRepresentatives[].confirmedIncome`	`string`	Valor confirmado da renda pelo Bureau de informação.
`legalRepresentatives[].occupation`	`string`	Código de ocupação do representante legal.
`legalRepresentatives[].pep`	`object`	Objeto que contém informações sobre o nível de exposição política do representante legal.
`legalRepresentatives[].level`	`string`	Nível de exposição política ("NONE", "SELF", "RELATED").
`legalRepresentatives[].verified`	`boolean`	Indica se a situação de PEP foi verificada.
`legalRepresentatives[].documentation`	`object`	Tokens de referência dos documentos enviados para análise.
`legalRepresentatives[].selfie`	`string`	Token da análise da selfie.
`legalRepresentatives[].idCardFront`	`string`	Token da análise da frente do documento.
`legalRepresentatives[].idCardBack`	`string`	Token da análise do verso do documento.
`status`	`string`	Situação do cadastro ("REPROVED").
`isBanklyPartner`	`boolean`	Indica se a empresa tem parceria com o Hiperbanco.
`createdAt`	`string`	Data de cadastro (ISO 8601 - UTC).
`updatedAt`	`string`	Data da última atualização do cadastro (ISO 8601 - UTC).
`reprovedReasons`	`array of strings`	Lista 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": "HIPERBANCO_SANDBOX",
 "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:

Nome	Tipo	Descrição
`document`	`object`	Objeto que contém informações sobre o documento do cliente.
`document.value`	`string`	Número do documento.
`document.type`	`string`	Tipo do documento. Neste caso, "CNPJ".
`businessName`	`string`	Razão social da empresa.
`tradingName`	`string`	Nome fantasia da empresa, também conhecido como nome comercial.
`businessType`	`string`	Tipo de negócio, que pode ser MEI, EI, EIRELI ou SLU.
`businessSize`	`string`	Porte da empresa: MEI, ME ou EPP.
`address`	`object`	Objeto que contém informações sobre o endereço comercial ou residencial.
`address.zipcode`	`string`	Código postal do endereço.
`address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`address.buildingNumber`	`string`	Número do imóvel.
`address.complement`	`string`	Complemento do endereço.
`address.neighborhood`	`string`	Nome do bairro.
`address.city`	`string`	Nome da cidade.
`address.state`	`string`	Sigla do estado.
`address.country`	`string`	Sigla do país.
`declaredAnnualBilling`	`string`	Faixa de faturamento anual da empresa.
`confirmedAnnualBilling`	`string`	Indica se o valor de faturamento informado foi confirmado no Bureau de informação.
`owners[]`	`array of objects`	Lista de objetos contendo informações sobre os sócios da empresa.
`owners[].document`	`object`	Objeto que contém informações sobre o documento do sócio.
`owners[].document.value`	`string`	Número do documento.
`owners[].document.type`	`string`	Tipo de documento, que pode ser "CPF" ou "CNPJ".
`owners[].registerName`	`string`	Nome do sócio da empresa como consta no documento.
`owners[].socialName`	`string`	Nome social do sócio.
`owners[].birthDate`	`string`	Data de nascimento do sócio.
`owners[].phone`	`object`	Objeto que contém informações sobre o número de telefone do sócio.
`owners[].phone.countryCode`	`string`	Código DDI do país.
`owners[].phone.number`	`string`	Número de telefone incluindo DDD.
`owners[].address`	`object`	Objeto que contém informações sobre o endereço comercial ou residencial.
`owners[].address.zipcode`	`string`	Código postal do endereço.
`owners[].address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`owners[].address.buildingNumber`	`string`	Número do imóvel.
`owners[].address.complement`	`string`	Complemento do endereço.
`owners[].address.neighborhood`	`string`	Nome do bairro.
`owners[].address.city`	`string`	Nome da cidade.
`owners[].address.state`	`string`	Sigla do estado.
`owners[].address.country`	`string`	Sigla do país.
`owners[].motherName`	`string`	Nome da mãe do sócio da empresa.
`owners[].email`	`string`	E-mail do sócio.
`owners[].declaredIncome`	`string`	Faixa de renda declarada pelo sócio.
`owners[].confirmedIncome`	`string`	Valor confirmado da renda pelo Bureau de informação.
`owners[].occupation`	`string`	Código de ocupação do sócio.
`owners[].pep`	`object`	Objeto que contém informações sobre o nível de exposição política do sócio.
`owners[].level`	`string`	Nível de exposição política ("NONE", "SELF", "RELATED").
`owners[].verified`	`boolean`	Indica se a situação de vínculo com PEP foi verificada.
`owners[].documentation`	`object`	Tokens de referência dos documentos do sócio enviados para análise.
`owners[].selfie`	`string`	Token da análise da selfie.
`owners[].idCardFront`	`string`	Token da análise da frente do documento.
`owners[].idCardBack`	`string`	Token da análise do verso do documento.
`legalRepresentatives[]`	`array of objects`	Lista de objetos contendo informações sobre os representantes legais da empresa.
`legalRepresentatives[].document[]`	`array of objects`	Lista de objetos contendo informações sobre o documento de cada representante legal.
`legalRepresentatives[].document[].value`	`string`	Número do documento.
`legalRepresentatives[].document[].type`	`string`	Tipo do documento, que pode ser "CPF" ou "CNPJ".
`legalRepresentatives[].registerName`	`string`	Nome do representante legal como consta no documento.
`legalRepresentatives[].socialName`	`string`	Nome social do representante legal.
`legalRepresentatives[].birthDate`	`string`	Data de nascimento do representante legal.
`legalRepresentatives[].phone`	`object`	Objeto que contém informações sobre o número de telefone do representante legal.
`legalRepresentatives[].phone.countryCode`	`string`	Código DDI do país.
`legalRepresentatives[].phone.number`	`string`	Número de telefone incluindo DDD.
`legalRepresentatives[].address`	`object`	Objeto que contém informações sobre o endereço comercial ou residencial do representante legal.
`legalRepresentatives[].address.zipcode`	`string`	Código postal do endereço.
`legalRepresentatives[].address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`legalRepresentatives[].address.buildingNumber`	`string`	Número do imóvel.
`legalRepresentatives[].address.complement`	`string`	Complemento do endereço.
`legalRepresentatives[].address.neighborhood`	`string`	Nome do bairro.
`legalRepresentatives[].address.city`	`string`	Nome da cidade.
`legalRepresentatives[].address.state`	`string`	Sigla do estado.
`legalRepresentatives[].address.country`	`string`	Sigla do país.
`legalRepresentatives[].motherName`	`string`	Nome da mãe do representante legal.
`legalRepresentatives[].email`	`string`	E-mail do representante legal.
`legalRepresentatives[].declaredIncome`	`string`	Faixa de renda declarada pelo representante legal.
`legalRepresentatives[].confirmedIncome`	`string`	Valor confirmado da renda pelo Bureau de informação.
`legalRepresentatives[].occupation`	`string`	Código de ocupação do representante legal.
`legalRepresentatives[].pep`	`object`	Objeto que contém informações sobre o nível de exposição política do representante legal.
`legalRepresentatives[].level`	`string`	Nível de exposição política ("NONE", "SELF", "RELATED").
`legalRepresentatives[].verified`	`boolean`	Indica se a situação de vínculo com PEP foi verificada.
`legalRepresentatives[].documentation`	`object`	Tokens de referência dos documentos enviados para análise.
`legalRepresentatives[].selfie`	`string`	Token da análise da selfie.
`legalRepresentatives[].idCardFront`	`string`	Token da análise da frente do documento.
`legalRepresentatives[].idCardBack`	`string`	Token da análise do verso do documento.
`status`	`string`	Situação do cadastro ("CANCELED").
`isBanklyPartner`	`boolean`	Indica se a empresa tem parceria com o Hiperbanco.
`createdAt`	`string`	Data de cadastro (ISO 8601 - UTC).
`updatedAt`	`string`	Data da última atualização do cadastro (ISO 8601 - UTC).

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": "HIPERBANCO_SANDBOX",
 "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"
 }
}