Pessoa Física (Customer)
Contexto (context) | Nome do evento (name) | Descrição |
---|---|---|
Customer | CUSTOMER_WAS_RECEIVED | A solicitação de cadastro do cliente foi recebida. |
Customer | CUSTOMER_IN_ANALYSIS | O cadastro do cliente está em análise. |
Customer | CUSTOMER_WAS_APPROVED | O cadastro do cliente foi aprovado. |
Customer | CUSTOMER_WAS_REPROVED | O cadastro do cliente foi reprovado. |
Customer | CUSTOMER_WAS_CANCELED | O cadastro do cliente foi cancelado. |
Customer | CUSTOMER_WAS_REVOKED | O 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). |
Customer | CUSTOMER_WAS_BLOCKED | O cadastro do cliente foi bloqueado (na maioria dos casos, devido à fraude). |
Customer | CUSTOMER_WAS_UPDATED | O cadastro do cliente pessoa física foi atualizado. |
Os fluxogramas a seguir descrevem a sequência em que os eventos ocorrem com base no contexto em que eles estão inseridos. Clique nas imagens para ampliá-las:
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.
Este evento sinaliza que a solicitação de cadastro de um cliente foi recebida.
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será “PENDING_APPROVAL”. |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"registerName": "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]",
"profile": "COMPLETE",
"status": "APPROVED",
"createdAt": "2021-11-21T11:35:27.407Z",
"updatedAt": "2021-11-21T11:35:28Z",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"assertedIncome": {
"currency": "BRL",
"value": 500000
},
"confirmedIncome": "",
"occupation": "OCP0082",
"pep": {
"level": "NONE",
"verified": false
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}
}
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.
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será "IN_ANALISIS". |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"registerName": "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]",
"profile": "COMPLETE",
"status": "IN_ANALYSIS",
"createdAt": "2021-11-21T11:35:27.407Z",
"updatedAt": "2021-11-21T11:35:28Z",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"assertedIncome": {
"currency": "BRL",
"value": 500000
},
"confirmedIncome": "",
"occupation": "OCP0082",
"pep": {
"level": "NONE",
"verified": false
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}
}
Este evento sinaliza que o cadastro do cliente foi aprovado.
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será "APPROVED". |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"registerName": "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]",
"profile": "COMPLETE",
"status": "APPROVED",
"createdAt": "2021-11-21T11:35:27.407Z",
"updatedAt": "2021-11-21T11:35:28Z",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"assertedIncome": {
"currency": "BRL",
"value": 500000
},
"confirmedIncome": "",
"occupation": "OCP0082",
"pep": {
"level": "NONE",
"verified": false
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}
}
Este evento sinaliza que o cadastro do cliente foi reprovado.
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será "REPROVED”. |
reprovedReasons | string | Motivo pelo qual o cadastro foi reprovado. |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"registerName": "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]",
"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": {
"currency": "BRL",
"value": 500000
},
"occupation": "OCP0082",
"pep": {
"level": "NONE",
"verified": false
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}
}
Este evento sinaliza que o cadastro do cliente foi atualizado.
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
socialName | string | Nome pelo qual a pessoa gostaria de ser chamada. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será "APPROVED". |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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",
"assertedIncome": {
"currency": "BRL",
"value": 500000
},
"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"
}
}
Este evento sinaliza que o cadastro do cliente foi cancelado.
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | objeto | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será “CANCELED”. |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"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": {
"currency": "BRL",
"value": 500000
},
"confirmedIncome": "",
"occupation": "OCP0082",
"pep": {
"level": "NONE",
"verified": false
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}
}
Este evento sinaliza que o cadastro do cliente foi bloqueado (na maioria dos casos, devido à fraude).
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será "BLOCKED”. |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"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": {
"currency": "BRL",
"value": 500000
},
"confirmedIncome": "",
"occupation": "OCP0082",
"pep": {
"level": "NONE",
"verified": false
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}
}
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 Hiperbanco.
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).
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será "REVOKED". |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"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": {
"currency": "BRL",
"value": 500000
},
"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
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. |
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:
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
.
Os campos context
e name
poderão variar de acordo com a tabela a seguir:
Contexto (context) | Nome do evento (name) | Descrição |
---|---|---|
Customer | CUSTOMER_WAS_RECEIVED | A solicitação de cadastro do cliente foi recebida. |
Customer | CUSTOMER_IN_ANALYSIS | O cadastro do cliente está em análise. |
Customer | CUSTOMER_WAS_APPROVED | O cadastro do cliente foi aprovado. |
Customer | CUSTOMER_WAS_REPROVED | O cadastro do cliente foi reprovado. |
Customer | CUSTOMER_WAS_CANCELED | O cadastro do cliente foi cancelado. |
Customer | CUSTOMER_WAS_REVOKED | O 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). |
Customer | CUSTOMER_WAS_BLOCKED | O cadastro do cliente foi bloqueado (na maioria dos casos, devido à fraude). |
Customer | CUSTOMER_WAS_UPDATED | O cadastro do cliente pessoa física foi atualizado. |
Os fluxogramas a seguir descrevem a sequência em que os eventos ocorrem com base no contexto em que eles estão inseridos. Clique nas imagens para ampliá-las:
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.
Este evento sinaliza que a solicitação de cadastro de um cliente foi recebida.
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será “PENDING_APPROVAL”. |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"registerName": "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]",
"profile": "COMPLETE",
"status": "APPROVED",
"createdAt": "2021-11-21T11:35:27.407Z",
"updatedAt": "2021-11-21T11:35:28Z",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"assertedIncome": {
"currency": "BRL",
"value": 500000
},
"confirmedIncome": "",
"occupation": "OCP0082",
"pep": {
"level": "NONE",
"verified": false
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}
}
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.
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será "IN_ANALISIS". |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"registerName": "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]",
"profile": "COMPLETE",
"status": "IN_ANALYSIS",
"createdAt": "2021-11-21T11:35:27.407Z",
"updatedAt": "2021-11-21T11:35:28Z",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"assertedIncome": {
"currency": "BRL",
"value": 500000
},
"confirmedIncome": "",
"occupation": "OCP0082",
"pep": {
"level": "NONE",
"verified": false
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}
}
Este evento sinaliza que o cadastro do cliente foi aprovado.
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será "APPROVED". |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"registerName": "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]",
"profile": "COMPLETE",
"status": "APPROVED",
"createdAt": "2021-11-21T11:35:27.407Z",
"updatedAt": "2021-11-21T11:35:28Z",
"declaredIncome": "LESS_THAN_ONE_THOUSAND",
"assertedIncome": {
"currency": "BRL",
"value": 500000
},
"confirmedIncome": "",
"occupation": "OCP0082",
"pep": {
"level": "NONE",
"verified": false
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}
}
Este evento sinaliza que o cadastro do cliente foi reprovado.
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será "REPROVED”. |
reprovedReasons | string | Motivo pelo qual o cadastro foi reprovado. |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"registerName": "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]",
"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": {
"currency": "BRL",
"value": 500000
},
"occupation": "OCP0082",
"pep": {
"level": "NONE",
"verified": false
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}
}
Este evento sinaliza que o cadastro do cliente foi atualizado.
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
socialName | string | Nome pelo qual a pessoa gostaria de ser chamada. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será "APPROVED". |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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",
"assertedIncome": {
"currency": "BRL",
"value": 500000
},
"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"
}
}
Este evento sinaliza que o cadastro do cliente foi cancelado.
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | objeto | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será “CANCELED”. |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"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": {
"currency": "BRL",
"value": 500000
},
"confirmedIncome": "",
"occupation": "OCP0082",
"pep": {
"level": "NONE",
"verified": false
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}
}
Este evento sinaliza que o cadastro do cliente foi bloqueado (na maioria dos casos, devido à fraude).
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será "BLOCKED”. |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"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": {
"currency": "BRL",
"value": 500000
},
"confirmedIncome": "",
"occupation": "OCP0082",
"pep": {
"level": "NONE",
"verified": false
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}
}
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 Hiperbanco.
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).
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:
Nome | Tipo | Descrição |
---|---|---|
document | object | Objeto que contém informações sobre o documento do cliente. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento. Neste caso, “CPF”. |
registerName | string | Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. |
birthDate | string | Data de nascimento do cliente, no formato ISO 8601 - UTC. |
phone | object | Objeto que contém informações sobre o telefone do cliente. |
phone.countryCode | string | Código DDI do país. |
phone.number | string | Número de telefone incluindo DDD. |
address | object | Objeto que contém informações sobre o endereço informado no registro do cliente. |
address.zipcode | string | Código postal do endereço. |
address.addressLine | string | Nome da rua. |
address.buildingNumber | string | Número do imóvel. |
address.neighborhood | string | Nome do bairro ou distrito. |
address.country | string | Sigla do país. |
address.state | string | Sigla do estado. |
address.city | string | Nome da cidade. |
motherName | string | Nome da mãe informado no registro do cliente. |
email | string | E-mail de contato do cliente. |
profile | string | Perfil do cliente, baseado no registro do cliente, o qual pode ser "SIMPLE" ou "COMPLETE" |
status | string | Situação do registro do cliente, a qual neste caso sempre será "REVOKED". |
createdAt | string | Data do primeiro registro do cliente, no formato ISO 8601 - UTC. |
updatedAt | string | Data da atualização do registro do cliente, no formato ISO 8601 - UTC. |
declaredIncome | string | Faixa de renda declarada pelo cliente. Importante: campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome . |
assertedIncome | object | Objeto que contém dados da renda do cliente. |
assertedIncome.value | number | Valor em Reais da renda declarada pelo cliente. |
assertedIncome.currency | string | Moeda da renda declarada. O valor padrão é BRL. |
confirmedIncome | string | Indica se o valor informado da renda foi confirmado na análise de KYC. O valor padrão desse campo é null. |
occupation | string | Código de ocupação do cliente. |
pep | object | Objeto que contém o nível de exposição política do cliente, atendendo a Circular nº 3.978. |
pep.level | string | Ní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.verified | boolean | Indica se a situação de vínculo com pessoa politicamente exposta foi verificada na análise de KYC. O valor default desse campo é false. |
documentation | object | Objeto que contém os tokens de referência dos documentos do cliente que foram enviados para análise. |
documentation.selfie | string | Token da análise da Selfie, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardFront | string | Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
documentation.idCardBack | string | Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "e1f68723f43909bac0a7515a7f4823ef6f0d778c",
"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": {
"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": {
"currency": "BRL",
"value": 500000
},
"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
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 24 days ago