curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/report-templates/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"name": "US SAR default", "jurisdiction": "US", "report_type": "SAR", "field_config": {"rentity_id": "FIU-US-00123", "submission_code": "E", "currency_code_local": "USD"}}'from didit import Didit
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
client = Didit()
result = client.report_templates.create(
name="US SAR default",
jurisdiction="US",
report_type="SAR",
field_config={"rentity_id": "FIU-US-00123", "submission_code": "E", "currency_code_local": "USD"},
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
const didit = new Didit();
const result = await didit.reportTemplates.create({
name: "US SAR default",
jurisdiction: "US",
report_type: "SAR",
field_config: { rentity_id: "FIU-US-00123", submission_code: "E", currency_code_local: "USD" },
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
client := didit.NewClient()
result, err := client.ReportTemplates.Create(ctx, didit.ReportTemplatesCreateParams{
Name: "US SAR default",
Jurisdiction: "US",
ReportType: "SAR",
FieldConfig: didit.Some(map[string]any{"rentity_id": "FIU-US-00123", "submission_code": "E", "currency_code_local": "USD"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.Map;
import me.didit.Didit;
import me.didit.types.ReportTemplatesCreateParams;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
Didit client = new Didit();
var result = client.reportTemplates().create(ReportTemplatesCreateParams.builder()
.name("US SAR default")
.jurisdiction("US")
.reportType(ReportTemplatesCreateParams.ReportType.of("SAR"))
.fieldConfig(Map.of("rentity_id", "FIU-US-00123", "submission_code", "E", "currency_code_local", "USD"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
$didit = new DiditClient();
$result = $didit->reportTemplates->create([
'name' => 'US SAR default',
'jurisdiction' => 'US',
'report_type' => 'SAR',
'field_config' => ['rentity_id' => 'FIU-US-00123', 'submission_code' => 'E', 'currency_code_local' => 'USD'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
didit = Didit::Client.new
result = didit.report_templates.create(
name: "US SAR default",
jurisdiction: "US",
report_type: "SAR",
field_config: { rentity_id: "FIU-US-00123", submission_code: "E", currency_code_local: "USD" }
)
puts result.to_husing System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
using var client = new DiditClient();
var result = await client.ReportTemplates.CreateAsync(new ReportTemplatesCreateParams
{
Name = "US SAR default",
Jurisdiction = "US",
ReportType = "SAR",
FieldConfig = new Dictionary<string, object> { ["rentity_id"] = "FIU-US-00123", ["submission_code"] = "E", ["currency_code_local"] = "USD" },
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"jurisdiction": "<string>",
"report_type": "SAR",
"report_type_display": "<string>",
"field_config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"errors": [
"<string>"
]
}Criar modelo de relatório via API
Crie no Didit um modelo reutilizável de cabeçalho de relatório goAML por jurisdição, validado contra campos obrigatórios antes do uso.
curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/report-templates/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"name": "US SAR default", "jurisdiction": "US", "report_type": "SAR", "field_config": {"rentity_id": "FIU-US-00123", "submission_code": "E", "currency_code_local": "USD"}}'from didit import Didit
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
client = Didit()
result = client.report_templates.create(
name="US SAR default",
jurisdiction="US",
report_type="SAR",
field_config={"rentity_id": "FIU-US-00123", "submission_code": "E", "currency_code_local": "USD"},
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
const didit = new Didit();
const result = await didit.reportTemplates.create({
name: "US SAR default",
jurisdiction: "US",
report_type: "SAR",
field_config: { rentity_id: "FIU-US-00123", submission_code: "E", currency_code_local: "USD" },
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
client := didit.NewClient()
result, err := client.ReportTemplates.Create(ctx, didit.ReportTemplatesCreateParams{
Name: "US SAR default",
Jurisdiction: "US",
ReportType: "SAR",
FieldConfig: didit.Some(map[string]any{"rentity_id": "FIU-US-00123", "submission_code": "E", "currency_code_local": "USD"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.Map;
import me.didit.Didit;
import me.didit.types.ReportTemplatesCreateParams;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
Didit client = new Didit();
var result = client.reportTemplates().create(ReportTemplatesCreateParams.builder()
.name("US SAR default")
.jurisdiction("US")
.reportType(ReportTemplatesCreateParams.ReportType.of("SAR"))
.fieldConfig(Map.of("rentity_id", "FIU-US-00123", "submission_code", "E", "currency_code_local", "USD"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
$didit = new DiditClient();
$result = $didit->reportTemplates->create([
'name' => 'US SAR default',
'jurisdiction' => 'US',
'report_type' => 'SAR',
'field_config' => ['rentity_id' => 'FIU-US-00123', 'submission_code' => 'E', 'currency_code_local' => 'USD'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
didit = Didit::Client.new
result = didit.report_templates.create(
name: "US SAR default",
jurisdiction: "US",
report_type: "SAR",
field_config: { rentity_id: "FIU-US-00123", submission_code: "E", currency_code_local: "USD" }
)
puts result.to_husing System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
using var client = new DiditClient();
var result = await client.ReportTemplates.CreateAsync(new ReportTemplatesCreateParams
{
Name = "US SAR default",
Jurisdiction = "US",
ReportType = "SAR",
FieldConfig = new Dictionary<string, object> { ["rentity_id"] = "FIU-US-00123", ["submission_code"] = "E", ["currency_code_local"] = "USD" },
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"jurisdiction": "<string>",
"report_type": "SAR",
"report_type_display": "<string>",
"field_config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"errors": [
"<string>"
]
}rentity_id, submission_code, currency_code_local), tanto na criação quanto novamente sempre que for editado. Os campos de cabeçalho específicos de cada declaração, como action e submission_date, são exigidos quando o próprio relatório é validado ou finalizado, e não no modelo.
Relacionados
Autorizações
Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.
Parâmetros de caminho
UUID da organização.
UUID da aplicação.
Corpo
Código de país ISO 3166-1 alpha-2, convertido para maiúsculas ao salvar.
2SAR, STR, CTR, TTR, UTR, IFT, CBR, TFR Padrões reutilizáveis de cabeçalho do goAML. Campos obrigatórios no nível do modelo: rentity_id, submission_code e currency_code_local (3 letras). Opcionais: enabled_fields (quais blocos opcionais do relatório incluir), além dos padrões de reporting_person, location, reason e action. Os campos de cabeçalho por envio (action, submission_date, transactions, jurisdiction) são exigidos quando o relatório é validado ou finalizado, não no modelo.
Resposta
Modelo criado.
Código de país ISO 3166-1 alpha-2.
2SAR, STR, CTR, TTR, UTR, IFT, CBR, TFR Padrões reutilizáveis de cabeçalho do goAML. Campos obrigatórios no nível do modelo: rentity_id, submission_code e currency_code_local (3 letras). Opcionais: enabled_fields (quais blocos opcionais do relatório incluir), além dos padrões de reporting_person, location, reason e action. Os campos de cabeçalho por envio (action, submission_date, transactions, jurisdiction) são exigidos quando o relatório é validado ou finalizado, não no modelo.