[BV] Onboarding de pessoa física

stable

Os eventos relacionados a pessoa física disparam mensagens sempre que há atualizações referentes ao processo de cadastro do cliente: solicitação, análise, aprovação, reprovação, cancelamento, revogação, bloqueio e atualização.

Para mais informações sobre quando estes eventos são disparados e sobre o seu conteúdo, consulte as páginas:

Pré-requisitos

Para receber esses eventos, o parceiro deverá:

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
CustomerCUSTOMER_WAS_RECEIVEDA solicitação de cadastro do cliente foi recebida.
CustomerCUSTOMER_IN_ANALYSISO cadastro do cliente está em análise.
CustomerCUSTOMER_WAS_APPROVEDO cadastro do cliente foi aprovado.
CustomerCUSTOMER_WAS_REPROVEDO cadastro do cliente foi reprovado.
CustomerCUSTOMER_WAS_CANCELEDO cadastro do cliente foi cancelado.
CustomerCUSTOMER_WAS_REVOKEDO cadastro do cliente foi revogado impossibilitando a realização de cash-out a partir de suas contas (Pix, TED, pagamento de contas e uso de cartão).
CustomerCUSTOMER_WAS_BLOCKEDO cadastro do cliente foi bloqueado (na maioria dos casos, devido à fraude).
CustomerCUSTOMER_WAS_UPDATEDO cadastro do cliente pessoa física foi atualizado.

Identificador (entityId)

O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão.

No contexto de pessoa física, o entityId é o identificador único do cliente.

Dados dos eventos

CUSTOMER_WAS_RECEIVED

Este evento sinaliza a ocorrência de uma atualização no status de rastreio.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
licenseobjectObjeto que contém informações sobre a licença bancária vinculada ao produto.
license.uuidstringIdentificador da licença bancária.
documentobjectObjeto que contém informações sobre o documento do cliente.
document.valuestringNúmero do documento.
document.typestringTipo do documento. Neste caso, “CPF”.
registerNamestringNome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente.
socialNamestringNome pelo qual o cliente gostaria de ser chamado.
birthDatestringData de nascimento do cliente, no formato ISO 8601 - UTC.
phoneobjectObjeto que contém informações sobre o telefone do cliente.
phone.countryCodestringCódigo DDI do país.
phone.numberstringNúmero de telefone incluindo DDD.
addressobjectObjeto que contém informações sobre o endereço informado no registro do cliente.
address.zipcodestringCódigo postal do endereço.
address.addressLine stringNome da rua.
address.buildingNumber stringNúmero do imóvel.
address.neighborhoodstringNome do bairro ou distrito.
address.countrystringSigla do país.
address.state stringSigla do estado.
address.citystringNome da cidade.
motherNamestringNome da mãe informado no registro do cliente.
emailstriingE-mail de contato do cliente.
profilestringPerfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE"
statusstringSituação do registro do cliente, a qual neste caso sempre será “PENDING_APPROVAL”.
createdAtstringData do primeiro registro do cliente, no formato ISO 8601 - UTC.
updatedAtstringData da atualização do registro do cliente, no formato ISO 8601 - UTC.
declaredIncomestringFaixa de renda declarada pelo cliente.
confirmedIncomestringIndica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null.
assertedIncomeobjectObjeto que contém as informações sobre a renda declarada do cliente.
assertedIncome.valuenumberValor da renda do cliente
assertedIncome.currencystringSigla da moeda da renda do cliente.
occupationstringCódigo de ocupação do cliente.
pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978.
pep.levelstringNível de exposição política do cliente: "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).
pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false.
documentationobjectObjeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise.
documentation.selfiestringToken da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardFrontstringToken da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardBackstringToken da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais.
Exemplo de payload
{
      "entityId": "12346789000",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Customer",
      "name": "CUSTOMER_WAS_RECEIVED",
      "timestamp": "2021-10-05T00:00:00.000Z",
      "correlationId": "61833e96-86ea-4248-9700-5fd08a00bcb2",
      "version": "1",
      "metadata": {
         "key1": "value1",
         "key2": "value2"
      },
      "data": {
         "license": {
			      "uuid": "24ac71da-4309-4348-9cc0-a0c88f867993"
		     },
         "document": {
            "value": "47742663023",
            "type": "CPF"
         },
         "registerName": "Nísia Floresta",
         "socialName": "",
         "birthDate": "1810-10-12T00:00:00",
         "phone": {
            "countryCode": "55",
            "number": "23415162342"
         },
         "address": {
            "zipcode": "68060100",
            "addressLine": "6 de Março",
            "buildingNumber": "2500",
            "neighborhood": "Alter do Chão",
            "country": "BR",
            "state": "PA",
            "city": "Santarém"
         },
         "motherName": "Dionísia Gonçalves Pinto",
         "email": "[email protected]",
         "profile": "COMPLETE",
         "status": "PENDING_APPROVAL",
         "createdAt": "2021-11-21T11:35:27.407Z",
         "updatedAt": "2021-11-21T11:35:28Z",
         "declaredIncome": "LESS_THAN_ONE_THOUSAND",
         "confirmedIncome": "",
				 "assertedIncome": {
					  "value": 56783.88,
					  "currency": "BRL"
				 },
         "occupation": "OCP0082",
         "pep": {
            "level": "NONE",
            "verified": false
         },
         "documentation": {
            "selfie": "ce1849509a3f4625867ead5768d5b068",
            "idCardFront": "9c1974193d96446e84833742aed1db62",
            "idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
         }
      }
 }

