LTDA, S.A. e TS
stable
Os eventos referentes a cliente pessoa jurídica LTDA, S.A. e TS disparam mensagens que comunicam ao destinatário informações sobre o seu processo de cadastro e descadastro, como o recebimento da solicitação, a aprovação, reprovação e o cancelamento.
Pré-requisitos
Para receber esses eventos, o parceiro deverá:
- 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 da empresa. |
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 "LTDA", "SA" ou "TS". |
businessSize | string | Porte da empresa, que pode ser "SMALL" (pequeno), "MEDIUM" (médio) ou "LARGE" (grande). |
cnaeCode | string | Código CNAE (Classificação Nacional de Atividades Econômicas) da empresa. |
legalNature | string | Natureza Jurídica da empresa. |
openingDate | string | Data de abertura da empresa, no formato ISO 8601 - UTC. |
declaredAnnualBilling | string | Faixa de faturamento anual da empresa. |
phone | object | Objeto que contém informações sobre o número de telefone da empresa. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo o DDD. |
address | object | Objeto que contém informações sobre o endereço comercial da empresa. |
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. |
owners[] | array of objects | Lista de objetos contendo informações sobre os sócios da empresa, que podem ser do tipo pessoa física ou jurídica. |
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 conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do sócio (em caso de sócio pessoa física). |
owners[].socialName | string | Nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social (em caso de sócio pessoa física). |
owners[].birthDate | string | Data de nascimento, no formato ISO 8601 - UTC (em caso de sócio pessoa física). |
owners[].motherName | string | Nome da mãe do sócio como consta no documento (em caso de sócio pessoa física). |
owners[].pep | object | Objeto que contém informações sobre o nível de exposição política do cliente, atendendo a Circular nº 3.978 (em caso de sócio pessoa física). |
owners[].pep.level | string | Nível de exposição política do cliente, que pode ser "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente). |
owners[].pep.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[].occupation | string | Código de ocupação do cliente (em caso de sócio pessoa física). |
owners[].businessName | string | Razão social da empresa sócia (em caso de sócio pessoa jurídica). |
owners[].tradingName | string | Nome fantasia da empresa sócia, também conhecido como nome comercial (em caso de sócio pessoa jurídica). |
owners[].businessType | string | Tipo da empresa, que pode ser "LTDA", "S.A". ou "TS" (em caso de sócio pessoa jurídica). |
owners[].declaredIncome | string | Faixa de renda declarada pelo sócio (em caso de sócio pessoa física). |
owners[].declaredAnnualBilling | string | Faixa de faturamento anual da empresa (em caso de sócio pessoa jurídica). |
owners[].participationPercentage | string | Percentual de participação na empresa (0 a 100). |
owners[].email | string | Endereço de e-mail do sócio. |
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 o 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[].owners[] | array of objects | Lista de objetos contendo informações sobre os sócios da empresa. Essa lista será retornada caso o sócio descrito anteriormente seja pessoa jurídica. Ela conterá todos os campos descritos na lista de objetos owner[]. |
owners[]legalRepresentatives[] | array of objects | Lista de objetos contendo informações sobre os representantes legais da empresa (em caso de sócio pessoa jurídica). |
owners[]legalRepresentatives[].document | object | Objeto que contém informações sobre o documento do representante legal. |
owners[]legalRepresentatives[].document.value | string | Número do documento. |
owners[]legalRepresentatives[].document.type | string | Tipo do documento. Neste caso, "CPF". |
owners[]legalRepresentatives[].registerName | string | Nome do representante legal conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM). |
owners[]legalRepresentatives[].socialName | string | Nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social. |
owners[]legalRepresentatives[].birthDate | string | Data de nascimento do representante legal, no formato ISO 8601 - UTC. |
owners[]legalRepresentatives[].motherName | string | Nome da mãe do representante legal como consta no documento. |
owners[]legalRepresentatives[].pep | object | Objeto que contém informações sobre o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
owners[]legalRepresentatives[].pep.level | string | Nível de exposição política do sócio, que pode ser "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente). |
owners[]legalRepresentatives[].pep.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[]legalRepresentatives[].occupation | string | Código de ocupação do cliente (em caso de sócio pessoa física). |
owners[]legalRepresentatives[].declaredIncome | string | Faixa de renda declarada pelo representante legal. |
owners[]legalRepresentatives[].memberQualification | string | Qualificação da pessoa física, conforme a tabela do Anexo 5 da Instrução Normativa RFB nº 1863/2018. |
owners[]legalRepresentatives[].powerOfAttorney | object | Objeto que contém informações sobre as datas referentes à Procuração Pública Legal. |
owners[]legalRepresentatives[].powerOfAttorney.startDate | string | Data de início da Procuração, no formato ISO 8601 - UTC. |
owners[]legalRepresentatives[].powerOfAttorney.endDate | string | Data de fim da Procuração, no formato ISO 8601 - UTC. |
owners[]legalRepresentatives[].email | string | Endereço de e-mail do representante legal. |
owners[]legalRepresentatives[].phone | object | Objeto que contém informações sobre o número de telefone do representante legal. |
owners[]legalRepresentatives[].phone.countryCode | string | Código DDI do país. |
owners[]legalRepresentatives[].phone.number | string | Número de telefone incluindo DDD. |
owners[]legalRepresentatives[].address | object | Objeto que contém informações sobre o endereço do representante legal. |
owners[]legalRepresentatives[].address.zipCode | string | Código postal do endereço. |
owners[]legalRepresentatives[].address.addressLine | string | Logradouro (nome da rua, avenida etc.). |
owners[]legalRepresentatives[].address.buildingNumber | string | Número do imóvel. |
owners[]legalRepresentatives[].address.complement | string | Complemento do endereço. |
owners[]legalRepresentatives[].address.neighborhood | string | Nome do bairro. |
owners[]legalRepresentatives[].address.city | string | Nome da cidade. |
owners[]legalRepresentatives[].address.state | string | Sigla do estado. |
owners[]legalRepresentatives[].address.country | string | Sigla do país. |
legalRepresentatives[] | array of objects | Lista de objetos contendo informações sobre os representantes legais da empresa. Ela trará todos os campos contidos em owners[]legalRepresentatives |
status | string | Situação do cadastro. Neste caso, “PENDING_APPROVAL” (aprovação pendente). |
isBanklyPartner | boolean | Informa se a empresa tem parceria com o Bankly. |
createdAt | string | Data de cadastro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da última atualização do status de cadastro, no formato 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
{
"correlationId": "37613585-a0b1-4b74-8448-fc017b75b21b",
"entityId": "34183937000161",
"companyKey": "FLORESTA_ED",
"idempotencyKey": "4f7bf424-e86f-44b8-a420-7634a0f2fada",
"context": "Business",
"name": "BUSINESS_WAS_RECEIVED",
"timestamp": "2022-07-29T18:17:35.1555629Z",
"data": {
"document": {
"value": "34183937000161",
"type": "CNPJ"
},
"businessName": "Nísia Floresta Edições LTDA",
"tradingName": "Editora Nísia Floresta",
"businessType": "LTDA",
"businessSize": "MEDIUM",
"cnaeCode": "5811500",
"legalNature": "LTDA",
"openingDate": "2022-03-05",
"declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
},
"owners": [
{
"documentNumber": "53647974000128",
"document": {
"value": "53647974000128",
"type": "CNPJ"
},
"businessName": "Gráfica Floresta SA",
"tradingName": "Floresta Impressões",
"businessType": "SA",
"incomeDeclared": "",
"declaredAnnualBilling": "NOT_DECLARED",
"participationPercentage": "45",
"email": "grafica.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
},
"owners": [
{
"documentNumber": "47742663023",
"document": {
"value": "47742663023",
"type": "CPF"
},
"registerName": "Nísia Floresta",
"socialName": "",
"birthDate": "1810-10-12T00:00:00Z",
"motherName": "Dionísia Gonçalves Pinto",
"pep": {
"level": "NONE",
"verified": false
},
"occupation": "OCP0001",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"participationPercentage": "50",
"email": "nisia.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
}
}
],
"legalRepresentatives": [
{
"documentNumber": "47742663023",
"document": {
"value": "78982373748",
"type": "CPF"
},
"registerName": "Nísia Floresta",
"socialName": "",
"birthDate": "1810-10-12T00:00:00Z",
"motherName": "Dionísia Gonçalves Pinto",
"pep": {
"level": "NONE",
"verified": false
},
"occupation": "OCP0001",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"memberQualification": "432-1",
"powerOfAttorney": {
"startDate": "2022-11-28T00:00:00Z",
"endDate": "2023-03-16T00:00:00Z"
},
"email": "nisia.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
}
}
]
}
],
"legalRepresentatives": [
{
"documentNumber": "47742663023",
"document": {
"value": "78982373748",
"type": "CPF"
},
"registerName": "Nísia Floresta",
"socialName": "",
"birthDate": "1810-10-12T00:00:00Z",
"motherName": "Dionísia Gonçalves Pinto",
"pep": {
"level": "NONE",
"verified": false
},
"occupation": "OCP0001",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"memberQualification": "432-1",
"powerOfAttorney": {
"startDate": "2022-06-28T00:00:00Z",
"endDate": "2022-08-31T00:00:00Z"
},
"email": "nisia.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
}
}
],
"status": "PENDING_APPROVAL",
"isBanklyPartner": false,
"createdAt": "2022-07-29T18:17:35.121211Z",
"updatedAt": "2022-07-29T18:17:35.1212361Z"
}
}
Importante
É possível que o campo
owners
varie dependendo do tipo da empresa, podendo apresentar até três níveis referentes ao quadro societário. Para compreender melhor as variações na estrutura do campoowners
, consulte a documentação Onboarding pessoa jurídica LTDA, S.A., TS.
BUSINESS_WAS_APPROVED
Este evento sinaliza que o cadastro do cliente foi aprovado.
Descrição do objeto data
do evento
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 da empresa. |
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 "LTDA", "SA" ou "TS". |
businessSize | string | Porte da empresa, que pode ser "SMALL" (pequeno), "MEDIUM" (médio) ou "LARGE" (grande). |
cnaeCode | string | Código CNAE (Classificação Nacional de Atividades Econômicas) da empresa. |
legalNature | string | Natureza Jurídica da empresa. |
openingDate | string | Data de abertura da empresa, no formato ISO 8601 - UTC. |
declaredAnnualBilling | string | Faixa de faturamento anual da empresa. |
phone | object | Objeto que contém informações sobre o número de telefone da empresa. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo o DDD. |
address | object | Objeto que contém informações sobre o endereço comercial da empresa. |
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. |
owners[] | array of objects | Lista de objetos contendo informações sobre os sócios da empresa, que podem ser do tipo pessoa física ou jurídica. |
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 conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do sócio (em caso de sócio pessoa física). |
owners[].socialName | string | Nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social (em caso de sócio pessoa física). |
owners[].birthDate | string | Data de nascimento, no formato ISO 8601 - UTC (em caso de sócio pessoa física). |
owners[].motherName | string | Nome da mãe do sócio como consta no documento (em caso de sócio pessoa física). |
owners[].pep | object | Objeto que contém informações sobre o nível de exposição política do cliente, atendendo a Circular nº 3.978 (em caso de sócio pessoa física). |
owners[].pep.level | string | Nível de exposição política do cliente, que pode ser "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente). |
owners[].pep.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[].occupation | string | Código de ocupação do cliente (em caso de sócio pessoa física). |
owners[].businessName | string | Razão social da empresa sócia (em caso de sócio pessoa jurídica). |
owners[].tradingName | string | Nome fantasia da empresa sócia, também conhecido como nome comercial (em caso de sócio pessoa jurídica). |
owners[].businessType | string | Tipo da empresa, que pode ser "LTDA", "S.A". ou "TS" (em caso de sócio pessoa jurídica). |
owners[].declaredIncome | string | Faixa de renda declarada pelo sócio (em caso de sócio pessoa física). |
owners[].declaredAnnualBilling | string | Faixa de faturamento anual da empresa (em caso de sócio pessoa jurídica). |
owners[].participationPercentage | string | Percentual de participação na empresa (0 a 100). |
owners[].email | string | Endereço de e-mail do sócio. |
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 o 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[].owners[] | array of objects | Lista de objetos contendo informações sobre os sócios da empresa. Essa lista será retornada caso o sócio descrito anteriormente seja pessoa jurídica. Ela conterá todos os campos descritos na lista de objetos owner[]. |
owners[]legalRepresentatives[] | array of objects | Lista de objetos contendo informações sobre os representantes legais da empresa (em caso de sócio pessoa jurídica). |
owners[]legalRepresentatives[].document | object | Objeto que contém informações sobre o documento do representante legal. |
owners[]legalRepresentatives[].document.value | string | Número do documento. |
owners[]legalRepresentatives[].document.type | string | Tipo do documento. Neste caso, "CPF". |
owners[]legalRepresentatives[].registerName | string | Nome do representante legal conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM). |
owners[]legalRepresentatives[].socialName | string | Nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social. |
owners[]legalRepresentatives[].birthDate | string | Data de nascimento do representante legal, no formato ISO 8601 - UTC. |
owners[]legalRepresentatives[].motherName | string | Nome da mãe do representante legal como consta no documento. |
owners[]legalRepresentatives[].pep | object | Objeto que contém informações sobre o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
owners[]legalRepresentatives[].pep.level | string | Nível de exposição política do sócio, que pode ser "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente). |
owners[]legalRepresentatives[].pep.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[]legalRepresentatives[].occupation | string | Código de ocupação do cliente (em caso de sócio pessoa física). |
owners[]legalRepresentatives[].declaredIncome | string | Faixa de renda declarada pelo representante legal. |
owners[]legalRepresentatives[].memberQualification | string | Qualificação da pessoa física, conforme a tabela do Anexo 5 da Instrução Normativa RFB nº 1863/2018. |
owners[]legalRepresentatives[].powerOfAttorney | object | Objeto que contém informações sobre as datas referentes à Procuração Pública Legal. |
owners[]legalRepresentatives[].powerOfAttorney.startDate | string | Data de início da Procuração, no formato ISO 8601 - UTC. |
owners[]legalRepresentatives[].powerOfAttorney.endDate | string | Data de fim da Procuração, no formato ISO 8601 - UTC. |
owners[]legalRepresentatives[].email | string | Endereço de e-mail do representante legal. |
owners[]legalRepresentatives[].phone | object | Objeto que contém informações sobre o número de telefone do representante legal. |
owners[]legalRepresentatives[].phone.countryCode | string | Código DDI do país. |
owners[]legalRepresentatives[].phone.number | string | Número de telefone incluindo DDD. |
owners[]legalRepresentatives[].address | object | Objeto que contém informações sobre o endereço do representante legal. |
owners[]legalRepresentatives[].address.zipCode | string | Código postal do endereço. |
owners[]legalRepresentatives[].address.addressLine | string | Logradouro (nome da rua, avenida etc.). |
owners[]legalRepresentatives[].address.buildingNumber | string | Número do imóvel. |
owners[]legalRepresentatives[].address.complement | string | Complemento do endereço. |
owners[]legalRepresentatives[].address.neighborhood | string | Nome do bairro. |
owners[]legalRepresentatives[].address.city | string | Nome da cidade. |
owners[]legalRepresentatives[].address.state | string | Sigla do estado. |
owners[]legalRepresentatives[].address.country | string | Sigla do país. |
legalRepresentatives[] | array of objects | Lista de objetos contendo informações sobre os representantes legais da empresa. Ela trará todos os campos contidos em owners[]legalRepresentatives |
status | string | Situação do cadastro. Neste caso, “APPROVED” (aprovado). |
isBanklyPartner | boolean | Informa se a empresa tem parceria com o Bankly. |
createdAt | string | Data de cadastro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da última atualização do status de cadastro, no formato 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
{
"correlationId": "37613585-a0b1-4b74-8448-fc017b75b21b",
"entityId": "34183937000161",
"companyKey": "FLORESTA_ED",
"idempotencyKey": "4f7bf424-e86f-44b8-a420-7634a0f2fada",
"context": "Business",
"name": "BUSINESS_WAS_APPROVED",
"timestamp": "2022-07-29T18:17:35.1555629Z",
"data": {
"document": {
"value": "34183937000161",
"type": "CNPJ"
},
"businessName": "Nísia Floresta Edições LTDA",
"tradingName": "Editora Nísia Floresta",
"businessType": "LTDA",
"businessSize": "MEDIUM",
"cnaeCode": "5811500",
"legalNature": "LTDA",
"openingDate": "2022-03-05",
"declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
},
"owners": [
{
"documentNumber": "53647974000128",
"document": {
"value": "53647974000128",
"type": "CNPJ"
},
"businessName": "Gráfica Floresta SA",
"tradingName": "Floresta Impressões",
"businessType": "SA",
"incomeDeclared": "",
"declaredAnnualBilling": "NOT_DECLARED",
"participationPercentage": "45",
"email": "grafica.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
},
"owners": [
{
"documentNumber": "47742663023",
"document": {
"value": "47742663023",
"type": "CPF"
},
"registerName": "Nísia Floresta",
"socialName": "",
"birthDate": "1810-10-12T00:00:00Z",
"motherName": "Dionísia Gonçalves Pinto",
"pep": {
"level": "NONE",
"verified": false
},
"occupation": "OCP0001",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"participationPercentage": "50",
"email": "nisia.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
}
}
],
"legalRepresentatives": [
{
"documentNumber": "47742663023",
"document": {
"value": "78982373748",
"type": "CPF"
},
"registerName": "Nísia Floresta",
"socialName": "",
"birthDate": "1810-10-12T00:00:00Z",
"motherName": "Dionísia Gonçalves Pinto",
"pep": {
"level": "NONE",
"verified": false
},
"occupation": "OCP0001",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"memberQualification": "432-1",
"powerOfAttorney": {
"startDate": "2022-11-28T00:00:00Z",
"endDate": "2023-03-16T00:00:00Z"
},
"email": "nisia.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
}
}
]
}
],
"legalRepresentatives": [
{
"documentNumber": "47742663023",
"document": {
"value": "78982373748",
"type": "CPF"
},
"registerName": "Nísia Floresta",
"socialName": "",
"birthDate": "1810-10-12T00:00:00Z",
"motherName": "Dionísia Gonçalves Pinto",
"pep": {
"level": "NONE",
"verified": false
},
"occupation": "OCP0001",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"memberQualification": "432-1",
"powerOfAttorney": {
"startDate": "2022-06-28T00:00:00Z",
"endDate": "2022-08-31T00:00:00Z"
},
"email": "nisia.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
}
}
],
"status": "APPROVED",
"isBanklyPartner": false,
"createdAt": "2022-07-29T18:17:35.121211Z",
"updatedAt": "2022-07-29T18:17:35.1212361Z"
}
}
Importante
É possível que o campo
owners
varie dependendo do tipo da empresa, podendo apresentar até três níveis referentes ao quadro societário. Para compreender melhor as variações na estrutura do campoowners
, consulte a documentação Onboarding pessoa jurídica LTDA, S.A., TS.
BUSINESS_WAS_REPROVED
Este evento sinaliza que o cadastro do cliente foi reprovado.
Descrição do objeto data
do evento
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 da empresa. |
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 "LTDA", "SA" ou "TS". |
businessSize | string | Porte da empresa, que pode ser "SMALL" (pequeno), "MEDIUM" (médio) ou "LARGE" (grande). |
cnaeCode | string | Código CNAE (Classificação Nacional de Atividades Econômicas) da empresa. |
legalNature | string | Natureza Jurídica da empresa. |
openingDate | string | Data de abertura da empresa, no formato ISO 8601 - UTC. |
declaredAnnualBilling | string | Faixa de faturamento anual da empresa. |
phone | object | Objeto que contém informações sobre o número de telefone da empresa. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo o DDD. |
address | object | Objeto que contém informações sobre o endereço comercial da empresa. |
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. |
owners[] | array of objects | Lista de objetos contendo informações sobre os sócios da empresa, que podem ser do tipo pessoa física ou jurídica. |
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 conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do sócio (em caso de sócio pessoa física). |
owners[].socialName | string | Nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social (em caso de sócio pessoa física). |
owners[].birthDate | string | Data de nascimento, no formato ISO 8601 - UTC (em caso de sócio pessoa física). |
owners[].motherName | string | Nome da mãe do sócio como consta no documento (em caso de sócio pessoa física). |
owners[].pep | object | Objeto que contém informações sobre o nível de exposição política do cliente, atendendo a Circular nº 3.978 (em caso de sócio pessoa física). |
owners[].pep.level | string | Nível de exposição política do cliente, que pode ser "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente). |
owners[].pep.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[].occupation | string | Código de ocupação do cliente (em caso de sócio pessoa física). |
owners[].businessName | string | Razão social da empresa sócia (em caso de sócio pessoa jurídica). |
owners[].tradingName | string | Nome fantasia da empresa sócia, também conhecido como nome comercial (em caso de sócio pessoa jurídica). |
owners[].businessType | string | Tipo da empresa, que pode ser "LTDA", "S.A". ou "TS" (em caso de sócio pessoa jurídica). |
owners[].declaredIncome | string | Faixa de renda declarada pelo sócio (em caso de sócio pessoa física). |
owners[].declaredAnnualBilling | string | Faixa de faturamento anual da empresa (em caso de sócio pessoa jurídica). |
owners[].participationPercentage | string | Percentual de participação na empresa (0 a 100). |
owners[].email | string | Endereço de e-mail do sócio. |
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 o 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[].owners[] | array of objects | Lista de objetos contendo informações sobre os sócios da empresa. Essa lista será retornada caso o sócio descrito anteriormente seja pessoa jurídica. Ela conterá todos os campos descritos na lista de objetos owner[]. |
owners[]legalRepresentatives[] | array of objects | Lista de objetos contendo informações sobre os representantes legais da empresa (em caso de sócio pessoa jurídica). |
owners[]legalRepresentatives[].document | object | Objeto que contém informações sobre o documento do representante legal. |
owners[]legalRepresentatives[].document.value | string | Número do documento. |
owners[]legalRepresentatives[].document.type | string | Tipo do documento. Neste caso, "CPF". |
owners[]legalRepresentatives[].registerName | string | Nome do representante legal conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM). |
owners[]legalRepresentatives[].socialName | string | Nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social. |
owners[]legalRepresentatives[].birthDate | string | Data de nascimento do representante legal, no formato ISO 8601 - UTC. |
owners[]legalRepresentatives[].motherName | string | Nome da mãe do representante legal como consta no documento. |
owners[]legalRepresentatives[].pep | object | Objeto que contém informações sobre o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
owners[]legalRepresentatives[].pep.level | string | Nível de exposição política do sócio, que pode ser "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente). |
owners[]legalRepresentatives[].pep.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[]legalRepresentatives[].occupation | string | Código de ocupação do cliente (em caso de sócio pessoa física). |
owners[]legalRepresentatives[].declaredIncome | string | Faixa de renda declarada pelo representante legal. |
owners[]legalRepresentatives[].memberQualification | string | Qualificação da pessoa física, conforme a tabela do Anexo 5 da Instrução Normativa RFB nº 1863/2018. |
owners[]legalRepresentatives[].powerOfAttorney | object | Objeto que contém informações sobre as datas referentes à Procuração Pública Legal. |
owners[]legalRepresentatives[].powerOfAttorney.startDate | string | Data de início da Procuração, no formato ISO 8601 - UTC. |
owners[]legalRepresentatives[].powerOfAttorney.endDate | string | Data de fim da Procuração, no formato ISO 8601 - UTC. |
owners[]legalRepresentatives[].email | string | Endereço de e-mail do representante legal. |
owners[]legalRepresentatives[].phone | object | Objeto que contém informações sobre o número de telefone do representante legal. |
owners[]legalRepresentatives[].phone.countryCode | string | Código DDI do país. |
owners[]legalRepresentatives[].phone.number | string | Número de telefone incluindo DDD. |
owners[]legalRepresentatives[].address | object | Objeto que contém informações sobre o endereço do representante legal. |
owners[]legalRepresentatives[].address.zipCode | string | Código postal do endereço. |
owners[]legalRepresentatives[].address.addressLine | string | Logradouro (nome da rua, avenida etc.). |
owners[]legalRepresentatives[].address.buildingNumber | string | Número do imóvel. |
owners[]legalRepresentatives[].address.complement | string | Complemento do endereço. |
owners[]legalRepresentatives[].address.neighborhood | string | Nome do bairro. |
owners[]legalRepresentatives[].address.city | string | Nome da cidade. |
owners[]legalRepresentatives[].address.state | string | Sigla do estado. |
owners[]legalRepresentatives[].address.country | string | Sigla do país. |
legalRepresentatives[] | array of objects | Lista de objetos contendo informações sobre os representantes legais da empresa. Ela trará todos os campos contidos em owners[]legalRepresentatives |
status | string | Situação do cadastro. Neste caso, “REPROVED” (reprovado). |
reprovedReasons | string | Motivo pelo qual o cadastro foi reprovado. |
isBanklyPartner | boolean | Informa se a empresa tem parceria com o Bankly. |
createdAt | string | Data de cadastro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da última atualização do status de cadastro, no formato 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
{
"correlationId": "37613585-a0b1-4b74-8448-fc017b75b21b",
"entityId": "34183937000161",
"companyKey": "FLORESTA_ED",
"idempotencyKey": "4f7bf424-e86f-44b8-a420-7634a0f2fada",
"context": "Business",
"name": "BUSINESS_WAS_REPROVED",
"timestamp": "2022-07-29T18:17:35.1555629Z",
"data": {
"document": {
"value": "34183937000161",
"type": "CNPJ"
},
"businessName": "Nísia Floresta Edições LTDA",
"tradingName": "Editora Nísia Floresta",
"businessType": "LTDA",
"businessSize": "MEDIUM",
"cnaeCode": "5811500",
"legalNature": "LTDA",
"openingDate": "2022-03-05",
"declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
},
"owners": [
{
"documentNumber": "53647974000128",
"document": {
"value": "53647974000128",
"type": "CNPJ"
},
"businessName": "Gráfica Floresta SA",
"tradingName": "Floresta Impressões",
"businessType": "SA",
"incomeDeclared": "",
"declaredAnnualBilling": "NOT_DECLARED",
"participationPercentage": "45",
"email": "grafica.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
},
"owners": [
{
"documentNumber": "47742663023",
"document": {
"value": "47742663023",
"type": "CPF"
},
"registerName": "Nísia Floresta",
"socialName": "",
"birthDate": "1810-10-12T00:00:00Z",
"motherName": "Dionísia Gonçalves Pinto",
"pep": {
"level": "NONE",
"verified": false
},
"occupation": "OCP0001",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"participationPercentage": "50",
"email": "nisia.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
}
}
],
"legalRepresentatives": [
{
"documentNumber": "47742663023",
"document": {
"value": "78982373748",
"type": "CPF"
},
"registerName": "Nísia Floresta",
"socialName": "",
"birthDate": "1810-10-12T00:00:00Z",
"motherName": "Dionísia Gonçalves Pinto",
"pep": {
"level": "NONE",
"verified": false
},
"occupation": "OCP0001",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"memberQualification": "432-1",
"powerOfAttorney": {
"startDate": "2022-11-28T00:00:00Z",
"endDate": "2023-03-16T00:00:00Z"
},
"email": "nisia.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
}
}
]
}
],
"legalRepresentatives": [
{
"documentNumber": "47742663023",
"document": {
"value": "78982373748",
"type": "CPF"
},
"registerName": "Nísia Floresta",
"socialName": "",
"birthDate": "1810-10-12T00:00:00Z",
"motherName": "Dionísia Gonçalves Pinto",
"pep": {
"level": "NONE",
"verified": false
},
"occupation": "OCP0001",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"memberQualification": "432-1",
"powerOfAttorney": {
"startDate": "2022-06-28T00:00:00Z",
"endDate": "2022-08-31T00:00:00Z"
},
"email": "nisia.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
}
}
],
"status": "REPROVED",
"reprovedReasons": "DOCUMENT_RECUSED",
"isBanklyPartner": false,
"createdAt": "2022-07-29T18:17:35.121211Z",
"updatedAt": "2022-07-29T18:17:35.1212361Z"
}
}
Importante
É possível que o campo
owners
varie dependendo do tipo da empresa, podendo apresentar até três níveis referentes ao quadro societário. Para compreender melhor as variações na estrutura do campoowners
, consulte a documentação Onboarding pessoa jurídica LTDA, S.A., TS.
BUSINESS_WAS_CANCELED
Este evento sinaliza que o cadastro do cliente foi cancelado.
Descrição do objeto data
do evento
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 da empresa. |
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 "LTDA", "SA" ou "TS". |
businessSize | string | Porte da empresa, que pode ser "SMALL" (pequeno), "MEDIUM" (médio) ou "LARGE" (grande). |
cnaeCode | string | Código CNAE (Classificação Nacional de Atividades Econômicas) da empresa. |
legalNature | string | Natureza Jurídica da empresa. |
openingDate | string | Data de abertura da empresa, no formato ISO 8601 - UTC. |
declaredAnnualBilling | string | Faixa de faturamento anual da empresa. |
phone | object | Objeto que contém informações sobre o número de telefone da empresa. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo o DDD. |
address | object | Objeto que contém informações sobre o endereço comercial da empresa. |
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. |
owners[] | array of objects | Lista de objetos contendo informações sobre os sócios da empresa, que podem ser do tipo pessoa física ou jurídica. |
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 conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do sócio (em caso de sócio pessoa física). |
owners[].socialName | string | Nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social (em caso de sócio pessoa física). |
owners[].birthDate | string | Data de nascimento, no formato ISO 8601 - UTC (em caso de sócio pessoa física). |
owners[].motherName | string | Nome da mãe do sócio como consta no documento (em caso de sócio pessoa física). |
owners[].pep | object | Objeto que contém informações sobre o nível de exposição política do cliente, atendendo a Circular nº 3.978 (em caso de sócio pessoa física). |
owners[].pep.level | string | Nível de exposição política do cliente, que pode ser "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente). |
owners[].pep.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[].occupation | string | Código de ocupação do cliente (em caso de sócio pessoa física). |
owners[].businessName | string | Razão social da empresa sócia (em caso de sócio pessoa jurídica). |
owners[].tradingName | string | Nome fantasia da empresa sócia, também conhecido como nome comercial (em caso de sócio pessoa jurídica). |
owners[].businessType | string | Tipo da empresa, que pode ser "LTDA", "S.A". ou "TS" (em caso de sócio pessoa jurídica). |
owners[].declaredIncome | string | Faixa de renda declarada pelo sócio (em caso de sócio pessoa física). |
owners[].declaredAnnualBilling | string | Faixa de faturamento anual da empresa (em caso de sócio pessoa jurídica). |
owners[].participationPercentage | string | Percentual de participação na empresa (0 a 100). |
owners[].email | string | Endereço de e-mail do sócio. |
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 o 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[].owners[] | array of objects | Lista de objetos contendo informações sobre os sócios da empresa. Essa lista será retornada caso o sócio descrito anteriormente seja pessoa jurídica. Ela conterá todos os campos descritos na lista de objetos owner[]. |
owners[]legalRepresentatives[] | array of objects | Lista de objetos contendo informações sobre os representantes legais da empresa (em caso de sócio pessoa jurídica). |
owners[]legalRepresentatives[].document | object | Objeto que contém informações sobre o documento do representante legal. |
owners[]legalRepresentatives[].document.value | string | Número do documento. |
owners[]legalRepresentatives[].document.type | string | Tipo do documento. Neste caso, "CPF". |
owners[]legalRepresentatives[].registerName | string | Nome do representante legal conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM). |
owners[]legalRepresentatives[].socialName | string | Nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do Nome Social. |
owners[]legalRepresentatives[].birthDate | string | Data de nascimento do representante legal, no formato ISO 8601 - UTC. |
owners[]legalRepresentatives[].motherName | string | Nome da mãe do representante legal como consta no documento. |
owners[]legalRepresentatives[].pep | object | Objeto que contém informações sobre o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
owners[]legalRepresentatives[].pep.level | string | Nível de exposição política do sócio, que pode ser "NONE" (o cliente não é e nem apresenta relação com uma pessoa exposta politicamente), "SELF"(o cliente é uma pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de uma pessoa exposta politicamente). |
owners[]legalRepresentatives[].pep.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[]legalRepresentatives[].occupation | string | Código de ocupação do cliente (em caso de sócio pessoa física). |
owners[]legalRepresentatives[].declaredIncome | string | Faixa de renda declarada pelo representante legal. |
owners[]legalRepresentatives[].memberQualification | string | Qualificação da pessoa física, conforme a tabela do Anexo 5 da Instrução Normativa RFB nº 1863/2018. |
owners[]legalRepresentatives[].powerOfAttorney | object | Objeto que contém informações sobre as datas referentes à Procuração Pública Legal. |
owners[]legalRepresentatives[].powerOfAttorney.startDate | string | Data de início da Procuração, no formato ISO 8601 - UTC. |
owners[]legalRepresentatives[].powerOfAttorney.endDate | string | Data de fim da Procuração, no formato ISO 8601 - UTC. |
owners[]legalRepresentatives[].email | string | Endereço de e-mail do representante legal. |
owners[]legalRepresentatives[].phone | object | Objeto que contém informações sobre o número de telefone do representante legal. |
owners[]legalRepresentatives[].phone.countryCode | string | Código DDI do país. |
owners[]legalRepresentatives[].phone.number | string | Número de telefone incluindo DDD. |
owners[]legalRepresentatives[].address | object | Objeto que contém informações sobre o endereço do representante legal. |
owners[]legalRepresentatives[].address.zipCode | string | Código postal do endereço. |
owners[]legalRepresentatives[].address.addressLine | string | Logradouro (nome da rua, avenida etc.). |
owners[]legalRepresentatives[].address.buildingNumber | string | Número do imóvel. |
owners[]legalRepresentatives[].address.complement | string | Complemento do endereço. |
owners[]legalRepresentatives[].address.neighborhood | string | Nome do bairro. |
owners[]legalRepresentatives[].address.city | string | Nome da cidade. |
owners[]legalRepresentatives[].address.state | string | Sigla do estado. |
owners[]legalRepresentatives[].address.country | string | Sigla do país. |
legalRepresentatives[] | array of objects | Lista de objetos contendo informações sobre os representantes legais da empresa. Ela trará todos os campos contidos em owners[]legalRepresentatives |
status | string | Situação do cadastro. Neste caso, “CANCELED” (cancelado). |
isBanklyPartner | boolean | Informa se a empresa tem parceria com o Bankly. |
createdAt | string | Data de cadastro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da última atualização do status de cadastro, no formato 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
{
"correlationId": "37613585-a0b1-4b74-8448-fc017b75b21b",
"entityId": "34183937000161",
"companyKey": "FLORESTA_ED",
"idempotencyKey": "4f7bf424-e86f-44b8-a420-7634a0f2fada",
"context": "Business",
"name": "BUSINESS_WAS_CANCELED",
"timestamp": "2022-07-29T18:17:35.1555629Z",
"data": {
"document": {
"value": "34183937000161",
"type": "CNPJ"
},
"businessName": "Nísia Floresta Edições LTDA",
"tradingName": "Editora Nísia Floresta",
"businessType": "LTDA",
"businessSize": "MEDIUM",
"cnaeCode": "5811500",
"legalNature": "LTDA",
"openingDate": "2022-03-05",
"declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
},
"owners": [
{
"documentNumber": "53647974000128",
"document": {
"value": "53647974000128",
"type": "CNPJ"
},
"businessName": "Gráfica Floresta SA",
"tradingName": "Floresta Impressões",
"businessType": "SA",
"incomeDeclared": "",
"declaredAnnualBilling": "NOT_DECLARED",
"participationPercentage": "45",
"email": "grafica.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
},
"owners": [
{
"documentNumber": "47742663023",
"document": {
"value": "47742663023",
"type": "CPF"
},
"registerName": "Nísia Floresta",
"socialName": "",
"birthDate": "1810-10-12T00:00:00Z",
"motherName": "Dionísia Gonçalves Pinto",
"pep": {
"level": "NONE",
"verified": false
},
"occupation": "OCP0001",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"participationPercentage": "50",
"email": "nisia.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
}
}
],
"legalRepresentatives": [
{
"documentNumber": "47742663023",
"document": {
"value": "78982373748",
"type": "CPF"
},
"registerName": "Nísia Floresta",
"socialName": "",
"birthDate": "1810-10-12T00:00:00Z",
"motherName": "Dionísia Gonçalves Pinto",
"pep": {
"level": "NONE",
"verified": false
},
"occupation": "OCP0001",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"memberQualification": "432-1",
"powerOfAttorney": {
"startDate": "2022-11-28T00:00:00Z",
"endDate": "2023-03-16T00:00:00Z"
},
"email": "nisia.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
}
}
]
}
],
"legalRepresentatives": [
{
"documentNumber": "47742663023",
"document": {
"value": "78982373748",
"type": "CPF"
},
"registerName": "Nísia Floresta",
"socialName": "",
"birthDate": "1810-10-12T00:00:00Z",
"motherName": "Dionísia Gonçalves Pinto",
"pep": {
"level": "NONE",
"verified": false
},
"occupation": "OCP0001",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"memberQualification": "432-1",
"powerOfAttorney": {
"startDate": "2022-06-28T00:00:00Z",
"endDate": "2022-08-31T00:00:00Z"
},
"email": "nisia.floresta@bankly.com.br",
"phone": {
"countryCode": "55",
"number": "23415162342"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"complement": "",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
}
}
],
"status": "CANCELED",
"isBanklyPartner": false,
"createdAt": "2022-07-29T18:17:35.121211Z",
"updatedAt": "2022-07-29T18:17:35.1212361Z"
}
}
Importante
É possível que o campo
owners
varie dependendo do tipo da empresa, podendo apresentar até três níveis referentes ao quadro societário. Para compreender melhor as variações na estrutura do campoowners
, consulte a documentação Onboarding pessoa jurídica LTDA, S.A., TS.
Faixa de faturamento anual da empresa
Faturamento | Descrição |
---|---|
UP_TO_FIFTY_THOUSAND | Até 50 mil. |
MORE_THAN_FIFTY_THOUSAND_UP_TO_ONE_HUNDRED_THOUSAND | De 50 mil a 100 mil. |
MORE_THAN_ONE_HUNDRED_THOUSAND_UP_TO_TWO_HUNDRED_AND_FIFTY_THOUSAND | De 100 mil a 250 mil. |
MORE_THAN_TWO_HUNDRED_AND_FIFTY_THOUSAND_UP_TO_FIVE_HUNDRED_THOUSAND | De 250 mil a 500 mil. |
MORE_THAN_FIVE_HUNDRED_THOUSAND_UP_TO_ONE_MILLION | De 500 mil a 1 milhão. |
MORE_THAN_ONE_MILLION_UP_TO_TWO_MILLION_AND_FIVE_HUNDRED_THOUSAND | De 1 milhão a 2 milhões e 500 mil. |
MORE_THAN_TWO_MILLION_AND_FIVE_HUNDRED_THOUSAND_UP_TO_FIVE_MILLION | De 2 milhões e 500 mil a 5 milhões. |
MORE_THAN_FIVE_MILLION_UP_TO_TEN_MILLION | De 5 milhões a 10 milhões. |
MORE_THAN_TEN_MILLION_UP_TO_TWENTY_FIVE_MILLION | De 10 milhões a 25 milhões. |
MORE_THAN_TWENTY_FIVE_MILLION_UP_TO_FIFTY_MILLION | De 25 milhões a 50 milhões. |
MORE_THAN_FIFTY_MILLION_UP_TO_ONE_HUNDRED_MILLION | De 50 milhões a 100 milhões. |
MORE_THAN_ONE_HUNDRED_MILLION_UP_TO_TWO_HUNDRED_AND_FIFTY_MILLION | De 100 milhões a 250 milhões. |
MORE_THAN_TWO_HUNDRED_AND_FIFTY_MILLION_UP_TO_FIVE_HUNDRED_MILLION | De 250 milhões a 500 milhões. |
MORE_THAN_FIVE_HUNDRED_MILLION | Mais de 500 milhões. |
NOT_DECLARED | Não declarada. |
EXEMPT_COMPANY | Empresa isenta. |
INACTIVE_COMPANY | Empresa inativa. |
Faixa de renda declarada
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 4 days ago