Saltar para o conteúdo principal
POST
curl
Crie um modelo de cabeçalho goAML reutilizável. Um modelo tem de passar na validação de campos obrigatórios (rentity_id, submission_code, currency_code_local) para ser guardado, tanto na criação como sempre que for editado. Os campos de cabeçalho específicos de cada submissão, como action e submission_date, são validados quando o relatório é validado ou finalizado, e não no modelo.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. 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 guardar.

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

Predefinições de cabeçalho goAML reutilizáveis. Campos obrigatórios ao nível do modelo: rentity_id, submission_code e currency_code_local (3 letras). Opcional: enabled_fields (que blocos de relatório opcionais incluir) mais predefinições de reporting_person, location, reason e action. Os campos de cabeçalho por submissão (action, submission_date, transactions, jurisdiction) são obrigatórios 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

Predefinições de cabeçalho goAML reutilizáveis. Campos obrigatórios ao nível do modelo: rentity_id, submission_code e currency_code_local (3 letras). Opcional: enabled_fields (que blocos de relatório opcionais incluir) mais predefinições de reporting_person, location, reason e action. Os campos de cabeçalho por submissão (action, submission_date, transactions, jurisdiction) são obrigatórios 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 7 de novembro de 2026