Offboarding de pessoa física

Os eventos de offboarding de pessoa física disparam mensagens que comunicam ao destinatário informações sobre o cancelamento do cadastro do cliente pessoa física.

Como esses eventos chegam ao recebedor via webhook, é preciso realizar previamente a sua configuração.

Contexto e nome do evento

Nos eventos de offboarding de pessoa física, o campo context sempre informará “Customer”, enquanto o campo name poderá variar de acordo com a transação, conforme a tabela a seguir:

Nome do evento (name)	Descrição
CUSTOMER_WAS_CANCELED	O cadastro do cliente foi cancelado.
CUSTOMER_WAS_REVOKED	O perfil do cadastro do cliente regrediu para simples.
CUSTOMER_WAS_BLOCKED	O cadastro do cliente foi bloqueado (na maioria dos casos, devido à fraude).

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.

Exemplos de eventos

{
  "correlationId": "string",
  "entityId": "string",
  "companyKey": "string",
  "idempotencyKey": "string",
  "context": "Customer",
  "name": "CUSTOMER_WAS_CANCELED",
  "timestamp": "9999-99-99T23:59:59.999Z",
  "data": {
    "document": {
      "value": "00000000000",
      "type": "CPF"
    },
    "registerName": "string",
    "socialName": "string",
    "birthDate": "9999-99-99",
    "phone": {
      "countryCode": "55",
      "number": "00999999999"
    },
    "address": {
      "zipcode": "00000000",
      "addressLine": "string",
      "buildingNumber": "string",
      "complement": "string",
      "neighborhood": "string",
      "city": "string",
      "state": "string",
      "country": "string"
    },
    "motherName": "string",
    "email": "[email protected]",
    "isPoliticallyExposedPerson": false,
    "profile": "COMPLETE",
    "status": "CANCELED",
    "createdAt": "9999-99-99T23:59:59.999Z",
    "updatedAt": "9999-99-99T23:59:59.999Z"
  }
}

{
  "correlationId": "string",
  "entityId": "string",
  "companyKey": "string",
  "idempotencyKey": "string",
  "context": "Customer",
  "name": "CUSTOMER_WAS_REVOKED",
  "timestamp": "9999-99-99T23:59:59.999Z",
  "data": {
    "document": {
		  "value": "00000000000",
			"type": "CPF"
		},
    "registerName": "string",
		"socialName": "string",
		"birthDate": "9999-99-99",
		"phone": {
			"countryCode": "55",
		  "number": "00999999999"
		},
		"address": {
			"zipcode": "00000000",
			"addressLine": "string",
			"buildingNumber": "string",
			"complement": "string",
			"neighborhood": "string",
			"city": "string",
			"state": "string",
			"country": "string"
		},
		"motherName": "string",
		"email": "[email protected]",
		"isPoliticallyExposedPerson": false,
		"profile": "SIMPLE",
		"status": "REVOKED",
		"createdAt": "9999-99-99T23:59:59.999Z",
		"updatedAt": "9999-99-99T23:59:59.999Z"
	}
}

{
  "correlationId": "string",
  "entityId": "string",
  "companyKey": "string",
  "idempotencyKey": "string",
  "context": "Customer",
  "name": "CUSTOMER_WAS_BLOCKED",
  "timestamp": "9999-99-99T23:59:59.999Z",
  "data": {
    "document": {
			"value": "00000000000",
			"type": "CPF"
		},
		"registerName": "string",
		"socialName": "string",
		"birthDate": "9999-99-99",
		"phone": {
			"countryCode": "55",
			"number": "00999999999"
		},
		"address": {
			"zipcode": "00000000",
			"addressLine": "string",
			"buildingNumber": "string",
			"complement": "string",
			"neighborhood": "string",
			"city": "string",
			"state": "string",
			"country": "string"
		 },
		"motherName": "string",
		"email": "[email protected]",
		"isPoliticallyExposedPerson": false,
		"profile": "COMPLETE",
		"status": "BLOCKED",
		"createdAt": "9999-99-99T23:59:59.999Z",
		"updatedAt": "9999-99-99T23:59:59.999Z"
 }
}

🚧
Importante
Para conhecer a estrutura básica dos eventos com os campos que chegarão à sua API, consulte nossa documentação específica de Eventos.

Objeto data nos eventos de offboarding de pessoa física

O objeto data traz detalhes específicos do contexto em que o evento ocorre. No caso de eventos de offboarding de pessoa física, esse objeto trará os seguintes campos:

document: objeto contendo o número e o tipo do documento, que neste contexto será o “CPF” do titular da conta;
registerName: nome do cliente como consta no documento;
socialName: nome social do cliente;
birthDate: data de nascimento do cliente;
phone: objeto contendo o DDD e o número do telefone do cliente;
address: objeto contendo os dados do endereço residencial;
motherName: nome da mãe do cliente como consta no documento de identidade;
email: e-mail do cliente;
isPoliticallyExposedPerson: informa se o cliente é uma pessoa politicamente exposta;
profile: perfil do cadastro, o qual pode ser: “COMPLETE” ou “SIMPLE”;
status: status do cadastro, o qual pode ser: “CANCELED”, "REVOKED" ou "BLOCKED”;
updatedAt: data da última atualização do status de cadastro;
createdAt: a data de cadastro do cliente;