CUSTOMER_IN_ANALYSIS

Este evento sinaliza que o cadastro do cliente está em análise.

⚠️

Importante

As mensagens do evento CUSTOMER_IN_ANALYSIS são disparadas exclusivamente para parceiros que contrataram o serviço de derivação de mesa. Para mais informações, entre em contato com seu gerente comercial.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
licenseobjectObjeto que contém informações sobre a licença bancária vinculada ao produto.
license.uuidstringIdentificador da licença bancária.
documentobjectObjeto que contém informações sobre o documento do cliente.
document.valuestringNúmero do documento.
document.typestringTipo do documento. Neste caso, “CPF”.
registerNamestringNome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente.
socialNamestringNome pelo qual o cliente gostaria de ser chamado.
birthDatestringData de nascimento do cliente, no formato ISO 8601 - UTC.
phoneobjectObjeto que contém informações sobre o telefone do cliente.
phone.countryCodestringCódigo DDI do país.
phone.numberstringNúmero de telefone incluindo DDD.
addressobjectObjeto que contém informações sobre o endereço informado no registro do cliente.
address.zipcodestringCódigo postal do endereço.
address.addressLine stringNome da rua.
address.buildingNumber stringNúmero do imóvel.
address.neighborhoodstringNome do bairro ou distrito.
address.countrystringSigla do país.
address.state stringSigla do estado.
address.citystringNome da cidade.
motherNamestringNome da mãe informado no registro do cliente.
emailstriingE-mail de contato do cliente.
profilestringPerfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE"
statusstringSituação do registro do cliente, a qual neste caso sempre será "IN_ANALISIS".
createdAtstringData do primeiro registro do cliente, no formato ISO 8601 - UTC.
updatedAtstringData da atualização do registro do cliente, no formato ISO 8601 - UTC.
declaredIncomestringFaixa de renda declarada pelo cliente.
confirmedIncomestringIndica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null.
assertedIncomeobjectObjeto que contém as informações sobre a renda declarada do cliente.
assertedIncome.valuenumberValor da renda do cliente
assertedIncome.currencystringSigla da moeda da renda do cliente.
occupationstringCódigo de ocupação do cliente.
pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978.
pep.levelstringNível de exposição política do cliente: "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).
pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false.
documentationobjectObjeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise.
documentation.selfiestringToken da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardFrontstringToken da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardBackstringToken da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais.
Exemplo de payload
{
      "entityId": "12346789000",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Customer",
      "name": "CUSTOMER_IN_ANALYSIS",
      "version": "1",
      "timestamp": "2021-10-06T13:07:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {
         "key1": "value1",
         "key2": "value2"
      },
      "data": {
        "license": {
			     "uuid": "24ac71da-4309-4348-9cc0-a0c88f867993"
		    },
         "document": {
            "value": "47742663023",
            "type": "CPF"
         },
         "registerName": "Nísia Floresta",
         "socialName": "",
         "birthDate": "1810-10-12T00:00:00",
         "phone": {
            "countryCode": "55",
            "number": "23415162342"
         },
         "address": {
            "zipcode": "68060100",
            "addressLine": "6 de Março",
            "buildingNumber": "2500",
            "neighborhood": "Alter do Chão",
            "country": "BR",
            "state": "PA",
            "city": "Santarém"
         },
         "motherName": "Dionísia Gonçalves Pinto",
         "email": "[email protected]",
         "profile": "COMPLETE",
         "status": "IN_ANALYSIS",
         "createdAt": "2021-11-21T11:35:27.407Z",
         "updatedAt": "2021-11-21T11:35:28Z",
         "declaredIncome": "LESS_THAN_ONE_THOUSAND",
         "confirmedIncome": "",
         "assertedIncome": {
			      "value": 56783.88,
			      "currency": "BRL"
		     },
         "occupation": "OCP0082",
         "pep": {
            "level": "NONE",
            "verified": false
         },
         "documentation": {
            "selfie": "ce1849509a3f4625867ead5768d5b068",
            "idCardFront": "9c1974193d96446e84833742aed1db62",
            "idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
         }
      }
 }

