注册客户

本页将引导您完成以下步骤,以注册和取消注册相关方,以便生成预测结果:

  1. 确保您已做好注册派对的准备
  2. 准备政党注册表
  3. 使用 projects.locations.instances.importRegisteredParties 方法注册或取消注册相关方
  4. 验证方法响应
  5. (可选)导出已注册政党的表格

准备工作

开始之前,您需要有一个 AML AI 实例

若要让模型生成风险评分预测,您必须先注册相关方。我们建议您在满足以下条件时注册派对:

何时注册对方

您必须先注册数据集中的党派,然后才能为其创建预测。无需注册即可进行训练、调优或回测。

预测结果用于在生产或测试(并行)阶段调查客户是否在进行洗钱活动。您还可以根据从预测中获得的结果,构建自己的治理和模型分析流程。

注册各方会产生额外的每月费用(如需了解详情,请参阅价格页面)。

如何准备政党注册表

如需了解如何注册派对,请参阅价格页面

为您要为其注册相关方所属的业务领域准备一个表格。 如果您已注册一些政党,则此政党注册表可能包含您要用于预测结果的 Party 表中的部分政党。

Retail 方架构

类型说明
party_idSTRING实例数据集中相关方方的唯一标识符
party_sizeSTRINGNULL;系统会忽略零售方注册内容

商业实体架构

类型说明
party_idSTRING实例数据集中相关方的唯一标识符
party_sizeSTRING 请求的人数。层级取决于相应方在过去 365 天内的每月平均交易次数:
  • SMALL - 每月平均交易量低于 500 笔的小型商业实体
  • LARGE(适用于平均每月交易量等于或高于 500 笔的大型商业实体)

所有值都区分大小写。

如何注册派对

系统会为每个 AML AI 实例单独注册相关方。注意事项:

  • 零售方和商业方必须单独注册。使用单独的 API 调用和单独的派对注册表。如果某方同时出现在两个名单中,则会被视为两次单独的注册。
  • 若要使用预测功能,所有相关方都必须注册与所用引擎版本关联的业务领域如果使用的任何数据集包含未注册相同业务领域的任何方,则无法创建预测结果。
  • 提供的相关方注册表用于附加到实例中现有的已注册相关方的列表,或替换实例中所提供业务领域的所有已注册相关方。
  • 派对一经注册,便无法在一定时间内取消注册(请参阅价格页面)。因此,您可以将 validateOnly 字段设置为 TRUE。通过此字段,您无需更改注册的相关方,即可查看该方法的净效应和响应。验证完毕后,您可以重新运行该操作,并将 validateOnly 参数设置为 FALSE
  • 请务必检查注册请求的响应,确保所有方均已成功注册,即使之前的 validateOnly 请求成功也是如此。
  • 对于商业实体注册,如果实体注册表中的 party_size 字段中的值不是 SMALLLARGE,则会触发错误 (Invalid party_size present in table)。系统不会更新已注册的实体。
  • 对于零售方注册,系统会忽略 party_size 字段,并注册所提供的方注册表中的所有方。

如需导入已注册的相关方,请使用 projects.locations.instances.importRegisteredParties 方法。

(您也可以参阅创建和管理实例了解以下信息。)

在使用任何请求数据之前,请先进行以下替换:

  • PROJECT_IDIAM 设置中列出的 Google Cloud 项目 ID
  • LOCATION:实例的位置;请使用某个受支持的地区
    显示位置
    • us-central1
    • us-east1
    • asia-south1
    • europe-west1
    • europe-west2
    • europe-west4
    • northamerica-northeast1
    • southamerica-east1
    • australia-southeast1
  • INSTANCE_ID:实例的用户定义标识符
  • BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME:一个 BigQuery 数据集,其中包含用于描述已注册方的表
  • PARTY_REGISTRATION_TABLE:列出已注册的相关方的表
  • UPDATE_MODE:使用 REPLACE 将“已注册的方”表中可移除的方替换为新方,或使用 APPEND 将新方添加到“已注册的方”表
  • LINE_OF_BUSINESS:此字段必须与 engine config 使用的引擎版本中的 lineOfBusiness 值一致;对于商业银行客户(法人和自然人),请使用 COMMERCIAL;对于零售银行客户,请使用 RETAIL

请求 JSON 正文:

{
  "partyTables": [
     "bq://PROJECT_ID.BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME.PARTY_REGISTRATION_TABLE"
  ],
  "mode": "UPDATE_MODE",
  "lineOfBusiness": "LINE_OF_BUSINESS"
}

如需发送请求,请选择以下方式之一:

curl

将请求正文保存在名为 request.json 的文件中。在终端中运行以下命令,在当前目录中创建或覆盖此文件:

cat > request.json << 'EOF'
{
  "partyTables": [
     "bq://PROJECT_ID.BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME.PARTY_REGISTRATION_TABLE"
  ],
  "mode": "UPDATE_MODE",
  "lineOfBusiness": "LINE_OF_BUSINESS"
}
EOF

然后,执行以下命令以发送 REST 请求:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID:importRegisteredParties"

PowerShell

将请求正文保存在名为 request.json 的文件中。在终端中运行以下命令,在当前目录中创建或覆盖此文件:

@'
{
  "partyTables": [
     "bq://PROJECT_ID.BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME.PARTY_REGISTRATION_TABLE"
  ],
  "mode": "UPDATE_MODE",
  "lineOfBusiness": "LINE_OF_BUSINESS"
}
'@  | Out-File -FilePath request.json -Encoding utf8

然后,执行以下命令以发送 REST 请求:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID:importRegisteredParties" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
    "createTime": "2023-03-14T15:52:55.358979323Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "importRegisteredParties",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

如需了解如何获取长时间运行的操作 (LRO) 的结果,请参阅管理长时间运行的操作

注册响应

LRO 完成后,响应会指明该操作添加、移除或更新的相关方数量。

响应字段类型说明
partiesAddedinteger 此操作添加的相关方数量
partiesRemovedinteger 此操作移除的相关方数量
partiesTotalinteger 更新操作完成后,在此实例中注册的相关方总数
partiesUptieredinteger 从小型级别上调至大型级别的商业实体总数
partiesDowntieredinteger 从大型降级为小型商家的总数
partiesFailedToDowntierinteger 未能从大型级别降级为小型级别的商业实体总数
partiesFailedToRemoveinteger 此操作未能移除的相关方数量

如何取消注册派对

系统会使用相同的 projects.locations.instances.importRegisteredParties 方法为每个 AML AI 实例取消注册相关方,并替换现有的相关方列表。将 mode 字段设置为 REPLACE。此设置会取消注册目前已注册(针对所提供的业务领域)但不属于所提供的相关方注册表中的任何相关方。

注销响应

操作完成后,检查 API 响应,检查操作是否在添加或移除的相关方数量以及注册的相关方总数方面取得了预期结果。

API 响应还会返回因存在限制而无法移除的相关方数量;例如,客户必须等到最短天数过后才能取消注册。

导出已注册的相关方

如需导出已注册的相关方,请使用 projects.locations.instances.exportRegisteredParties 方法。

(您也可以参阅创建和管理实例了解以下信息。)

在使用任何请求数据之前,请先进行以下替换:

  • PROJECT_IDIAM 设置中列出的 Google Cloud 项目 ID
  • LOCATION:实例的位置;请使用某个受支持的地区
    显示位置
    • us-central1
    • us-east1
    • asia-south1
    • europe-west1
    • europe-west2
    • europe-west4
    • northamerica-northeast1
    • southamerica-east1
    • australia-southeast1
  • INSTANCE_ID:实例的用户定义标识符
  • BQ_OUTPUT_DATASET_NAME:用于导出描述已注册方的表的 BigQuery 数据集
  • PARTY_REGISTRATION_TABLE:要将已注册的相关方写入到的表
  • WRITE_DISPOSITION:如果目标表已存在,则发生的操作;请使用以下任一项:
    • WRITE_EMPTY:仅在 BigQuery 表为空时导出数据。
    • WRITE_TRUNCATE:在写入 BigQuery 表之前清空表中的所有现有数据。
  • LINE_OF_BUSINESS:对于商业银行客户(法人和自然人),请使用 COMMERCIAL;对于零售银行客户,请使用 RETAIL

请求 JSON 正文:

{
  "dataset": {
    "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.PARTY_REGISTRATION_TABLE",
    "writeDisposition": "WRITE_DISPOSITION"
  },
  "lineOfBusiness": "LINE_OF_BUSINESS"
}

如需发送请求,请选择以下方式之一:

curl

将请求正文保存在名为 request.json 的文件中。在终端中运行以下命令,在当前目录中创建或覆盖此文件:

cat > request.json << 'EOF'
{
  "dataset": {
    "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.PARTY_REGISTRATION_TABLE",
    "writeDisposition": "WRITE_DISPOSITION"
  },
  "lineOfBusiness": "LINE_OF_BUSINESS"
}
EOF

然后,执行以下命令以发送 REST 请求:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID:exportRegisteredParties"

PowerShell

将请求正文保存在名为 request.json 的文件中。在终端中运行以下命令,在当前目录中创建或覆盖此文件:

@'
{
  "dataset": {
    "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.PARTY_REGISTRATION_TABLE",
    "writeDisposition": "WRITE_DISPOSITION"
  },
  "lineOfBusiness": "LINE_OF_BUSINESS"
}
'@  | Out-File -FilePath request.json -Encoding utf8

然后,执行以下命令以发送 REST 请求:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID:exportRegisteredParties" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
    "createTime": "2023-03-14T15:52:55.358979323Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "exportRegisteredParties",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

如需了解如何获取长时间运行的操作 (LRO) 的结果,请参阅管理长时间运行的操作

此方法会输出具有以下架构的 BigQuery 表:

类型说明
party_idSTRING实例数据集中相关方的唯一标识符
party_sizeSTRING 指定商家客户的层级(大型与小型)。此字段不适用于零售客户。
  • NULL(适用于所有零售客户)
  • SMALL - 每月平均交易量低于 500 笔的小型商业实体
  • LARGE(适用于平均每月交易量等于或高于 500 笔的大型商业实体)

所有值都区分大小写。

earliest_remove_timeSTRING可以移除相关方的最早时间
party_with_prediction_intentSTRING指示自注册以来是否对某个派对进行了预测的指标
registration_or_uptier_timeSTRING对方注册或升级的时间