Onboarding de LTDA, S.A. e TS
Confira os eventos relativos a Onboarding de pessoa jurídica LTDA, S.A, TS.
beta
Os eventos de Onboarding de pessoa jurídica LTDA, S.A., TS disparam mensagens que comunicam ao destinatário informações sobre o processo de cadastro do cliente pessoa jurídica LTDA, S.A., TS.
Como esses eventos chegam ao recebedor via webhook, é preciso realizar previamente a sua configuração.
Contexto e nome do evento
Nos eventos de Onboarding de pessoa jurídica LTDA, S.A., TS, o campo context sempre informará “Business”, enquanto o campo name poderá variar de acordo com a transação, conforme a tabela a seguir:
| Nome do evento (name) | Descrição |
|---|---|
| BUSINESS _WAS_RECEIVED | A solicitação de cadastro do cliente foi recebida. |
| BUSINESS_WAS_APPROVED | O cadastro do cliente foi aprovado. |
| BUSINESS_WAS_REPROVED | O cadastro do cliente foi reprovado. |
| BUSINESS_WAS_CANCELED | O cadastro do cliente foi cancelado. |
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.
Exemplos de eventos
{
"correlationId": "string",
"entityId": "string",
"companyKey": "string",
"idempotencyKey": "string",
"context": "Business",
"name": "BUSINESS_WAS_RECEIVED",
"timestamp": "2022-07-29T18:17:35.1555629Z",
"data": {
"document": {
"value": "00000000000000",
"type": "CNPJ"
},
"businessName": "Schmitt Gaylord",
"tradingName": "Skiles Conroy and Walter",
"businessSize": "SMALL",
"businessType": "LTDA",
"cnaeCode": "99-1",
"legalNature": "123-4",
"annualBilling": 1000.47,
"openingDate": "2022-01-23T00:00:00Z",
"phone": {
"countryCode": "55",
"number": "98848052516"
},
"address": {
"zipCode": "04205000",
"addressLine": "Rua Cipriano Barata",
"buildingNumber": "790",
"complement": "Casa 2",
"neighborhood": "Ipiranga",
"city": "São Paulo",
"state": "SP",
"country": "BR"
},
"owners": [
{
"documentNumber": "14886643000199",
"email": "[email protected]",
"phone": {
"countryCode": "55",
"number": "98848052516"
},
"address": {
"zipCode": "02035000",
"addressLine": "Rua Major Sampaio",
"buildingNumber": "79",
"complement": "Casa 2",
"neighborhood": "Santana",
"city": "São Paulo",
"state": "SP",
"country": "BR"
},
"incomeDeclared": 1000,
"participationPercentage": "50",
"tradingName": "Schmitt Gaylord",
"businessName": "Schmitt Gaylord",
"businessType": "LTDA",
"owners": [
{
"documentNumber": "14886643000199",
"email": "[email protected]",
"phone": {
"countryCode": "55",
"number": "98848052516"
},
"address": {
"zipCode": "02035000",
"addressLine": "Rua Major Sampaio",
"buildingNumber": "79",
"complement": "Casa 2",
"neighborhood": "Santana",
"city": "São Paulo",
"state": "SP",
"country": "BR"
},
"incomeDeclared": 1000,
"participationPercentage": "50",
"tradingName": "Schmitt Gaylord",
"businessName": "Schmitt Gaylord",
"businessType": "LTDA",
"owners": [
{
"documentNumber": "68710720634",
"email": "[email protected]",
"phone": {
"countryCode": "55",
"number": "98848052516"
},
"address": {
"zipCode": "02035000",
"addressLine": "Rua Major Sampaio",
"buildingNumber": "79",
"complement": "Casa 2",
"neighborhood": "Santana",
"city": "São Paulo",
"state": "SP",
"country": "BR"
},
"incomeDeclared": 1000,
"participationPercentage": "50",
"registerName": "Vivian Nienow",
"socialName": "Elbert",
"birthDate": "1984-07-23T00:00:00Z",
"motherName": "Johnnie Crona",
"isPoliticallyExposedPerson": true
}
],
"legalRepresentatives": [
{
"socialName": "Elbert",
"birthDate": "1988-05-06T00:00:00Z",
"motherName": "Johnnie Crona",
"email": "[email protected]",
"isPoliticallyExposedPerson": false,
"documentNumber": "68710720634",
"registerName": "Vivian Nienow",
"phone": {
"countryCode": "55",
"number": "98848052516"
},
"address": {
"zipCode": "04205000",
"addressLine": "Rua Cipriano Barata",
"buildingNumber": "790",
"complement": "Test",
"neighborhood": "Ipiranga",
"city": "São Paulo",
"state": "SP",
"country": "BR"
}
}
]
}
],
"legalRepresentatives": [
{
"socialName": "Elbert",
"birthDate": "1988-05-06T00:00:00Z",
"motherName": "Johnnie Crona",
"email": "[email protected]",
"isPoliticallyExposedPerson": false,
"documentNumber": "68710720634",
"registerName": "Vivian Nienow",
"phone": {
"countryCode": "55",
"number": "98848052516"
},
"address": {
"zipCode": "04205000",
"addressLine": "Rua Cipriano Barata",
"buildingNumber": "790",
"complement": "Test",
"neighborhood": "Ipiranga",
"city": "São Paulo",
"state": "SP",
"country": "BR"
}
}
]
}
],
"legalRepresentatives": [
{
"memberQualification": "432-1",
"powerOfAttorney": {
"startDate": "2022-06-28T00:00:00Z",
"endDate": "2022-08-31T00:00:00Z"
},
"socialName": "Elbert",
"birthDate": "1988-05-06T00:00:00Z",
"motherName": "Johnnie Crona",
"email": "[email protected]",
"isPoliticallyExposedPerson": false,
"documentNumber": "68710720634",
"registerName": "Vivian Nienow",
"phone": {
"countryCode": "55",
"number": "98848052516"
},
"address": {
"zipCode": "04205000",
"addressLine": "Rua Cipriano Barata",
"buildingNumber": "790",
"complement": "Test",
"neighborhood": "Ipiranga",
"city": "São Paulo",
"state": "SP",
"country": "BR"
}
}
],
"status": "PENDING_APPROVAL",
"isBanklyPartner": false,
"createdAt": "2022-07-29T18:17:35.121211Z",
"updatedAt": "2022-07-29T18:17:35.1212361Z"
}
}
{
"entityId": "SQUAD_LUFFY#62686956000146",
"companyKey": "SQUAD_LUFFY",
"idempotencyKey": "4f7bf424-e86f-44b8-a420-7634a0f2fada",
"context": "Business",
"name": "BUSINESS_WAS_APPROVED",
"timestamp": "2022-07-27T14:04:25.5116057Z",
"correlationId": "37613585-a0b1-4b74-8448-fc017b75b21b",
"data": {
"document": {
"value": "00000000000000",
"type": "CNPJ"
},
"businessName": "Lowe Rath",
"tradingName": "Greenholt Group",
"businessSize": "SMALL",
"businessType": "TS",
"cnaeCode": "99-1",
"legalNature": "123-4",
"annualBilling": 1000,
"openingDate": "2022-06-23T00:00:00+00:00",
"phone": {
"countryCode": "55",
"number": "99704748534"
},
"address": {
"zipCode": "04205000",
"addressLine": "Rua Cipriano Barata",
"buildingNumber": "790",
"neighborhood": "Ipiranga",
"city": "São Paulo",
"state": "SP",
"country": "BR"
},
"owners": [
{
"documentNumber": "62686956000146",
"email": "[email protected]",
"phone": {
"countryCode": "55",
"number": "99704748534"
},
"address": {
"zipCode": "02035000",
"addressLine": "Rua Major Sampaio",
"buildingNumber": "79",
"neighborhood": "Santana",
"city": "São Paulo",
"state": "SP",
"country": "BR"
},
"incomeDeclared": 1000,
"participationPercentage": "50",
"tradingName": "Lowe Rath",
"businessName": "Lowe Rath",
"businessType": "TS",
"owners": [],
"legalRepresentatives": [
{
"socialName": "Loma",
"birthDate": "1988-05-06T00:00:00+00:00",
"motherName": "Mr Alexis Smitham",
"email": "[email protected]",
"isPoliticallyExposedPerson": false,
"documentNumber": "58380788559",
"registerName": "Shawna Willms",
"phone": {
"countryCode": "55",
"number": "99704748534"
},
"address": {
"zipCode": "04205000",
"addressLine": "Rua Cipriano Barata",
"buildingNumber": "790",
"complement": "Test",
"neighborhood": "Ipiranga",
"city": "São Paulo",
"state": "SP",
"country": "BR"
}
}
]
}
],
"legalRepresentatives": [
{
"memberQualification": "432-1",
"powerOfAttorney": {
"startDate": "2022-06-28T00:00:00+00:00",
"endDate": "2022-08-31T00:00:00+00:00"
},
"socialName": "Tyson",
"birthDate": "1988-05-06T00:00:00+00:00",
"motherName": "Mr Alexis Smitham",
"email": "[email protected]",
"isPoliticallyExposedPerson": false,
"documentNumber": "58380788559",
"registerName": "Shawna Willms",
"phone": {
"countryCode": "55",
"number": "99704748534"
},
"address": {
"zipCode": "04205000",
"addressLine": "Rua Cipriano Barata",
"buildingNumber": "790",
"complement": "Test",
"neighborhood": "Ipiranga",
"city": "São Paulo",
"state": "SP",
"country": "BR"
}
}
],
"status": "APPROVED",
"isBanklyPartner": false,
"createdAt": "2022-07-27T13:59:20.254+00:00",
"updatedAt": "2022-07-27T14:04:25.4516916Z"
}
}
{
"entityId": "string",
"companyKey": "string",
"idempotencyKey": "string",
"context": "Business",
"name": "BUSINESS_WAS_REPROVED",
"timestamp": "2022-07-27T14:02:18.2498168Z",
"correlationId": "string",
"data": {
"document": {
"value": "00000000000000",
"type": "CNPJ"
},
"businessName": "Blanda Hudson",
"tradingName": "Nitzsche McLaughlin",
"businessSize": "SMALL",
"businessType": "TS",
"cnaeCode": "99-1",
"legalNature": "123-4",
"annualBilling": 1000,
"openingDate": "2022-06-23T00:00:00+00:00",
"phone": {
"countryCode": "55",
"number": "94658864572"
},
"address": {
"zipCode": "04205000",
"addressLine": "Rua Cipriano Barata",
"buildingNumber": "790",
"neighborhood": "Ipiranga",
"city": "São Paulo",
"state": "SP",
"country": "BR"
},
"owners": [
{
"documentNumber": "74165966000115",
"email": "[email protected]",
"phone": {
"countryCode": "55",
"number": "15765184651"
},
"address": {
"zipCode": "02035000",
"addressLine": "Rua Major Sampaio",
"buildingNumber": "79",
"neighborhood": "Santana",
"city": "São Paulo",
"state": "SP",
"country": "BR"
},
"incomeDeclared": 1000,
"participationPercentage": "50",
"tradingName": "Blanda Hudson",
"businessName": "Blanda Hudson",
"businessType": "TS",
"owners": [],
"legalRepresentatives": [
{
"socialName": "Willard",
"birthDate": "1988-05-06T00:00:00+00:00",
"motherName": "Guy Cummings",
"email": "[email protected]",
"isPoliticallyExposedPerson": false,
"documentNumber": "012345678910",
"registerName": "Eugene Hermiston",
"phone": {
"countryCode": "55",
"number": "51567648475"
},
"address": {
"zipCode": "00000000",
"addressLine": "Rua Cipriano Barata",
"buildingNumber": "790",
"complement": "Test",
"neighborhood": "Ipiranga",
"city": "São Paulo",
"state": "SP",
"country": "BR"
}
}
]
}
],
"legalRepresentatives": [
{
"memberQualification": "432-1",
"powerOfAttorney": {
"startDate": "2022-06-28T00:00:00+00:00",
"endDate": "2022-08-31T00:00:00+00:00"
},
"socialName": "Berniece",
"birthDate": "1988-05-06T00:00:00+00:00",
"motherName": "Guy Cummings",
"email": "[email protected]",
"isPoliticallyExposedPerson": false,
"documentNumber": "00000000000",
"registerName": "Eugene Hermiston",
"phone": {
"countryCode": "55",
"number": "15428445647"
},
"address": {
"zipCode": "00000000",
"addressLine": "Rua Cipriano Barata",
"buildingNumber": "790",
"complement": "Test",
"neighborhood": "Ipiranga",
"city": "São Paulo",
"state": "SP",
"country": "BR"
}
}
],
"status": "REPROVED",
"isBanklyPartner": false,
"createdAt": "2022-07-27T13:59:29.484+00:00",
"updatedAt": "2022-07-27T14:02:18.1530876Z",
"reprovedReasons": [
"CNPJ indicado como fraude",
"Foto do documento do responsável não enviada ou diferente da selfie",
"Dados do documento divergente",
"Idade do(s) representante(s) divergente(s)",
"Nome do(s) representante(s) divergente(s)",
"Problemas com o CPF do(s) representante(s)",
"Fraude detectada no e-mail",
"Detectado alguma palavra de cunho ofensivo",
"Risco de fraude",
"Informações não localizada nos bureaus"
]
}
}
{
"entityId": "string",
"companyKey": "string",
"idempotencyKey": "string",
"context": "Business",
"name": "BUSINESS_WAS_CANCELED",
"timestamp": "2022-07-27T14:05:55.7615825Z",
"correlationId": "string",
"data": {
"document": {
"value": "00000000000000",
"type": "CNPJ"
},
"businessName": "Lowe Rath",
"tradingName": "Greenholt Group",
"businessSize": "SMALL",
"businessType": "TS",
"cnaeCode": "99-1",
"legalNature": "123-4",
"annualBilling": 1000,
"openingDate": "2022-06-23T00:00:00+00:00",
"phone": {
"countryCode": "55",
"number": "99704748534"
},
"address": {
"zipCode": "0000000",
"addressLine": "Rua Cipriano Barata",
"buildingNumber": "790",
"neighborhood": "Ipiranga",
"city": "São Paulo",
"state": "SP",
"country": "BR"
},
"owners": [
{
"documentNumber": "62686956000146",
"email": "[email protected]",
"phone": {
"countryCode": "55",
"number": "99704748534"
},
"address": {
"zipCode": "02035000",
"addressLine": "Rua Major Sampaio",
"buildingNumber": "79",
"neighborhood": "Santana",
"city": "São Paulo",
"state": "SP",
"country": "BR"
},
"incomeDeclared": 1000,
"participationPercentage": "50",
"tradingName": "Lowe Rath",
"businessName": "Lowe Rath",
"businessType": "TS",
"owners": [],
"legalRepresentatives": [
{
"socialName": "Loma",
"birthDate": "1988-05-06T00:00:00+00:00",
"motherName": "Mr Alexis Smitham",
"email": "[email protected]",
"isPoliticallyExposedPerson": false,
"documentNumber": "58380788559",
"registerName": "Shawna Willms",
"phone": {
"countryCode": "55",
"number": "99704748534"
},
"address": {
"zipCode": "04205000",
"addressLine": "Rua Cipriano Barata",
"buildingNumber": "790",
"complement": "Test",
"neighborhood": "Ipiranga",
"city": "São Paulo",
"state": "SP",
"country": "BR"
}
}
]
}
],
"legalRepresentatives": [
{
"memberQualification": "432-1",
"powerOfAttorney": {
"startDate": "2022-06-28T00:00:00+00:00",
"endDate": "2022-08-31T00:00:00+00:00"
},
"socialName": "Tyson",
"birthDate": "1988-05-06T00:00:00+00:00",
"motherName": "Mr Alexis Smitham",
"email": "[email protected]",
"isPoliticallyExposedPerson": false,
"documentNumber": "58380788559",
"registerName": "Shawna Willms",
"phone": {
"countryCode": "55",
"number": "99704748534"
},
"address": {
"zipCode": "04205000",
"addressLine": "Rua Cipriano Barata",
"buildingNumber": "790",
"complement": "Test",
"neighborhood": "Ipiranga",
"city": "São Paulo",
"state": "SP",
"country": "BR"
}
}
],
"status": "CANCELED",
"isBanklyPartner": false,
"createdAt": "2022-07-27T13:59:20.254+00:00",
"updatedAt": "2022-07-27T14:05:55.5983851Z"
}
}
Importante
Para conhecer a estrutura básica dos eventos com os campos que chegarão à sua API, consulte nossa documentação específica de Eventos.
Objeto data nos eventos de onboarding de pessoa jurídica LTDA, S.A., TS
O objeto data traz detalhes específicos do contexto em que o evento ocorre. No caso de eventos de Onboarding de pessoa jurídica LTDA, S.A., TS, esse objeto trará os seguintes campos:
-
document: objeto que contém o número e o tipo do documento, que neste contexto será o CNPJ da empresa:value: número do CNPJ;type: tipo do documento. Neste caso, “CNPJ”.
-
businessName: razão social da empresa; -
tradingName: nome fantasia da empresa, também conhecido como nome comercial; -
businessSize: porte da empresa, o qual pode ser: SMALL, MEDIUM ou LARGE; -
businessType: tipo da empresa, o qual pode ser: LTDA, S.A. ou TS; -
cnaeCode: código CNAE (Classificação Nacional de Atividades Econômicas) da empresa; -
legalNature: natureza jurídica da empresa; -
annualBilling: faturamento anual da empresa; -
openingDate: data de abertura da empresa; -
phone: objeto que contém informações sobre o número de telefone da empresa. Essa mesma entidade será utilizada para o sócio e para o representante legal.countryCode: código DDI do país;number: número de telefone incluindo DDD.
-
address: objeto que contém informações sobre o endereço comercial da empresa. Essa mesma entidade será utilizada para o sócio e para o representante legal.zipcode: código postal do endereço;addressLine: nome da rua;buildingNumber: número do prédio ou da casa;complement: complemento do endereço;neighborhood: nome do bairro;city: nome da cidade;state: nome do estado;country: nome do país.
-
owners: lista com os sócios da empresa e suas informações, que podem variar entre pessoa física e pessoa jurídica:Para pessoa física:
documentNumber: número do CPF do sócio;registerName: nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do sócio;socialName: nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social;birthDate: data de nascimento do sócio;motherName: nome da mãe do sócio como consta no documento;email: endereço de e-mail do sócio;isPoliticallyExposedPerson: informa se o sócio da empresa é uma pessoa politicamente exposta;phone: objeto que contém o DDD e o número de telefone do sócio da empresa. Seus subcampos foram descritos no campophonemencionado anteriormente;address: objeto que contém os dados do endereço do sócio da empresa. Os subcampos expostos neste campo foram descritos no objetoaddressmencionado anteriormente;incomeDeclared: renda declarada do sócio;participationPercentage: percentual de participação na empresa (0 a 100).
Para pessoa jurídica:
documentNumber: número do CNPJ do sócio;businessName: razão social da empresa sócia;businessType: tipo da empresa sócia, o qual pode ser: LTDA, S.A. ou TS;tradingName: nome fantasia da empresa sócia, também conhecido como nome comercial;owners: este subcampo deverá ser preenchido da mesma forma que o campoownersdescrito anteriormente;email: endereço de e-mail do sócio;phone: objeto que contém o DDD e o número de telefone comercial do sócio da empresa. Seus subcampos foram descritos no campophonemencionado anteriormente;address: objeto que contém os dados do endereço comercial do sócio da empresa. Os subcampos expostos neste campo foram descritos no campoaddressmencionado anteriormente;incomeDeclared: renda declarada do sócio;participationPercentage: percentual de participação na empresa (0 a 100);legalRepresentatives: lista com os representantes legais da empresa e suas informações:socialName: nome pelo qual o representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social;birthDate: data de nascimento do representante legal;motherName: nome da mãe do representante legal como consta no documento;email: endereço de e-mail;isPoliticallyExposedPerson: informa se o representante legal da empresa é uma pessoa politicamente exposta;documentNumber: número do CPF;registerName: nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do representante legal;phone: objeto que contém o DDD e o número de telefone do representante legal da empresa. Seus subcampos foram descritos no campophonemencionado anteriormente;address: objeto que contém os dados do endereço de um dos representantes legais (link) da empresa. Os subcampos expostos neste campo são descritos no objetoaddressmencionado anteriormente.
-
legalRepresentatives: lista com os representantes legais da empresa e suas informações. Além dos subcampos mencionados anteriormente (subcampolegalRepresentativesdo campoownersde pessoa jurídica), este campo possui os seguintes subcampos:memberQualification: qualificação da pessoa física, conforme a tabela do Anexo 5 da Instrução Normativa RFB nº 1863/2018;powerOfAttorney: objeto que contém datas referentes à Procuração Pública Legal:startDate: data de início da Procuração;endDate: data do fim da Procuração.
-
status: situação do cadastro, o qual pode ser: “PENDING_APPROVAL”, "APPROVED", "REPROVED” ou “CANCELED”; -
isBanklyPartner: informa se a empresa tem parceria com o Bankly; -
createdAt: data de cadastro do cliente; -
updatedAt: data da última atualização do status de cadastro; -
reprovedReasons: uma lista dos motivos pelos quais o cadastro foi reprovado. Este campo é retornado apenas no evento BUSINESS_WAS_REPROVED.
Importante
É possível que o campo
ownersvarie 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.
Updated 11 months ago