CUSTOMER_WAS_APPROVED

Este evento sinaliza que o cadastro do cliente foi aprovado.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
licenseobjectObjeto que contém informações sobre a licença bancária vinculada ao produto.
license.uuidstringIdentificador da licença bancária.
documentobjectObjeto que contém informações sobre o documento do cliente.
document.valuestringNúmero do documento.
document.typestringTipo do documento. Neste caso, “CPF”.
registerNamestringNome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente.
socialNamestringNome pelo qual o cliente gostaria de ser chamado.
birthDatestringData de nascimento do cliente, no formato ISO 8601 - UTC.
phoneobjectObjeto que contém informações sobre o telefone do cliente.
phone.countryCodestringCódigo DDI do país.
phone.numberstringNúmero de telefone incluindo DDD.
addressobjectObjeto que contém informações sobre o endereço informado no registro do cliente.
address.zipcodestringCódigo postal do endereço.
address.addressLine stringNome da rua.
address.buildingNumber stringNúmero do imóvel.
address.neighborhoodstringNome do bairro ou distrito.
address.countrystringSigla do país.
address.state stringSigla do estado.
address.citystringNome da cidade.
motherNamestringNome da mãe informado no registro do cliente.
emailstringE-mail de contato do cliente.
profilestringPerfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE"
statusstringSituação do registro do cliente, a qual neste caso sempre será "APPROVED".
createdAtstringData do primeiro registro do cliente, no formato ISO 8601 - UTC.
updatedAtstringData da atualização do registro do cliente, no formato ISO 8601 - UTC.
declaredIncomestringFaixa de renda declarada pelo cliente.
confirmedIncomestringIndica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null.
assertedIncomeobjectObjeto que contém as informações sobre a renda declarada do cliente.
assertedIncome.valuenumberValor da renda do cliente
assertedIncome.currencystringSigla da moeda da renda do cliente.
occupationstringCódigo de ocupação do cliente.
pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978.
pep.levelstringNível de exposição política do cliente: "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).
pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false.
documentationobjectObjeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise.
documentation.selfiestringToken da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardFrontstringToken da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardBackstringToken da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais.
Exemplo de payload
{
      "entityId": "12346789000",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Customer",
      "name": "CUSTOMER_WAS_APPROVED",
      "timestamp": "2021-10-05T00:00:00.000Z",
      "correlationId": "61833e96-86ea-4248-9700-5fd08a00bcb2",
      "version": "1",
      "metadata": {
         "key1": "value1",
         "key2": "value2"
      },
      "data": {
         "license": {
			      "uuid": "24ac71da-4309-4348-9cc0-a0c88f867993"
		     },
         "document": {
            "value": "47742663023",
            "type": "CPF"
         },
         "registerName": "Nísia Floresta",
         "socialName": "",
         "birthDate": "1810-10-12T00:00:00",
         "phone": {
            "countryCode": "55",
            "number": "23415162342"
         },
         "address": {
            "zipcode": "68060100",
            "addressLine": "6 de Março",
            "buildingNumber": "2500",
            "neighborhood": "Alter do Chão",
            "country": "BR",
            "state": "PA",
            "city": "Santarém"
         },
         "motherName": "Dionísia Gonçalves Pinto",
         "email": "[email protected]",
         "profile": "COMPLETE",
         "status": "APPROVED",
         "createdAt": "2021-11-21T11:35:27.407Z",
         "updatedAt": "2021-11-21T11:35:28Z",
         "declaredIncome": "LESS_THAN_ONE_THOUSAND",
         "confirmedIncome": "",
         "assertedIncome": {
			      "value": 56783.88,
			      "currency": "BRL"
		     },
         "occupation": "OCP0082",
         "pep": {
            "level": "NONE",
            "verified": false
         },
         "documentation": {
            "selfie": "ce1849509a3f4625867ead5768d5b068",
            "idCardFront": "9c1974193d96446e84833742aed1db62",
            "idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
         }
      }
 }

