Objetos Compartilhados

Boa parte dos dados são compartilhados entre os diferentes eventos de uma conta. Abaixo as definições destes objetos podem ser localizadas de maneira facilitada.

Objeto Client

Request Body

{
    "id": "123456",
    "type": "natural_person",
    "document_number": "023.456.789-01",
    "name": "John Payer",
    "email": "john@payer.com",
    "address": {
        "street": "Av. Eng. Luis Carlos Berrini",
        "number": "105",
        "neighbourhood": "Brooklin",
        "city": "São Paulo",
        "uf": "SP",
        "complement": "Cj 303",
        "postal_code": "04501-140"
    },
    "phone": {
        "international_dial_code": "55",
        "area_code": "11",
        "number": "998861708",
        "type": "mobile"
    },
    "sales_channel": "inbound_sales",
    "segment": "Personalité"
}

Objeto que representa os dados do detenedor da conta.

nome	tipo	descrição
type	enum (obrigatório)	Tipo do cliente: "natural_person" ou "legal_person"
document_number	string (obrigatório)	Número do documento, de acordo co seção padronização
name	string (obrigatório)	Nome do cliente
email	string	E-mail do cliente
address	address	Dados de endereço do cliente
phone	phone	Dados telefônicos do cliente
sales_channel	enum (obrigatório)	Canal por onde o cliente se cadastrou
segment	string (obrigatório)	Segmento do cliente dentro da insituição (ex.: premium, gold)

Existem os seguintes enumeradores para tipo de telefone: inbound_sales, app, website, call_center e branch

Objeto Address

Request Body

{
  "street": "Rua do Teste",
  "number": "111",
  "neighbourhood": "Bairro do Exemplo",
  "city": "Aparecida de Goiânia",
  "uf": "GO",
  "complement": "Térreo",
  "postal_code": "00000-000",
  "country": "BRA"
}

O objeto address é utilizado para representar endereços em toda a API, endereços no território brasileiro são representados da seguinte maneira:

nome	tipo	descrição
street	string (obrigatório)	Rua do endereço, incluindo o logradouro, evitando, se possível, abreviações.
number	string (obrigatório)	Número do imóvel, incluindo letras caso possua.
neighbourhood	string (obrigatório)	Bairro, sem abreviações. e.g.: Santa Felicidade
city	string (obrigatório)	Nome completo da cidade, sem abreviações
uf	string (obrigatório)	A unidade federativa, com duas letras maiúsculas. e.g.: SP
complement	string	Quaisquer complementos para localizar o imóvel. e.g.: Apartamento 101, Conjunto 12
postal_code	string (obrigatório)	O código postal da localidade, contendo o hífen.
country	string (obrigatório)	Código ISO 3166-1 alfa-3 do país do endereço.

No caso dos endereços cujo país não seja Brasil ("BRA"), o postal_code e a unidade federativa poderão ser preenchidos livremente.

Objeto Phone

Request Body

{
  "international_dial_code": "1",
  "area_code": "11",
  "number": "999999999",
  "type": "mobile"
}

Um objeto phone representa um número telefônico, dentro ou fora do Brasil e sua classificação. Para isso, os campos são:

nome	tipo	descrição
international_dial_code	string (obrigatório)	Código de discagem internacional, sem zero ou +, somente números
area_code	string (obrigatório)	Código de área, sem zero, somente números
number	string (obrigatório)	Número do telefone, sem o hífen
type	enum (obrigatório)	Tipo de número: celular, residencial, comercial, etc.

Existem os seguintes enumeradores para tipo de telefone: residential, commercial e mobile.

Objeto Account

Request Body

{
    "participant": "17315359",
    "branch": "0000",
    "account_number": "10442",
    "account_digit": "6",
    "account_type": "CACC",
    "opening_date": "2020-01-15T18:00:00-03:00"
}

Objeto que representa os dados de uma conta.

nome	tipo	descrição
participant	string (obrigatório)	ISPB da instituição detentora da conta
branch	string (obrigatório)	Agência da Conta
account_number	string (obrigatório)	Número da Conta sem o dígito
account_digit	string (obrigatório)	Dígito da conta
account_type	enum (obrigatório)	Tipo da conta de origem, possíveis valores: "CACC", "SLRY" e "SVGS"
opening_date	datetime	Data de abertura da conta.

Objeto Source

Request Body

{
    "channel": "app",
    "platform": "android",
    "ip":"255.201.26.1",
    "session_id": "54b8e3cf-15de-41e5-9305-0ecf059d6e2a"
}

O objeto source representa o conjunto de informações da plataforma utilizada pelo usuário para realizar a operação. Os campos são:

nome	tipo	descrição
channel	string	Canal utilizado pelo usuário para realizar a operação, ex.: internet banking, app
platform	string	Plataforma utilizada pela aplicação
ip	string	IP coletado do device
session_id	string	Identificador único da sessão, utilizado para fazer o cruzamento do Device Scan com o evento em questão

Objeto Dict Key

Request Body

  {
    "key_type": "cpf",
    "key_value": "09991222669",
    "assignment_date": "2020-01-15T18:00:00-03:00"
  }

O objeto dict_key é utilizado para representar os dados da chave de vínculo no DICT do cliente, seja ele o recebedor ou o pagador da transação. Os campos desse objeto são:

nome	tipo	descrição
key_type	string (obrigatório)	Enumerador que contém o tipo da chave de vinculo no DICT.
key_value	string	Contém a chave de vínculo cadastrada no DICT.
assignment_date	datetime	Data que a chave de vínculo foi cadastrada no DICT.

Os enumeradores para o campo key_type são os mesmos definidos na API do DICT: cpf,cnpj,email,phone e evp.

Objeto Destination Statistics

Request Body

{
  "account":{
      "settlements":{
          "d3":4,
          "d30":67,
          "m6":618
      },
      "rejected":{
          "d3":4,
          "d30":67,
          "m6":618
      },
      "reported_frauds":{
          "d3":0,
          "d30":0,
          "m6":0
      },
      "reported_aml_cft":{
          "d3":0,
          "d30":0,
          "m6":0
      },
      "confirmed_frauds":{
          "d3":0,
          "d30":0,
          "m6":0
      },
      "confirmed_aml_cft":{
          "d3":0,
          "d30":0,
          "m6":0
      }
  },
  "owner":{
      "settlements":{
          "d3":6,
          "d30":88,
          "m6":996
      },
      "rejected":{
          "d3":4,
          "d30":67,
          "m6":618
      },
      "reported_frauds":{
          "d3":0,
          "d30":0,
          "m6":0
      },
      "reported_aml_cft":{
          "d3":0,
          "d30":0,
          "m6":0
      },
      "confirmed_frauds":{
          "d3":0,
          "d30":0,
          "m6":0
      },
      "confirmed_aml_cft":{
          "d3":0,
          "d30":0,
          "m6":0
      }
  },
  "key":{
      "settlements":{
          "d3":3,
          "d30":51,
          "m6":312
      },
      "rejected":{
          "d3":4,
          "d30":67,
          "m6":618
      },
      "reported_frauds":{
          "d3":0,
          "d30":0,
          "m6":0
      },
      "reported_aml_cft":{
          "d3":0,
          "d30":0,
          "m6":0
      },
      "confirmed_frauds":{
          "d3":0,
          "d30":0,
          "m6":0
      },
      "confirmed_aml_cft":{
          "d3":0,
          "d30":0,
          "m6":0
      }
  }
}

Para que o risco de fraude em uma transação seja avaliado com maior precisão, é necessário informar o histórico transacional e de fraudes do creditado através do objeto Destination Statistics. Tais dados podem ser obtidos ao se consultar a chave de vinculo do creditado na base de dados do DICT. É exigência do BACEN que esses dados sejam utilizados na avaliação de fraude das transações.

nome	tipo	descrição
account	account (obrigatório)	Objeto que contém o histórico transacional e de fraudes da conta do creditado.
owner	owner (obrigatório)	Objeto que contém o histórico transacional e de fraudes associados ao documento do creditado.
key	key (obrigatório)	Objeto que contém o histórico transacional e de fraudes associados a chave fornecida pelo creditado.

Onde cada um dos objetos definidos acima possui os mesmos campos:

nome	tipo	descrição
settlements	settlements (obrigatório)	Objeto que contém o histórico transacional.
rejected	rejected (opcional)	Objeto que contém o histórico de operações negadas.
reported_frauds	reported_frauds (obrigatório)	Objeto que contém o histórico de relatos de fraudes.
reported_aml_cft	reported_aml_cft (opcional)	Objeto que contém o histórico de relatos de PLD/FT.
confirmed_frauds	confirmed_frauds (obrigatório)	Objeto que contém o histórico de relatos de fraudes confirmados.
confirmed_aml_cft	confirmed_aml_cft (opcional)	Objeto que contém o histórico de relatos de PLD/FT confirmados.

Onde cada um desses objetos contém os campos d3, d30 e m6, contendo o número de ocorrências nos ultimos 3 dias, 30 dias e 6 meses, que são campos obrigatórios, respectivamente. Da mesma forma que é definido pela API do DICT do BCB.

Objeto Client​

Objeto Address​

Objeto Phone​

Objeto Account​

Objeto Source​

Objeto Dict Key​

Objeto Destination Statistics​

Objeto Client

Objeto Address

Objeto Phone

Objeto Account

Objeto Source

Objeto Dict Key

Objeto Destination Statistics