Esta página foi traduzida pela API Cloud Translation.

Registre seus clientes

Nesta página, você encontra as etapas a seguir para registrar e cancelar o registro de partes e, assim, criar resultados de previsão:

Confira se você está pronto para registrar as partes
Prepare as tabelas de registro de festa
Use o método projects.locations.instances.importRegisteredParties para registrar ou cancelar o registro de partes.
Validar a resposta do método
(Opcional) Exportar uma tabela de partes registradas

Antes de começar

Antes de começar, você precisa de uma instância da IA antilavagem de dinheiro.

Para permitir que um modelo crie previsões de pontuação de risco, primeiro é necessário registrar as partes. Recomendamos que você registre as partes quando já tiver o seguinte:

Um ou mais conjuntos de dados
Um modelo ajustado, treinado e testado com backtest

Quando registrar partes

Antes de criar previsões para uma parte em um de seus conjuntos de dados, você precisa registrá-la. O registro não é necessário para treinamento, ajuste ou backtesting.

Os resultados da Prediction são usados na investigação de clientes para lavagem de dinheiro na fase de produção ou teste/paralela.

As partes registradas geram outros custos mensais por parte registrada. Consulte a página de preços para mais informações.

Como preparar tabelas de registro de festa

Leia a página de preços para informações sobre o registro de partes.

Prepare uma tabela para a linha de negócios em que você quer registrar partes. Se você já tiver algumas partes registradas, essa tabela de registro poderá conter um subconjunto das partes da tabela Party que você quer usar para os resultados da previsão.

Esquema das partes varejistas

Coluna	Tipo	Descrição
`party_id`	`STRING`	Identificador exclusivo da parte nos conjuntos de dados da instância
`party_size`	`STRING`	NULL; o conteúdo é ignorado em registros de terceiros de varejo.

Esquema de partes comerciais

Coluna Tipo Descrição

party_id STRING Identificador exclusivo da parte nos conjuntos de dados da instância

party_size

STRING

Tamanho do grupo solicitado. O nível é baseado no número médio de transações mensais da parte nos 365 dias anteriores:

SMALL para pequenas partes comerciais com menos de 500 transações mensais em média
LARGE para grandes partes comerciais com uma média de mais de 500 transações mensais

Todos os valores diferenciam maiúsculas de minúsculas.

Como registrar partes

As partes são registradas separadamente para cada instância da IA antilavagem de dinheiro. Observações:

As partes comerciais e de varejo precisam ser registradas separadamente. Use chamadas de API e tabelas de registro de terceiros separadas. Se uma das partes estiver em ambas as listas, elas serão consideradas registros separados.
As previsões exigem que todas as partes estejam registradas na linha de negócios associada à versão do mecanismo usada. Não será possível criar resultados de previsão se for usado um conjunto de dados que contenha qualquer parte não registrada com a mesma linha de negócios.
A tabela de registro de parte fornecida é usada para anexar à lista existente de partes registradas na instância ou substituir todas as partes registradas para a linha de negócios fornecida na instância.
Depois de registrada, não é possível cancelar o registro de uma parte por algum tempo. Consulte a página de preços. Por esse motivo, você pode definir o campo validateOnly como TRUE. Esse campo permite ver o efeito líquido e a resposta do método sem mudar as partes registradas. Depois da validação, é possível executar a operação novamente e definir o parâmetro validateOnly como FALSE.
Sempre verifique a resposta de uma solicitação de registro para garantir que todas as partes foram registradas com sucesso, mesmo que uma solicitação validateOnly anterior seja bem-sucedida.
Para registros de partes comerciais, um valor diferente de SMALL ou LARGE no campo party_size da tabela de registro da parte aciona um erro (Invalid party_size present in table). As partes registradas não são atualizadas.
Para registros de parte de varejo, o campo party_size é ignorado, e todas as partes na tabela de registro de parte fornecida são registradas.

Para importar partes registradas, use o método projects.locations.instances.importRegisteredParties.

As informações a seguir também estão disponíveis em Criar e gerenciar instâncias.

Antes de usar os dados da solicitação, faça as substituições a seguir:

PROJECT_ID: o ID do projeto do Google Cloud listado nas Configurações do IAM
LOCATION: o local da instância. Use uma das regiões compatíveis:
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
INSTANCE_ID: o identificador definido pelo usuário para a instância.
BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME: um conjunto de dados do BigQuery que contém uma tabela que descreve as partes registradas
REGISTERED_PARTIES_TABLE: a tabela que lista as partes registradas
Observação: é possível fornecer várias tabelas que listem as partes registradas. Use o formato "bq://{project}.{bqDatasetID}.{bqTableID}" para cada tabela na matriz partyTables.
UPDATE_MODE: use REPLACE para substituir as partes removíveis na tabela de partes registradas por novas ou use APPEND para adicionar novas partes à tabela de partes registradas.
LINE_OF_BUSINESS: este campo precisa corresponder ao valor lineOfBusiness na versão do mecanismo usada pela configuração do mecanismo. Use COMMERCIAL para clientes de bancos comerciais (pessoas jurídicas e naturais) ou use RETAIL para clientes de bancos de varejo.