CUSTOMER_WAS_REPROVED

Este evento sinaliza que o cadastro do cliente foi reprovado.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
licenseobjectObjeto que contém informações sobre a licença bancária vinculada ao produto.
license.uuidstringIdentificador da licença bancária.
documentobjectObjeto que contém informações sobre o documento do cliente.
document.valuestringNúmero do documento.
document.typestringTipo do documento. Neste caso, “CPF”.
registerNamestringNome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente.
socialNamestringNome pelo qual o cliente gostaria de ser chamado.
birthDatestringData de nascimento do cliente, no formato ISO 8601 - UTC.
phoneobjectObjeto que contém informações sobre o telefone do cliente.
phone.countryCodestringCódigo DDI do país.
phone.numberstringNúmero de telefone incluindo DDD.
addressobjectObjeto que contém informações sobre o endereço informado no registro do cliente.
address.zipcodestringCódigo postal do endereço.
address.addressLine stringNome da rua.
address.buildingNumber stringNúmero do imóvel.
address.neighborhoodstringNome do bairro ou distrito.
address.countrystringSigla do país.
address.state stringSigla do estado.
address.citystringNome da cidade.
motherNamestringNome da mãe informado no registro do cliente.
emailstringE-mail de contato do cliente.
profilestringPerfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE"
statusstringSituação do registro do cliente, a qual neste caso sempre será "REPROVED”.
reprovedReasonsstringMotivo pelo qual o cadastro foi reprovado.
createdAtstringData do primeiro registro do cliente, no formato ISO 8601 - UTC.
updatedAtstringData da atualização do registro do cliente, no formato ISO 8601 - UTC.
declaredIncomestringFaixa de renda declarada pelo cliente.
confirmedIncomestringIndica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null.
assertedIncomeobjectObjeto que contém as informações sobre a renda declarada do cliente.
assertedIncome.valuenumberValor da renda do cliente
assertedIncome.currencystringSigla da moeda da renda do cliente.
occupationstringCódigo de ocupação do cliente.
pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978.
pep.levelstringNível de exposição política do cliente: "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).
pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false.
documentationobjectObjeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise.
documentation.selfiestringToken da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardFrontstringToken da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardBackstringToken da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais.
Exemplo de payload
{
      "entityId": "12346789000",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Customer",
      "name": "CUSTOMER_WAS_REPROVED",
      "version": "1",
      "timestamp": "2021-10-06T13:07:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {
         "key1": "value1",
         "key2": "value2"
      },
      "data": {
         "license": {
			      "uuid": "24ac71da-4309-4348-9cc0-a0c88f867993"
		    },
         "document": {
            "value": "47742663023",
            "type": "CPF"
         },
         "registerName": "Nísia Floresta",
         "socialName": "",
         "birthDate": "1810-10-12T00:00:00",
         "phone": {
            "countryCode": "55",
            "number": "23415162342"
         },
         "address": {
            "zipcode": "68060100",
            "addressLine": "6 de Março",
            "buildingNumber": "2500",
            "neighborhood": "Alter do Chão",
            "country": "BR",
            "state": "PA",
            "city": "Santarém"
         },
         "motherName": "Dionísia Gonçalves Pinto",
         "email": "[email protected]",
         "profile": "COMPLETE",
         "status": "REPROVED",
         "reprovedReasons": [
            "NAME_RECUSED"
         ],
         "createdAt": "2021-11-21T11:35:27.407Z",
         "updatedAt": "2021-11-21T11:35:28Z",
         "declaredIncome": "LESS_THAN_ONE_THOUSAND",
         "confirmedIncome": "",
         "assertedIncome": {
			      "value": 56783.88,
			      "currency": "BRL"
		     },
         "occupation": "OCP0082",
         "pep": {
            "level": "NONE",
            "verified": false
         },
         "documentation": {
            "selfie": "ce1849509a3f4625867ead5768d5b068",
            "idCardFront": "9c1974193d96446e84833742aed1db62",
            "idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
         }
      }
 }

