注册您的客户

本页面将引导您完成以下步骤,以注册和取消注册各方以创建预测结果:

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

准备工作

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

如需使模型能够创建风险得分预测,您必须先注册各方。如果您具备以下条件,我们建议您注册各方:

何时注册合作方

您需要先注册某一方,然后才能为某个数据集中的某一方创建预测。训练、调整或回测不需要注册。

预测结果用于在生产或测试/并行阶段调查客户的洗钱活动。

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

如何准备政党登记表

如需了解如何注册各方,请参阅价格页面

为您要注册接收方的业务线准备表格。 如果您已注册了某些各方,则此参与方注册表可以包含 Party 表中您希望用于预测结果的部分各方。

零售方架构

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

商业方架构

类型说明
party_idSTRING实例数据集中一方的唯一标识符
party_sizeSTRING 请求的就餐人数。层级基于该方在过去 365 天内的平均每月交易次数:
  • 对于平均每月交易次数低于 500 笔的小型商业交易方,SMALL
  • 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
  • INSTANCE_ID:用户定义的实例标识符
  • BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME:一个 BigQuery 数据集,其中包含描述注册方的表
  • PARTY_REGISTRATION_TABLE:列出已注册方的表
  • UPDATE_MODE:使用 REPLACE 将注册方表中可移除的各方替换为新方,或使用 APPEND 将新方添加到注册方表中
  • LINE_OF_BUSINESS:此字段必须与引擎配置所用引擎版本中的 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": CREATE_TIME,
    "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 此操作未能移除的各方数

如何取消注册各方

每个 AML AI 实例使用相同的 projects.locations.instances.importRegisteredParties 方法并替换现有的合作方列表,取消注册各方。将 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
  • 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": CREATE_TIME,
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "exportRegisteredParties",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

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

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

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

所有值都区分大小写。

earliest_remove_timeSTRING可以删除当事方的最早时间
party_with_prediction_intentSTRING表明自注册以来是否预计会参加该派对的指示符
registration_or_uptier_timeSTRING方注册或升级的时间