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"}}'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)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);ctx := context.Background()
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
client := didit.NewClient()
result, err := client.ReportTemplates.Create(ctx, didit.ReportTemplatesCreateParams{
Name: "US SAR default",
Jurisdiction: "US",
ReportType: "SAR",
FieldConfig: didit.Some(map[string]any{"rentity_id": "FIU-US-00123", "submission_code": "E", "currency_code_local": "USD"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)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);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
$didit = new DiditClient();
$result = $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'],
]);
print_r($result->toArray());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_husing 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<string, object> { ["rentity_id"] = "FIU-US-00123", ["submission_code"] = "E", ["currency_code_local"] = "USD" },
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"jurisdiction": "<string>",
"report_type": "SAR",
"report_type_display": "<string>",
"field_config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"errors": [
"<string>"
]
}إنشاء قالب تقرير API
أنشئ قالب رأس تقرير goAML قابلاً لإعادة الاستخدام لكل ولاية قضائية، ويُتحقق من صحته مقابل الحقول الإلزامية قبل استخدامه في Didit.
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"}}'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)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);ctx := context.Background()
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
client := didit.NewClient()
result, err := client.ReportTemplates.Create(ctx, didit.ReportTemplatesCreateParams{
Name: "US SAR default",
Jurisdiction: "US",
ReportType: "SAR",
FieldConfig: didit.Some(map[string]any{"rentity_id": "FIU-US-00123", "submission_code": "E", "currency_code_local": "USD"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)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);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
$didit = new DiditClient();
$result = $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'],
]);
print_r($result->toArray());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_husing 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<string, object> { ["rentity_id"] = "FIU-US-00123", ["submission_code"] = "E", ["currency_code_local"] = "USD" },
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"jurisdiction": "<string>",
"report_type": "SAR",
"report_type_display": "<string>",
"field_config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"errors": [
"<string>"
]
}rentity_id وsubmission_code وcurrency_code_local) ليُحفظ، سواء عند الإنشاء أو عند كل تعديل لاحق. أما حقول الرأس الخاصة بكل تقرير، مثل action وsubmission_date، فتُطبَّق عند التحقق من التقرير نفسه أو إنهائه، ولا تُطبَّق على القالب.
ذات صلة
التفويضات
مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.
معلمات المسار
UUID الخاص بالمؤسسة.
معرّف UUID للتطبيق.
الجسم
رمز الدولة وفقاً لـ ISO 3166-1 alpha-2، يتم تحويله إلى أحرف كبيرة عند الحفظ.
2SAR, STR, CTR, TTR, UTR, IFT, CBR, TFR القيم الافتراضية القابلة لإعادة الاستخدام لرأس goAML. الحقول الإلزامية على مستوى القالب: rentity_id، وsubmission_code، وcurrency_code_local (من 3 أحرف). الحقول الاختيارية: enabled_fields (أقسام التقرير الاختيارية المطلوب تضمينها) بالإضافة إلى القيم الافتراضية لكل من reporting_person، وlocation، وreason، وaction. يتم فرض حقول الرأس الخاصة بكل ملف تقديم (action، وsubmission_date، وtransactions، وjurisdiction) عند التحقق من صحة التقرير أو إتمامه نهائياً، وليس على مستوى القالب.
الاستجابة
تم إنشاء القالب.
رمز الدولة وفقاً لـ ISO 3166-1 alpha-2.
2SAR, STR, CTR, TTR, UTR, IFT, CBR, TFR القيم الافتراضية القابلة لإعادة الاستخدام لرأس goAML. الحقول الإلزامية على مستوى القالب: rentity_id، وsubmission_code، وcurrency_code_local (من 3 أحرف). الحقول الاختيارية: enabled_fields (أقسام التقرير الاختيارية المطلوب تضمينها) بالإضافة إلى القيم الافتراضية لكل من reporting_person، وlocation، وreason، وaction. يتم فرض حقول الرأس الخاصة بكل ملف تقديم (action، وsubmission_date، وtransactions، وjurisdiction) عند التحقق من صحة التقرير أو إتمامه نهائياً، وليس على مستوى القالب.