CUSTOMER_WAS_UPDATED

Este evento sinaliza que o cadastro do cliente foi atualizado.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
licenseobjectObjeto que contém informações sobre a licença bancária vinculada ao produto.
license.uuidstringIdentificador da licença bancária.
documentobjectObjeto que contém informações sobre o documento do cliente.
document.valuestringNúmero do documento.
document.typestringTipo do documento. Neste caso, “CPF”.
registerNamestringNome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente.
socialName stringNome pelo qual o cliente gostaria de ser chamado.
birthDatestringData de nascimento do cliente, no formato ISO 8601 - UTC.
phoneobjectObjeto que contém informações sobre o telefone do cliente.
phone.countryCodestringCódigo DDI do país.
phone.numberstringNúmero de telefone incluindo DDD.
addressobjectObjeto que contém informações sobre o endereço informado no registro do cliente.
address.zipcodestringCódigo postal do endereço.
address.addressLine stringNome da rua.
address.buildingNumber stringNúmero do imóvel.
address.neighborhoodstringNome do bairro ou distrito.
address.countrystringSigla do país.
address.state stringSigla do estado.
address.citystringNome da cidade.
motherNamestringNome da mãe informado no registro do cliente.
emailstringE-mail de contato do cliente.
declaredIncomestringFaixa de renda declarada pelo cliente.
assertedIncomeobjectObjeto que contém as informações sobre a renda declarada do cliente.
assertedIncome.valuenumberValor da renda do cliente
assertedIncome.currencystringSigla da moeda da renda do cliente.
confirmedIncomestringIndica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null.
occupationstringCódigo de ocupação do cliente.
pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978.
pep.levelstringNível de exposição política do cliente: "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).
pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false.
profilestringPerfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE"
statusstringSituação do registro do cliente, a qual neste caso sempre será "APPROVED".
createdAtstringData do primeiro registro do cliente, no formato ISO 8601 - UTC.
updatedAtstringData da atualização do registro do cliente, no formato ISO 8601 - UTC.
Exemplo de payload
{
      "entityId": "12346789000",
      "companyKey": "FLORESTA_ED",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "context": "Customer",
      "name": "CUSTOMER_WAS_UPDATED",
      "timestamp": "2022-12-26T22:40:43.031587Z",
      "correlationId": "396f6c12-58b0-4c46-abc3-c6ba987cbd0d",
      "data": {
         "document": {
            "value": "47742663023",
            "type": "CPF"
         },
         "registerName": "Nísia Floresta",
         "socialName": "Nísia Floresta",
         "birthDate": "1810-10-12T00:00:00",
         "phone": {
            "countryCode": "55",
            "number": "23415162342"
         },
         "address": {
            "zipcode": "68060100",
            "addressLine": "6 de Março",
            "buildingNumber": "2500",
            "neighborhood": "Alter do Chão",
            "country": "BR",
            "state": "PA",
            "city": "Santarém"
         },
         "motherName": "Dionísia Gonçalves Pinto",
         "email": "[email protected]",
         "declaredIncome": "LESS_THAN_ONE_THOUSAND",
         "confirmedIncome": "",
         "occupation": "OCP0082",
         "pep": {
            "level": "NONE",
            "verified": false
         },
         "profile": "SIMPLE",
         "status": "APPROVED",
         "createdAt": "2022-12-26T22:18:48.61",
         "updatedAt": "2022-12-26T22:40:43.0294516Z"
      }
 }

CUSTOMER_WAS_CANCELED

