Skip to main content
POST
curl
Create a reusable goAML header template. A template must pass obligatory-field validation (rentity_id, submission_code, currency_code_local) to be saved, both on create and again whenever it is edited. Per-filing header fields such as action and submission_date are enforced when the report itself is validated or finalized, not on the template.

Authorizations

x-api-key
string
header
required

Path Parameters

organization_id
string<uuid>
required

Organization UUID.

application_id
string<uuid>
required

Application UUID.

Body

application/json
name
string
required
jurisdiction
string
required

ISO 3166-1 alpha-2 country code, upper-cased on save.

Required string length: 2
report_type
enum<string>
required
Available options:
SAR,
STR,
CTR,
TTR,
UTR,
IFT,
CBR,
TFR
field_config
object

Reusable goAML header defaults. Template-level obligatory fields: rentity_id, submission_code, and currency_code_local (3-letter). Optional: enabled_fields (which optional report blocks to include) plus reporting_person, location, reason, and action defaults. Per-filing header fields (action, submission_date, transactions, jurisdiction) are enforced when the report is validated or finalized, not on the template.

Response

Template created.

uuid
string<uuid>
name
string
jurisdiction
string

ISO 3166-1 alpha-2 country code.

Required string length: 2
report_type
enum<string>
Available options:
SAR,
STR,
CTR,
TTR,
UTR,
IFT,
CBR,
TFR
report_type_display
string
field_config
object

Reusable goAML header defaults. Template-level obligatory fields: rentity_id, submission_code, and currency_code_local (3-letter). Optional: enabled_fields (which optional report blocks to include) plus reporting_person, location, reason, and action defaults. Per-filing header fields (action, submission_date, transactions, jurisdiction) are enforced when the report is validated or finalized, not on the template.

created_at
string<date-time>
updated_at
string<date-time>