共享对象

大量数据在账户的不同事件之间共享。以下可以方便地找到这些对象的定义。

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é"
}

表示账户持有人数据的对象。

名称	类型	描述
type	枚举（必填）	客户类型："natural_person" 或 "legal_person"
document_number	string （必填）	文件编号，符合标准化部分
name	string （必填）	客户姓名
email	string	客户电子邮件
address	address	客户地址数据
phone	phone	客户电话数据
sales_channel	枚举（必填）	客户注册的渠道
segment	string （必填）	客户在机构内的细分（例如：premium、gold）

电话类型的枚举值为：inbound_sales、app、website、call_center 和 branch

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"
}

address 对象用于在整个 API 中表示地址，巴西境内地址的表示方式如下：

名称	类型	描述
street	string （必填）	地址的街道，包括公路名称，尽可能避免缩写。
number	string （必填）	物业编号，如有字母则包含字母。
neighbourhood	string （必填）	区域，不缩写。例如：Santa Felicidade
city	string （必填）	城市全名，不缩写
uf	string （必填）	联邦单位，两个大写字母。例如：SP
complement	string	用于定位物业的任何补充信息。例如：Apartamento 101, Conjunto 12
postal_code	string （必填）	该地点的邮政编码，含连字符。
country	string （必填）	地址国家的 ISO 3166-1 alpha-3 代码。

对于国家不是巴西（"BRA"）的地址，postal_code 和联邦单位可以自由填写。

Phone 对象

Request Body

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

phone 对象表示巴西境内或境外的电话号码及其分类。字段如下：

名称	类型	描述
international_dial_code	string （必填）	国际拨号代码，不含零或加号，仅数字
area_code	string （必填）	区号，不含零，仅数字
number	string （必填）	电话号码，不含连字符
type	枚举（必填）	号码类型：手机、住宅、商务等。

电话类型的枚举值为：residential、commercial 和 mobile。

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"
}

表示账户数据的对象。

名称	类型	描述
participant	string （必填）	账户所属机构的 ISPB
branch	string （必填）	账户支行
account_number	string （必填）	不含校验位的账户号码
account_digit	string （必填）	账户校验位
account_type	枚举（必填）	来源账户类型，可能值："CACC"、"SLRY" 和 "SVGS"
opening_date	datetime	账户开户日期。

Source 对象

Request Body

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

source 对象表示用户用于执行操作的平台信息集合。字段如下：

名称	类型	描述
channel	string	用户执行操作使用的渠道，例如：网银、app
platform	string	应用程序使用的平台
ip	string	从设备收集的 IP
session_id	string	会话的唯一标识符，用于将 Device Scan 与相关事件关联

Dict Key 对象

Request Body

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

dict_key 对象用于表示客户（无论是收款人还是付款人）在 DICT 中的绑定密钥数据。该对象的字段为：

名称	类型	描述
key_type	string （必填）	包含 DICT 中绑定密钥类型的枚举值。
key_value	string	包含在 DICT 中注册的绑定密钥。
assignment_date	datetime	绑定密钥在 DICT 中注册的日期。

key_type 字段的枚举值与 DICT API 中定义的相同：cpf、cnpj、email、phone 和 evp。

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
      }
  }
}

为了更准确地评估交易中的欺诈风险，需要通过 Destination Statistics 对象提供被入账方的交易和欺诈历史。此类数据可通过在 DICT 数据库中查询被入账方的绑定密钥获得。BACEN 要求在交易欺诈评估中使用这些数据。

名称	类型	描述
account	account （必填）	包含被入账方账户交易和欺诈历史的对象。
owner	owner （必填）	包含与被入账方文件关联的交易和欺诈历史的对象。
key	key （必填）	包含与被入账方提供的密钥关联的交易和欺诈历史的对象。

上述每个对象具有相同的字段：

名称	类型	描述
settlements	settlements （必填）	包含交易历史的对象。
rejected	rejected （可选）	包含被拒绝操作历史的对象。
reported_frauds	reported_frauds （必填）	包含欺诈举报历史的对象。
reported_aml_cft	reported_aml_cft （可选）	包含 PLD/FT 举报历史的对象。
confirmed_frauds	confirmed_frauds （必填）	包含已确认欺诈举报历史的对象。
confirmed_aml_cft	confirmed_aml_cft （可选）	包含已确认 PLD/FT 举报历史的对象。

其中每个对象包含 d3、d30 和 m6 字段，分别包含过去 3 天、30 天和 6 个月的发生次数，均为必填字段。与 BCB DICT API 定义的方式相同。

Client 对象​

Address 对象​

Phone 对象​

Account 对象​

Source 对象​

Dict Key 对象​

Destination Statistics 对象​

Client 对象

Address 对象

Phone 对象

Account 对象

Source 对象

Dict Key 对象

Destination Statistics 对象