Solicitar corpo JSON:

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

Para enviar a solicitação, escolha uma destas opções:

curl

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo chamado request.json. Execute o comando a seguir no terminal para criar ou substituir esse arquivo no diretório atual:

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

Depois execute o comando a seguir para enviar a solicitação 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

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo chamado request.json. Execute o comando a seguir no terminal para criar ou substituir esse arquivo no diretório atual:

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

Depois execute o comando a seguir para enviar a solicitação 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

Você receberá uma resposta JSON semelhante a esta:

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

Para informações sobre como conseguir o resultado da operação de longa duração (LRO, na sigla em inglês), consulte Gerenciar operações de longa duração.

Resposta do registro

Quando a LRO é concluída, a resposta indica o número de partes que foram adicionadas, removidas ou atualizadas pela operação.

Campo de resposta	Tipo	Descrição
`partiesAdded`	`integer`	Número de partes adicionadas por esta operação
`partiesRemoved`	`integer`	Número de partes removidas por esta operação
`partiesTotal`	`integer`	Número total de partes registradas nesta instância, após a conclusão da operação de atualização
`partiesUptiered`	`integer`	Número total de partes comerciais de pequeno a grande porte
`partiesDowntiered`	`integer`	Número total de partes comerciais que foram reduzidas de grandes para pequenas
`partiesFailedToDowntier`	`integer`	Número total de partes comerciais que não reduziram o número de partes comerciais, de grande para pequeno
`partiesFailedToRemove`	`integer`	Número de partes que não foram removidas por esta operação

Como cancelar o registro de partes

As partes são canceladas por instância de IA antilavagem de dinheiro usando o mesmo método projects.locations.instances.importRegisteredParties e substituindo a lista atual de partes. Defina o campo mode como REPLACE. Essa configuração cancela o registro das partes atualmente registradas (para a linha de negócios fornecida) que não fazem parte da tabela de registro fornecida.

Respostas de cancelamento de registro

Após a conclusão da operação, verifique a resposta da API para saber se gerou o resultado pretendido em termos de número de partes adicionadas ou removidas e número total de partes registradas.

A resposta da API também retorna o número de partes que não puderam ser removidas devido a restrições (por exemplo, devido ao número mínimo de dias antes que uma parte possa ser cancelada).

Exportar partes registradas

Para exportar partes registradas, use o método projects.locations.instances.exportRegisteredParties.

As informações a seguir também estão disponíveis em Criar e gerenciar instâncias.

Antes de usar os dados da solicitação, faça as substituições a seguir:

PROJECT_ID: o ID do projeto do Google Cloud listado nas Configurações do IAM
LOCATION: o local da instância. Use uma das regiões compatíveis:
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
INSTANCE_ID: o identificador definido pelo usuário para a instância.
BQ_OUTPUT_DATASET_NAME: um conjunto de dados do BigQuery para exportar uma tabela que descreve as partes registradas
REGISTERED_PARTIES_TABLE: a tabela em que as partes registradas serão gravadas.
WRITE_DISPOSITION: a ação que ocorrerá se a tabela de destino já existir. Use um dos seguintes valores:
- WRITE_EMPTY: só exporta dados se a tabela do BigQuery estiver vazia.
- WRITE_TRUNCATE: apague todos os dados atuais na tabela do BigQuery antes de gravar nela.
LINE_OF_BUSINESS: use COMMERCIAL para clientes de bancos comerciais (pessoas jurídicas e naturais) ou use RETAIL para clientes de bancos de varejo

Solicitar corpo JSON:

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

Para enviar a solicitação, escolha uma destas opções:

curl

Salve o corpo da solicitação em um arquivo chamado request.json. Execute o comando a seguir no terminal para criar ou substituir esse arquivo no diretório atual:

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

Depois execute o comando a seguir para enviar a solicitação 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

Salve o corpo da solicitação em um arquivo chamado request.json. Execute o comando a seguir no terminal para criar ou substituir esse arquivo no diretório atual:

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

Depois execute o comando a seguir para enviar a solicitação 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

Você receberá uma resposta JSON semelhante a esta:

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

Para informações sobre como conseguir o resultado da operação de longa duração (LRO, na sigla em inglês), consulte Gerenciar operações de longa duração.

Esse método gera uma tabela do BigQuery com o seguinte esquema:

Coluna	Tipo	Descrição
`party_id`	`STRING`	Identificador exclusivo da parte nos conjuntos de dados da instância
`party_size`	`STRING`	Especifica o nível para clientes comerciais (grande versus pequeno). Esse campo não se aplica a clientes de varejo. `NULL` para todos os clientes de varejo `SMALL` para pequenas partes comerciais com menos de 500 transações mensais em média `LARGE` para grandes partes comerciais com uma média de mais de 500 transações mensais Todos os valores diferenciam maiúsculas de minúsculas.
`earliest_remove_time`	`STRING`	O primeiro momento em que o grupo pode ser removido
`party_with_prediction_intent`	`STRING`	O indicador que sugere se um partido está previsto para desde o registro
`registration_or_uptier_time`	`STRING`	O momento em que a parte foi registrada ou atualizada