Este evento sinaliza que o cadastro do cliente foi cancelado.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
licenseobjectObjeto que contém informações sobre a licença bancária vinculada ao produto.
license.uuidstringIdentificador da licença bancária.
documentobjectObjeto que contém informações sobre o documento do cliente.
document.valuestringNúmero do documento.
document.typestringTipo do documento. Neste caso, “CPF”.
registerNamestringNome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente.
socialName stringNome pelo qual o cliente gostaria de ser chamado.
birthDatestringData de nascimento do cliente, no formato ISO 8601 - UTC.
phoneobjectObjeto que contém informações sobre o telefone do cliente.
phone.countryCodestringCódigo DDI do país.
phone.numberstringNúmero de telefone incluindo DDD.
addressobjectObjeto que contém informações sobre o endereço informado no registro do cliente.
address.zipcodestringCódigo postal do endereço.
address.addressLine stringNome da rua.
address.buildingNumber stringNúmero do imóvel.
address.neighborhoodstringNome do bairro ou distrito.
address.countrystringSigla do país.
address.state stringSigla do estado.
address.citystringNome da cidade.
motherNamestringNome da mãe informado no registro do cliente.
emailstringE-mail de contato do cliente.
profilestringPerfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE"
statusstringSituação do registro do cliente, a qual neste caso sempre será “CANCELED”.
createdAtstringData do primeiro registro do cliente, no formato ISO 8601 - UTC.
updatedAtstringData da atualização do registro do cliente, no formato ISO 8601 - UTC.
declaredIncomestringFaixa de renda declarada pelo cliente.
assertedIncomeobjectObjeto que contém as informações sobre a renda declarada do cliente.
assertedIncome.valuenumberValor da renda do cliente
assertedIncome.currencystringSigla da moeda da renda do cliente.
confirmedIncomestringIndica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null.
occupationstringCódigo de ocupação do cliente.
pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978.
pep.levelstringNível de exposição política do cliente: "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).
pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false.
documentationobjectObjeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise.
documentation.selfiestringToken da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardFrontstringToken da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardBackstringToken da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais.
Exemplo de payload
{
      "entityId": "12346789000",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Customer",
      "name": "CUSTOMER_WAS_CANCELED",
      "version": "1",
      "timestamp": "2021-10-06T13:07:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {
         "key1": "value1",
         "key2": "value2"
      },
      "data": {
         "license": {
			      "uuid": "24ac71da-4309-4348-9cc0-a0c88f867993"
		     },
         "document": {
            "value": "47742663023",
            "type": "CPF"
         },
         "registerName": "Nísia Floresta",
         "birthDate": "1810-10-12",
         "phone": {
            "countryCode": "55",
            "number": "23415162342"
         },
         "address": {
            "zipcode": "68060100",
            "addressLine": "6 de Março",
            "buildingNumber": "2500",
            "neighborhood": "Alter do Chão",
            "country": "BR",
            "state": "PA",
            "city": "Santarém"
         },
         "motherName": "Dionísia Gonçalves Pinto",
         "email": "[email protected]",
         "profile": "COMPLETE",
         "status": "CANCELED",
         "createdAt": "2021-11-21T11:35:27.407Z",
         "updatedAt": "2021-11-21T11:35:28Z",
         "declaredIncome": "LESS_THAN_ONE_THOUSAND",
         "assertedIncome": {
				    "value": 56783.88,
				    "currency": "BRL"
			   },
         "confirmedIncome": "",
         "occupation": "OCP0082",
         "pep": {
            "level": "NONE",
            "verified": false
         },
         "documentation": {
            "selfie": "ce1849509a3f4625867ead5768d5b068",
            "idCardFront": "9c1974193d96446e84833742aed1db62",
            "idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
         }
      }
 }

CUSTOMER_WAS_BLOCKED

