> ## 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.
# API de création de modèle de rapport
> Créez avec Didit un modèle d'en-tête de rapport goAML par juridiction, validé selon les champs obligatoires avant utilisation.
Prompt API de création de modèle de rapport
Copier le prompt dans le presse-papiers
\
\`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.`
\
Coller dans
Créez un modèle d'en-tête goAML réutilisable. Un modèle doit passer la validation des champs obligatoires (`rentity_id`, `submission_code`, `currency_code_local`) pour être enregistré, à la création comme à chaque modification. Les champs d'en-tête propres à chaque déclaration, comme `action` et `submission_date`, sont exigés lors de la validation ou de la finalisation du rapport lui-même, et non sur le modèle.## Liens connexes- [Lister les modèles de rapport](https://docs.didit.me/fr/management-api/report-templates/list.md)
- [Créer un rapport à partir d'un dossier](https://docs.didit.me/fr/management-api/regulatory-reports/create-for-case.md)
## OpenAPI
````yaml fr/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 vérification d'identité. Authentifiez-vous avec l'en-tête 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: Créer un modèle de rapport
description: "Créez un modèle d'en-tête goAML réutilisable par juridiction et par type de rapport. Rejeté avec une erreur 400 si l'un des champs obligatoires au niveau du modèle (rentity_id, submission_code, currency_code_local) est manquant dans field_config\_; un modèle invalide ne peut pas être enregistré ni utilisé pour créer un rapport. Les champs d'en-tête propres à chaque déclaration (action, submission_date, transactions) sont appliqués lors de la validation ou de la finalisation du rapport."
operationId: create_report_template
parameters:
- name: organization_id
in: path
required: true
schema:
type: string
format: uuid
description: UUID de l'organisation.
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
description: UUID de l'application.
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: >-
Code pays ISO 3166-1 alpha-2, converti en majuscules lors de
l'enregistrement.
report_type:
type: string
enum:
- SAR
- STR
- CTR
- TTR
- UTR
- IFT
- CBR
- TFR
field_config:
type: object
description: >-
Valeurs par défaut réutilisables des en-têtes goAML. Champs
obligatoires au niveau du modèle : rentity_id,
submission_code et currency_code_local (3 lettres).
Facultatif : enabled_fields (quels blocs de rapport
facultatifs inclure) ainsi que les valeurs par défaut pour
reporting_person, location, reason et action. Les champs
d'en-tête propres au dépôt (action, submission_date,
transactions, jurisdiction) sont appliqués lors de la
validation ou de la finalisation du rapport, et non sur le
modèle.
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: Modèle créé.
content:
application/json:
schema:
$ref: '#/components/schemas/ReportTemplateDetail'
'400':
description: >-
Juridiction non reconnue, ou field_config échoue à la validation des
champs obligatoires.
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: Code pays ISO 3166-1 alpha-2.
report_type:
type: string
enum:
- SAR
- STR
- CTR
- TTR
- UTR
- IFT
- CBR
- TFR
report_type_display:
type: string
field_config:
type: object
description: >-
Valeurs par défaut réutilisables des en-têtes goAML. Champs
obligatoires au niveau du modèle : rentity_id, submission_code et
currency_code_local (3 lettres). Facultatif : enabled_fields (quels
blocs de rapport facultatifs inclure) ainsi que les valeurs par
défaut pour reporting_person, location, reason et action. Les champs
d'en-tête propres au dépôt (action, submission_date, transactions,
jurisdiction) sont appliqués lors de la validation ou de la
finalisation du rapport, et non sur le modèle.
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 clé API de votre application, issue de Développeurs -> Clés API dans
la Business Console. La clé principale dispose d'un accès complet. Une
clé nommée peut être restreinte : aucun, lecture ou écriture par
ressource, limitée à certains workflows ou aux sessions approuvées, à
une liste d'adresses IP et à une date d'expiration. 401 signifie que la
clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a
été envoyée, que la clé n'a pas accès à cette ressource ou action, ou
que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur
une route de session signifie que la session est hors des workflows ou
des statuts de la clé. Une clé sans accès aux médias reçoit les URL
d'images, de vidéos et de PDF à null, et une clé sans accès en écriture
aux sessions reçoit les liens et tokens de session à null. Voir
https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.