Onboarding de MEI, EI e EIRELI
Confira os eventos relativos a Onboarding de pessoa jurídica MEI, EI, EIRELI.
beta
Os eventos de Onboarding de pessoa jurídica MEI, EI, EIRELI disparam mensagens que comunicam ao destinatário informações sobre o processo de cadastro do cliente pessoa jurídica MEI, EI, EIRELI.
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 MEI, EI, EIRELI, 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": "9999-99-99T23:59:59.999Z",
"data": {
"document": {
"value": "00000000000000",
"type": "CNPJ"
},
"businessName": "string",
"tradingName": "string",
"businessType": "MEI",
"businessSize": "MEI",
"address": {
"zipcode": "00000000",
"addressLine": "string",
"buildingNumber": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
},
"owners":
[{
"document": {
"value": "00000000000",
"type": "CPF"
},
"registerName": "string",
"socialName": "string",
"birthDate": "9999-99-99",
"phone": {
"countryCode": "55",
"number": "00999999999"
},
"address": {
"zipcode": "00000000",
"addressLine": "string",
"buildingNumber": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
},
"motherName": "string",
"email": [email protected]
}],
"legalRepresentatives":
[{
"document": {
"value": "00000000000",
"type": "CPF"
},
"registerName": "string",
"socialName": "string",
"birthDate": "9999-99-99",
"phone": {
"countryCode": "55",
"number": "00999999999"
},
"address": {
"zipcode": "00000000",
"addressLine": "string",
"buildingNumber": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
},
"motherName": "string",
"email": [email protected]
}],
"status": "PENDING_APPROVAL",
"isBanklyPartner": false,
"createdAt": "9999-99-99T23:59:59.999Z",
"updatedAt": "9999-99-99T23:59:59.999Z"
}
}
{
"correlationId": "string",
"entityId": "string",
"companyKey": "string",
"idempotencyKey": "string",
"context": "Business",
"name": "BUSINESS_WAS_APPROVED",
"timestamp": "9999-99-99T23:59:59.999Z",
"data": {
"document": {
"value": "00000000000000",
"type": "CNPJ"
},
"businessName": "string",
"tradingName": "string",
"businessType": "MEI",
"businessSize": "MEI",
"address": {
"zipcode": "00000000",
"addressLine": "string",
"buildingNumber": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
},
"owners":
[{
"document": {
"value": "00000000000",
"type": "CPF"
},
"registerName": "string",
"socialName": "string",
"birthDate": "9999-99-99",
"phone": {
"countryCode": "55",
"number": "00999999999"
},
"address": {
"zipcode": "00000000",
"addressLine": "string",
"buildingNumber": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
},
"motherName": "string",
"email": [email protected]
}],
"legalRepresentatives":
[{
"document": {
"value": "00000000000",
"type": "CPF"
},
"registerName": "string",
"socialName": "string",
"birthDate": "9999-99-99",
"phone": {
"countryCode": "55",
"number": "00999999999"
},
"address": {
"zipcode": "00000000",
"addressLine": "string",
"buildingNumber": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
},
"motherName": "string",
"email": [email protected]
}],
"status": "APPROVED",
"isBanklyPartner": false,
"createdAt": "9999-99-99T23:59:59.999Z",
"updatedAt": "9999-99-99T23:59:59.999Z"
}
}
{
"correlationId": "string",
"entityId": "string",
"companyKey": "string",
"idempotencyKey": "string",
"context": "Business",
"name": "BUSINESS_WAS_REPROVED",
"timestamp": "9999-99-99T23:59:59.999Z",
"data": {
"document": {
"value": "00000000000000",
"type": "CNPJ"
},
"businessName": "string",
"tradingName": "string",
"businessType": "MEI",
"businessSize": "MEI",
"address": {
"zipcode": "00000000",
"addressLine": "string",
"buildingNumber": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
},
"owners":
[{
"document": {
"value": "00000000000",
"type": "CPF"
},
"registerName": "string",
"socialName": "string",
"birthDate": "9999-99-99",
"phone": {
"countryCode": "55",
"number": "00999999999"
},
"address": {
"zipcode": "00000000",
"addressLine": "string",
"buildingNumber": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
},
"motherName": "string",
"email": [email protected]
}],
"legalRepresentatives": [{
"document": {
"value": "00000000000",
"type": "CPF"
},
"registerName": "string",
"socialName": "string",
"birthDate": "9999-99-99",
"phone": {
"countryCode": "55",
"number": "00999999999"
},
"address": {
"zipcode": "00000000",
"addressLine": "string",
"buildingNumber": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
},
"motherName": "string",
"email": [email protected]
}],
"status": "REPROVED",
"isBanklyPartner": false,
"createdAt": "9999-99-99T23:59:59.999Z",
"updatedAt": "9999-99-99T23:59:59.999Z",
"reprovedReasons" : [
"string",
"string",
...
]
}
}
{
"correlationId": "string",
"entityId": "string",
"companyKey": "string",
"idempotencyKey": "string",
"context": "Business",
"name": "BUSINESS_WAS_CANCELED",
"timestamp": "9999-99-99T23:59:59.999Z",
"data": {
"document": {
"value": "00000000000000",
"type": "CNPJ"
},
"businessName": "string",
"tradingName": "string",
"businessType": "MEI",
"businessSize": "MEI",
"address": {
"zipcode": "00000000",
"addressLine": "string",
"buildingNumber": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
},
"owners":
[{
"document": {
"value": "00000000000",
"type": "CPF"
},
"registerName": "string",
"socialName": "string",
"birthDate": "9999-99-99",
"phone": {
"countryCode": "55",
"number": "00999999999"
},
"address": {
"zipcode": "00000000",
"addressLine": "string",
"buildingNumber": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
},
"motherName": "string",
"email": [email protected]
}],
"legalRepresentatives":
[{
"document": {
"value": "00000000000",
"type": "CPF"
},
"registerName": "string",
"socialName": "string",
"birthDate": "9999-99-99",
"phone": {
"countryCode": "55",
"number": "00999999999"
},
"address": {
"zipcode": "00000000",
"addressLine": "string",
"buildingNumber": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
},
"motherName": "string",
"email": [email protected]
}],
"status": "CANCELED",
"isBanklyPartner": false,
"createdAt": "9999-99-99T23:59:59.999Z",
"updatedAt": "9999-99-99T23:59:59.999Z"
}
}
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 MEI, EI, EIRELI
O objeto data traz detalhes específicos do contexto em que o evento ocorre. No caso de eventos de Onboarding de pessoa jurídica MEI, EI, EIRELI, 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;businessType: tipo de negócio, o qual pode ser: MEI, EI ou EIRELI;businessSize: porte da empresa, o qual pode ser: MEI, ME ou EPP;address: objeto que contém informações sobre o endereço comercial ou residencial: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 dos sócios da empresa, que contém o objetoaddressdescrito anteriormente e os subcampos comuns;legalRepresentatives: lista dos representantes legais da empresa, que contém o objetoaddressdescrito anteriormente e os subcampos comuns;isPoliticallyExposedPerson: informa se o sócio ou representante legal da empresa é uma pessoa politicamente exposta;status: status do cadastro, o qual pode ser: “PENDING_APPROVAL”, "APPROVED", "REPROVED” ou "CANCELED";reprovedReason: uma lista dos motivos pelos quais o cadastro foi reprovado;isBanklyPartner: informa se a empresa tem parceria com o Bankly;updatedAt: data da última atualização do status de cadastro;createdAt: data de cadastro do cliente.
Subcampos comuns aos campos owners e legalRepresentatives:
registerName: nome do sócio ou representante legal da empresa como consta no documento;socialName: nome pelo qual o sócio ou representante legal gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social;birthDate: data de nascimento do sócio ou representante legal da empresa;phone: objeto que contém informações sobre o número de telefone do sócio ou do representante legal da empresa:countryCode: código DDI do país;number: número de telefone incluindo DDD.
motherName: nome da mãe do sócio ou representante legal da empresa como consta no documento de identidade;email: e-mail do sócio ou representante legal da empresa.
Updated 11 months ago