MEI, EI, EIRELI ou SLU
stable
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
)
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
data
do eventoO 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, o qual pode ser: MEI, EI, EIRELI ou SLU. |
businessSize | string | Porte 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). |
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 | Nome do estado. |
address.country | string | Nome 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 que contém 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, o qual 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. Saiba mais consultando a Cartilha do nome social. |
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 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 | Nome do estado. |
owners[].address.country | string | Nome do país. |
owners[].motherName | string | Nome da mãe do sócio da empresa como consta no documento de identidade. |
owners[].email | string | E-mail do sócio da empresa. |
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. O valor padrão desse campo é "null". |
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, atendendo a Circular nº 3.978. |
owners[].level | string | Ní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[].verified | boolean | Indica 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[].documentation | object | Objeto que contém os tokens de referência dos documentos do sócio que foram 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 dos representantes legais da empresa e suas informações. |
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, o qual pode ser "CPF" OU "CNPJ". |
legalRepresentatives[].registerName | string | Nome do representante legal da empresa como consta no documento. |
legalRepresentatives[].socialName | string | Nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social. |
legalRepresentatives[].birthDate | string | Data de nascimento do representante legal da empresa. |
legalRepresentatives[].phone | object | Objeto que contém informações sobre o número de telefone do representante legal da empresa. |
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. |
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 | Nome do estado. |
legalRepresentatives[].address.country | string | Nome do país. |
legalRepresentatives[].motherName | string | Nome da mãe do representante legal da empresa como consta no documento de identidade. |
legalRepresentatives[].email | string | E-mail do representante legal da empresa. |
legalRepresentatives[].declaredIncome | string | Faixa de renda declarada pelo representante legal. |
legalRepresentatives[].confirmedIncome | string | Indica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é "null. |
legalRepresentatives[].occupation | string | Código de ocupação do representante legal. |
legalRepresentatives[].pep | object | Objeto que contém o nível de exposição política do representante legal, atendendo a Circular nº 3.978. |
legalRepresentatives[].level | string | Ní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[].verified | boolean | Indica 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[].documentation | object | Objeto que contém os tokens de referência dos documentos do representante legal que foram 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, a qual neste caso será " PENDING_APPROVAL". |
isBanklyPartner | boolean | Informa se a empresa tem parceria com o Bankly. |
createdAt | string | Data de cadastro do cliente. |
updatedAt | string | Data 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
data
do eventoO 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, o qual pode ser: MEI, EI, EIRELI ou SLU. |
businessSize | string | Porte 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). |
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 | Nome do estado. |
address.country | string | Nome 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 que contém 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, o qual 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. Saiba mais consultando a Cartilha do nome social. |
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 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 | Nome do estado. |
owners[].address.country | string | Nome do país. |
owners[].motherName | string | Nome da mãe do sócio da empresa como consta no documento de identidade. |
owners[].email | string | E-mail do sócio da empresa. |
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. O valor padrão desse campo é "null". |
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, atendendo a Circular nº 3.978. |
owners[].level | string | Ní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[].verified | boolean | Indica 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[].documentation | object | Objeto que contém os tokens de referência dos documentos do sócio que foram 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 dos representantes legais da empresa e suas informações. |
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, o qual pode ser "CPF" OU "CNPJ". |
legalRepresentatives[].registerName | string | Nome do representante legal da empresa como consta no documento. |
legalRepresentatives[].socialName | string | Nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social. |
legalRepresentatives[].birthDate | string | Data de nascimento do representante legal da empresa. |
legalRepresentatives[].phone | object | Objeto que contém informações sobre o número de telefone do representante legal da empresa. |
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. |
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 | Nome do estado. |
legalRepresentatives[].address.country | string | Nome do país. |
legalRepresentatives[].motherName | string | Nome da mãe do representante legal da empresa como consta no documento de identidade. |
legalRepresentatives[].email | string | E-mail do representante legal da empresa. |
legalRepresentatives[].declaredIncome | string | Faixa de renda declarada pelo representante legal. |
legalRepresentatives[].confirmedIncome | string | Indica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é "null. |
legalRepresentatives[].occupation | string | Código de ocupação do representante legal. |
legalRepresentatives[].pep | object | Objeto que contém o nível de exposição política do representante legal, atendendo a Circular nº 3.978. |
legalRepresentatives[].level | string | Ní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[].verified | boolean | Indica 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[].documentation | object | Objeto que contém os tokens de referência dos documentos do representante legal que foram 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, a qual neste caso será " APPROVED". |
isBanklyPartner | boolean | Informa se a empresa tem parceria com o Bankly. |
createdAt | string | Data de cadastro do cliente. |
updatedAt | string | Data 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
data
do eventoO 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, o qual pode ser: MEI, EI, EIRELI ou SLU. |
businessSize | string | Porte 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). |
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 | Nome do estado. |
address.country | string | Nome 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 que contém 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, o qual 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. Saiba mais consultando a Cartilha do nome social. |
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 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 | Nome do estado. |
owners[].address.country | string | Nome do país. |
owners[].motherName | string | Nome da mãe do sócio da empresa como consta no documento de identidade. |
owners[].email | string | E-mail do sócio da empresa. |
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. O valor padrão desse campo é "null". |
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, atendendo a Circular nº 3.978. |
owners[].level | string | Ní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[].verified | boolean | Indica 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[].documentation | object | Objeto que contém os tokens de referência dos documentos do sócio que foram 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 dos representantes legais da empresa e suas informações. |
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, o qual pode ser "CPF" OU "CNPJ". |
legalRepresentatives[].registerName | string | Nome do representante legal da empresa como consta no documento. |
legalRepresentatives[].socialName | string | Nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social. |
legalRepresentatives[].birthDate | string | Data de nascimento do representante legal da empresa. |
legalRepresentatives[].phone | object | Objeto que contém informações sobre o número de telefone do representante legal da empresa. |
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. |
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 | Nome do estado. |
legalRepresentatives[].address.country | string | Nome do país. |
legalRepresentatives[].motherName | string | Nome da mãe do representante legal da empresa como consta no documento de identidade. |
legalRepresentatives[].email | string | E-mail do representante legal da empresa. |
legalRepresentatives[].declaredIncome | string | Faixa de renda declarada pelo representante legal. |
legalRepresentatives[].confirmedIncome | string | Indica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é "null. |
legalRepresentatives[].occupation | string | Código de ocupação do representante legal. |
legalRepresentatives[].pep | object | Objeto que contém o nível de exposição política do representante legal, atendendo a Circular nº 3.978. |
legalRepresentatives[].level | string | Ní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[].verified | boolean | Indica 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[].documentation | object | Objeto que contém os tokens de referência dos documentos do representante legal que foram 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, a qual neste caso será " REPROVED". |
isBanklyPartner | boolean | Informa se a empresa tem parceria com o Bankly. |
createdAt | string | Data de cadastro do cliente. |
updatedAt | string | Data da última atualização do status de cadastro. |
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": "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
data
do eventoO 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, o qual pode ser: MEI, EI, EIRELI ou SLU. |
businessSize | string | Porte 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). |
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 | Nome do estado. |
address.country | string | Nome 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 que contém 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, o qual 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. Saiba mais consultando a Cartilha do nome social. |
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 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 | Nome do estado. |
owners[].address.country | string | Nome do país. |
owners[].motherName | string | Nome da mãe do sócio da empresa como consta no documento de identidade. |
owners[].email | string | E-mail do sócio da empresa. |
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. O valor padrão desse campo é "null". |
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, atendendo a Circular nº 3.978. |
owners[].level | string | Ní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[].verified | boolean | Indica 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[].documentation | object | Objeto que contém os tokens de referência dos documentos do sócio que foram 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 dos representantes legais da empresa e suas informações. |
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, o qual pode ser "CPF" OU "CNPJ". |
legalRepresentatives[].registerName | string | Nome do representante legal da empresa como consta no documento. |
legalRepresentatives[].socialName | string | Nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social. |
legalRepresentatives[].birthDate | string | Data de nascimento do representante legal da empresa. |
legalRepresentatives[].phone | object | Objeto que contém informações sobre o número de telefone do representante legal da empresa. |
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. |
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 | Nome do estado. |
legalRepresentatives[].address.country | string | Nome do país. |
legalRepresentatives[].motherName | string | Nome da mãe do representante legal da empresa como consta no documento de identidade. |
legalRepresentatives[].email | string | E-mail do representante legal da empresa. |
legalRepresentatives[].declaredIncome | string | Faixa de renda declarada pelo representante legal. |
legalRepresentatives[].confirmedIncome | string | Indica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é "null. |
legalRepresentatives[].occupation | string | Código de ocupação do representante legal. |
legalRepresentatives[].pep | object | Objeto que contém o nível de exposição política do representante legal, atendendo a Circular nº 3.978. |
legalRepresentatives[].level | string | Ní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[].verified | boolean | Indica 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[].documentation | object | Objeto que contém os tokens de referência dos documentos do representante legal que foram 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, a qual neste caso será " CANCELED". |
isBanklyPartner | boolean | Informa se a empresa tem parceria com o Bankly. |
createdAt | string | Data de cadastro do cliente. |
updatedAt | string | Data 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"
}
}
Faturamento | Descrição |
---|---|
LESS_THAN_ONE_THOUSAND | Inferior a mil. |
FROM_ONE_THOUSAND_TO_TWO_THOUSAND | De mil a dois mil. |
FROM_TWO_THOUSAND_TO_THREE_THOUSAND | De 2 mil a 3 mil. |
FROM_THREE_THOUSAND_TO_FIVE_THOUSAND | De 3 mil a 5 mil. |
FROM_FIVE_THOUSAND_TO_TEN_THOUSAND | De 5 mil a 10 mil. |
FROM_TEN_THOUSAND_TO_TWENTY_THOUSAND | De 10 mil a 20 mil. |
OVER_TWENTY_THOUSAND | Acima de 20 mil. |
Updated 6 months ago