Este evento sinaliza que o cadastro do cliente foi bloqueado (na maioria dos casos, devido à fraude).

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
licenseobjectObjeto que contém informações sobre a licença bancária vinculada ao produto.
license.uuidstringIdentificador da licença bancária.
documentobjectObjeto que contém informações sobre o documento do cliente.
document.valuestringNúmero do documento.
document.typestringTipo do documento. Neste caso, “CPF”.
registerNamestringNome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente.
socialName stringNome pelo qual o cliente gostaria de ser chamado.
birthDatestringData de nascimento do cliente, no formato ISO 8601 - UTC.
phoneobjectObjeto que contém informações sobre o telefone do cliente.
phone.countryCodestringCódigo DDI do país.
phone.numberstringNúmero de telefone incluindo DDD.
addressobjectObjeto que contém informações sobre o endereço informado no registro do cliente.
address.zipcodestringCódigo postal do endereço.
address.addressLine stringNome da rua.
address.buildingNumber stringNúmero do imóvel.
address.neighborhoodstringNome do bairro ou distrito.
address.countrystringSigla do país.
address.state stringSigla do estado.
address.citystringNome da cidade.
motherNamestringNome da mãe informado no registro do cliente.
emailstringE-mail de contato do cliente.
profilestringPerfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE"
statusstringSituação do registro do cliente, a qual neste caso sempre será "BLOCKED”.
createdAtstringData do primeiro registro do cliente, no formato ISO 8601 - UTC.
updatedAtstringData da atualização do registro do cliente, no formato ISO 8601 - UTC.
declaredIncomestringFaixa de renda declarada pelo cliente.
assertedIncomeobjectObjeto que contém as informações sobre a renda declarada do cliente.
assertedIncome.valuenumberValor da renda do cliente
assertedIncome.currencystringSigla da moeda da renda do cliente.
confirmedIncomestringIndica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null.
occupationstringCódigo de ocupação do cliente.
pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978.
pep.levelstringNível de exposição política do cliente: "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).
pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false.
documentationobjectObjeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise.
documentation.selfiestringToken da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardFrontstringToken da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardBackstringToken da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais.
Exemplo de payload
{
      "entityId": "12346789000",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Customer",
      "name": "CUSTOMER_WAS_BLOCKED",
      "version": "1",
      "timestamp": "2021-10-06T13:07:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {
         "key1": "value1",
         "key2": "value2"
      },
      "data": {
         "license": {
            "uuid": "24ac71da-4309-4348-9cc0-a0c88f867993"
         },
         "document": {
            "value": "47742663023",
            "type": "CPF"
         },
         "registerName": "Nísia Floresta",
         "birthDate": "1810-10-12",
         "phone": {
            "countryCode": "55",
            "number": "23415162342"
         },
         "address": {
            "zipcode": "68060100",
            "addressLine": "6 de Março",
            "buildingNumber": "2500",
            "neighborhood": "Alter do Chão",
            "country": "BR",
            "state": "PA",
            "city": "Santarém"
         },
         "motherName": "Dionísia Gonçalves Pinto",
         "email": "[email protected]",
         "profile": "COMPLETE",
         "status": "BLOCKED",
         "createdAt": "2021-11-21T11:35:27.407Z",
         "updatedAt": "2021-11-21T11:35:28Z",
         "declaredIncome": "LESS_THAN_ONE_THOUSAND",
         "assertedIncome": {
            "value": 56783.88,
            "currency": "BRL"
         },
         "confirmedIncome": "",
         "occupation": "OCP0082",
         "pep": {
            "level": "NONE",
            "verified": false
         },
         "documentation": {
            "selfie": "ce1849509a3f4625867ead5768d5b068",
            "idCardFront": "9c1974193d96446e84833742aed1db62",
            "idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
         }
      }
 }

CUSTOMER_WAS_REVOKED

Este evento sinaliza que o cadastro do cliente foi revogado.

A revogação de cadastro ocorre após uma análise manual, por decisão da área de cadastro e prevenção à fraude do Bankly.

A decisão para revogar um cadastro se dá quando houver:

  • Dados cadastrais divergentes: nome do titular, nome da mãe, data de nascimento etc.
  • Documento de identificação não validado: ilegível, incompleto, danificado ou vencido.
  • Selfie inválida: escura, alta claridade, muito longe da câmera ou muito próxima da câmera.

🚧

Importante

