> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# Crear plantilla d'informe API
> Crea una plantilla d'encapçalament d'informe goAML reutilitzable per jurisdicció, validada contra els camps obligatoris abans d'utilitzar-la a Didit.
Prompt de l'API per crear una plantilla d'informe
Copia el prompt al porta-retalls
\
\`Create a FIU report template through the Management API.
Endpoint:
POST https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/report-templates/
Authentication:
Use the x-api-key header with my Didit API key.
Request body:
\{
"name": "US SAR default", // required
"jurisdiction": "US", // required, ISO 3166-1 alpha-2, upper-cased on save
"report_type": "SAR", // required: SAR|STR|CTR|TTR|UTR|IFT|CBR|TFR
"field_config": {
"rentity_id": "FIU-US-00123", // obligatory - reporting entity ID from your FIU
"submission_code": "E", // obligatory - E (electronic) or M (manual)
"currency_code_local": "USD", // obligatory
"enabled_fields": ["reporting_person", "location"] // optional blocks to include by default
}
}
Validation:
\- jurisdiction must be a recognized ISO2 code.
\- field_config is checked against the template-level obligatory goAML fields - exactly rentity_id, submission_code, and currency_code_local (3-letter). Missing fields return a 400 listing exactly which ones, and the template cannot be saved until they are filled in.
\- The remaining report header fields (action, submission_date, at least one transaction, jurisdiction) are per-filing values, enforced later when the REPORT is validated/finalized - not on the template.
Example call:
curl -X POST "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/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"}}'
Response 201: ReportTemplateDetail.
Failure modes:
\- 400 - unrecognized jurisdiction, or field_config missing obligatory fields ({"errors": ["rentity_id", ...]}).
\- 401/403 - auth/permission errors (requires write:cases).
For the full integration shape, see /integration/integration-prompt.`
\
Enganxa a
Crea una plantilla d'encapçalament goAML reutilitzable. Una plantilla ha de superar la validació de camps obligatoris (`rentity_id`, `submission_code`, `currency_code_local`) per poder-se desar, tant en crear-la com cada vegada que se n'edita. Els camps d'encapçalament de cada presentació, com `action` i `submission_date`, s'exigeixen quan es valida o es finalitza l'informe en si, no a la plantilla.## Relacionats- [Llistar plantilles d'informe](https://docs.didit.me/ca/management-api/report-templates/list.md)
- [Crear informe des d'un cas](https://docs.didit.me/ca/management-api/regulatory-reports/create-for-case.md)
## OpenAPI
````yaml ca/openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/report-templates/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/organization/{organization_id}/application/{application_id}/report-templates/:
post:
tags:
- Report Templates
summary: Crea una plantilla d'informe
description: >-
Crea una plantilla reutilitzable de capçalera de goAML per jurisdicció i
per tipus d'informe. Es rebutja amb 400 si falta algun dels camps
obligatoris de la plantilla (rentity_id, submission_code,
currency_code_local) a field_config; una plantilla no vàlida no es pot
desar ni utilitzar per crear un informe. Els camps de capçalera
específics de cada presentació (action, submission_date, transactions)
s'exigeixen en el moment de validar o finalitzar l'informe.
operationId: create_report_template
parameters:
- name: organization_id
in: path
required: true
schema:
type: string
format: uuid
description: UUID de l'organització.
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
description: UUID de l'aplicació.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- jurisdiction
- report_type
properties:
name:
type: string
jurisdiction:
type: string
minLength: 2
maxLength: 2
description: >-
Codi de país ISO 3166-1 alfa-2, convertit a majúscules en
desar-se.
report_type:
type: string
enum:
- SAR
- STR
- CTR
- TTR
- UTR
- IFT
- CBR
- TFR
field_config:
type: object
description: >-
Valors per defecte reutilitzables de capçalera de goAML.
Camps obligatoris a nivell de plantilla: rentity_id,
submission_code i currency_code_local (de 3 lletres).
Opcionals: enabled_fields (quins blocs d'informe opcionals
cal incloure) a més dels valors per defecte de
reporting_person, location, reason i action. Els camps de
capçalera per declaració (action, submission_date,
transactions, jurisdiction) s'exigeixen quan l'informe es
valida o es finalitza, no a la plantilla.
example:
name: US SAR default
jurisdiction: US
report_type: SAR
field_config:
rentity_id: FIU-US-00123
submission_code: E
currency_code_local: USD
responses:
'201':
description: Plantilla creada.
content:
application/json:
schema:
$ref: '#/components/schemas/ReportTemplateDetail'
'400':
description: >-
Jurisdicció no reconeguda, o field_config no supera la validació de
camps obligatoris.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: >-
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"}}'
- lang: python
label: Python
source: |-
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)
- lang: javascript
label: Node.js
source: |-
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);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.ReportTemplates.Create(ctx, didit.ReportTemplatesCreateParams{\n\tName: \"US SAR default\",\n\tJurisdiction: \"US\",\n\tReportType: \"SAR\",\n\tFieldConfig: didit.Some(map[string]any{\"rentity_id\": \"FIU-US-00123\", \"submission_code\": \"E\", \"currency_code_local\": \"USD\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
- lang: java
label: Java
source: >-
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);
- lang: php
label: PHP
source: |-
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());
- lang: ruby
label: Ruby
source: |-
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_h
- lang: csharp
label: .NET
source: >-
using 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 { ["rentity_id"] = "FIU-US-00123", ["submission_code"] = "E", ["currency_code_local"] = "USD" },
});
Console.WriteLine(JsonSerializer.Serialize(result));
components:
schemas:
ReportTemplateDetail:
type: object
properties:
uuid:
type: string
format: uuid
name:
type: string
jurisdiction:
type: string
minLength: 2
maxLength: 2
description: Codi de país ISO 3166-1 alfa-2.
report_type:
type: string
enum:
- SAR
- STR
- CTR
- TTR
- UTR
- IFT
- CBR
- TFR
report_type_display:
type: string
field_config:
type: object
description: >-
Valors per defecte reutilitzables de capçalera de goAML. Camps
obligatoris a nivell de plantilla: rentity_id, submission_code i
currency_code_local (de 3 lletres). Opcionals: enabled_fields (quins
blocs d'informe opcionals cal incloure) a més dels valors per
defecte de reporting_person, location, reason i action. Els camps de
capçalera per declaració (action, submission_date, transactions,
jurisdiction) s'exigeixen quan l'informe es valida o es finalitza,
no a la plantilla.
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
La clau d'API de la teva aplicació, des de Developers -> API keys a la
Business Console. La clau primària té accés complet. Una clau amb nom
pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
limitada a determinats fluxos de treball o a sessions aprovades, a una
llista d'adreces IP i a una data de caducitat. 401 significa que la clau
és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
clau, que la clau no té accés a aquest recurs o acció, o que la
sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
ruta de sessió significa que la sessió està fora dels fluxos de treball
o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
URL d'imatge, vídeo i PDF com a null, i una clau sense permís
d'escriptura de sessions rep els enllaços de sessió i els tokens com a
null. Consulta https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.