Pular para o conteúdo principal
POST
curl
Crie um modelo de cabeçalho goAML reutilizável. Para ser salvo, um modelo precisa passar na validação dos campos obrigatórios (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

x-api-key
string
header
obrigatório

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

organization_id
string<uuid>
obrigatório

UUID da organização.

application_id
string<uuid>
obrigatório

UUID da aplicação.

Corpo

application/json
name
string
obrigatório
jurisdiction
string
obrigatório

Código de país ISO 3166-1 alpha-2, convertido para maiúsculas ao salvar.

Required string length: 2
report_type
enum<string>
obrigatório
Opções disponíveis:
SAR,
STR,
CTR,
TTR,
UTR,
IFT,
CBR,
TFR
field_config
object

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.

uuid
string<uuid>
name
string
jurisdiction
string

Código de país ISO 3166-1 alpha-2.

Required string length: 2
report_type
enum<string>
Opções disponíveis:
SAR,
STR,
CTR,
TTR,
UTR,
IFT,
CBR,
TFR
report_type_display
string
field_config
object

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.

created_at
string<date-time>
updated_at
string<date-time>
Última modificação em 1 de novembro de 2026