Uma vez que o cadastro de um cliente tenha sido revogado, as contas principais ligadas a seu CPF bem como as pockets ficarão impedidas de realizar operações do tipo cash-out (Pix, TED, pagamento de contas e uso de cartão).

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
licenseobjectObjeto que contém informações sobre a licença bancária vinculada ao produto.
license.uuidstringIdentificador da licença bancária.
documentobjectObjeto que contém informações sobre o documento do cliente.
document.valuestringNúmero do documento.
document.typestringTipo do documento. Neste caso, “CPF”.
registerNamestringNome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente.
socialName stringNome pelo qual o cliente gostaria de ser chamado.
birthDatestringData de nascimento do cliente, no formato ISO 8601 - UTC.
phoneobjectObjeto que contém informações sobre o telefone do cliente.
phone.countryCodestringCódigo DDI do país.
phone.numberstringNúmero de telefone incluindo DDD.
addressobjectObjeto que contém informações sobre o endereço informado no registro do cliente.
address.zipcodestringCódigo postal do endereço.
address.addressLine stringNome da rua.
address.buildingNumber stringNúmero do imóvel.
address.neighborhoodstringNome do bairro ou distrito.
address.countrystringSigla do país.
address.state stringSigla do estado.
address.citystringNome da cidade.
motherNamestringNome da mãe informado no registro do cliente.
emailstringE-mail de contato do cliente.
profilestringPerfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE"
statusstringSituação do registro do cliente, a qual neste caso sempre será "REVOKED".
createdAtstringData do primeiro registro do cliente, no formato ISO 8601 - UTC.
updatedAtstringData da atualização do registro do cliente, no formato ISO 8601 - UTC.
declaredIncomestringFaixa de renda declarada pelo cliente.
assertedIncomeobjectObjeto que contém as informações sobre a renda declarada do cliente.
assertedIncome.valuenumberValor da renda do cliente
assertedIncome.currencystringSigla da moeda da renda do cliente.
confirmedIncomestringIndica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null.
occupationstringCódigo de ocupação do cliente.
pepobjectObjeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978.
pep.levelstringNível de exposição política do cliente: "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).
pep.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false.
documentationobjectObjeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise.
documentation.selfiestringToken da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardFrontstringToken da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais.
documentation.idCardBackstringToken da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais.
Exemplo de payload
{
      "entityId": "12346789000",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Customer",
      "name": "CUSTOMER_WAS_REVOKED",
      "version": "1",
      "timestamp": "2021-10-06T13:07:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {
         "key1": "value1",
         "key2": "value2"
      },
      "data": {
         "license": {
            "uuid": "24ac71da-4309-4348-9cc0-a0c88f867993"
         },
         "document": {
            "value": "47742663023",
            "type": "CPF"
         },
         "registerName": "Nísia Floresta",
         "birthDate": "1810-10-12",
         "phone": {
            "countryCode": "55",
            "number": "23415162342"
         },
         "address": {
            "zipcode": "68060100",
            "addressLine": "6 de Março",
            "buildingNumber": "2500",
            "neighborhood": "Alter do Chão",
            "country": "BR",
            "state": "PA",
            "city": "Santarém"
         },
         "motherName": "Dionísia Gonçalves Pinto",
         "email": "[email protected]",
         "profile": "COMPLETE",
         "status": "REVOKED",
         "createdAt": "2021-11-21T11:35:27.407Z",
         "updatedAt": "2021-11-21T11:35:28Z",
         "declaredIncome": "LESS_THAN_ONE_THOUSAND",
         "assertedIncome": {
            "value": 56783.88,
            "currency": "BRL"
         },
         "confirmedIncome": "",
         "occupation": "OCP0082",
         "pep": {
            "level": "NONE",
            "verified": false
         },
         "documentation": {
            "selfie": "ce1849509a3f4625867ead5768d5b068",
            "idCardFront": "9c1974193d96446e84833742aed1db62",
            "idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
         }
      }
 }

📘

Nota

Para que o cadastro seja revalidado, será necessário reenviar as informações de Onboarding (selfie, documentos de identificação e registro). Lembrando que, caso os dados sejam enviados de forma incorreta ou incompleta, haverá reprovação do CPF.

Faixa de renda declarada

FaturamentoDescrição
LESS_THAN_ONE_THOUSANDInferior a mil.
FROM_ONE_THOUSAND_TO_TWO_THOUSANDDe mil a dois mil.
FROM_TWO_THOUSAND_TO_THREE_THOUSANDDe 2 mil a 3 mil.
FROM_THREE_THOUSAND_TO_FIVE_THOUSANDDe 3 mil a 5 mil.
FROM_FIVE_THOUSAND_TO_TEN_THOUSANDDe 5 mil a 10 mil.
FROM_TEN_THOUSAND_TO_TWENTY_THOUSANDDe 10 mil a 20 mil.
OVER_TWENTY_THOUSANDAcima de 20 mil.

Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados