> ## 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
> Didit에서 관할 지역별로 재사용 가능한 goAML 보고서 헤더 템플릿을 생성합니다. 사용 전에 필수 필드를 검증합니다.
보고서 템플릿 생성 API 프롬프트
프롬프트를 클립보드에 복사
\
\`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.`
\
붙여넣을 곳
재사용 가능한 goAML 헤더 템플릿을 만듭니다. 템플릿을 저장하려면 생성할 때와 이후 수정할 때마다 필수 필드(`rentity_id`, `submission_code`, `currency_code_local`) 검증을 통과해야 합니다. 건별 헤더 필드인 `action`과 `submission_date`는 템플릿이 아니라 보고서 자체를 검증하거나 확정할 때 적용됩니다.## 관련 문서- [보고서 템플릿 목록 조회](https://docs.didit.me/ko/management-api/report-templates/list.md)
- [케이스에서 보고서 생성](https://docs.didit.me/ko/management-api/regulatory-reports/create-for-case.md)
## OpenAPI
````yaml ko/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입니다. 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: 보고서 템플릿 생성
description: >-
관할권별, 보고서 유형별로 재사용 가능한 goAML 헤더 템플릿을 생성합니다. field_config에 템플릿 수준의 필수
필드(rentity_id, submission_code, currency_code_local) 중 하나라도 누락된 경우 400으로
거부됩니다. 유효하지 않은 템플릿은 저장하거나 보고서를 생성하는 데 사용할 수 없습니다. 신고별 헤더 필드(action,
submission_date, transactions)는 보고서 유효성 검사/확정 시점에 대신 적용됩니다.
operationId: create_report_template
parameters:
- name: organization_id
in: path
required: true
schema:
type: string
format: uuid
description: 조직 UUID입니다.
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
description: 애플리케이션 UUID입니다.
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: 저장 시 대문자로 변환되는 ISO 3166-1 alpha-2 국가 코드입니다.
report_type:
type: string
enum:
- SAR
- STR
- CTR
- TTR
- UTR
- IFT
- CBR
- TFR
field_config:
type: object
description: >-
재사용 가능한 goAML 헤더 기본값입니다. 템플릿 수준 필수 필드: rentity_id,
submission_code 및 currency_code_local(3자리 문자). 선택 사항:
enabled_fields(포함할 선택적 보고서 블록)와 reporting_person, location,
reason 및 action 기본값. 제출 건별 헤더 필드(action, submission_date,
transactions, jurisdiction)는 템플릿이 아닌 보고서가 검증되거나 완료될 때 적용됩니다.
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: 템플릿이 생성되었습니다.
content:
application/json:
schema:
$ref: '#/components/schemas/ReportTemplateDetail'
'400':
description: 인식할 수 없는 관할권이거나, field_config가 필수 필드 유효성 검사에 실패했습니다.
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: 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: >-
재사용 가능한 goAML 헤더 기본값입니다. 템플릿 수준 필수 필드: rentity_id, submission_code 및
currency_code_local(3자리 문자). 선택 사항: enabled_fields(포함할 선택적 보고서 블록)와
reporting_person, location, reason 및 action 기본값. 제출 건별 헤더 필드(action,
submission_date, transactions, jurisdiction)는 템플릿이 아닌 보고서가 검증되거나 완료될
때 적용됩니다.
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: >-
Business Console의 Developers -> API keys에서 발급받은 귀하 애플리케이션의 API 키입니다. 기본
키는 전체 접근 권한을 갖습니다. 이름이 지정된 키는 리소스별 none, read, write 범위로 권한을 제한할 수 있으며
특정 워크플로나 승인된 세션, IP 주소 목록, 만료일 등으로 제한할 수도 있습니다. 401은 키가 잘못되었거나 폐기되었거나
만료되었음을 의미합니다. 403은 키가 전송되지 않았거나, 키에 해당 리소스나 작업에 대한 접근 권한이 없거나, 요청이 허용된
IP 목록 외부 주소에서 발생했음을 의미합니다. 세션 경로에서의 404는 해당 세션이 키의 허용 워크플로 또는 상태 범위를
벗어났음을 의미합니다. 미디어 접근 권한이 없는 키는 이미지, 비디오, PDF URL을 null로 수신하며, 세션 write
권한이 없는 키는 세션 링크와 token을 null로 수신합니다.
https://docs.didit.me/console/api-keys 를 참고하십시오.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.