Get Started
Integrate / SDKs
User Verification
Business Verification
Transaction Monitoring
Changelogcurl
curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/regulatory-reports/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"template": "7ec00000-0000-4000-8000-000000000006"}'import requests
url = "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/"
payload = {
"jurisdiction": "<string>",
"template": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactions": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"rentity_id": "<string>",
"rentity_branch": "<string>",
"submission_code": "E",
"entity_reference": "<string>",
"fiu_ref_number": "<string>",
"currency_code_local": "<string>",
"submission_date": "2023-11-07T05:31:56Z",
"reporting_person": {},
"location": {},
"reason": "<string>",
"action": "<string>",
"activity": "<string>",
"narrative": {
"who": "<string>",
"what": "<string>",
"when": "<string>",
"where": "<string>",
"why": "<string>",
"how": "<string>"
},
"report_indicators": ["<string>"],
"included_fields": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
jurisdiction: '<string>',
template: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
transactions: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
rentity_id: '<string>',
rentity_branch: '<string>',
submission_code: 'E',
entity_reference: '<string>',
fiu_ref_number: '<string>',
currency_code_local: '<string>',
submission_date: '2023-11-07T05:31:56Z',
reporting_person: {},
location: {},
reason: '<string>',
action: '<string>',
activity: '<string>',
narrative: {
who: '<string>',
what: '<string>',
when: '<string>',
where: '<string>',
why: '<string>',
how: '<string>'
},
report_indicators: ['<string>'],
included_fields: ['<string>']
})
};
fetch('https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'jurisdiction' => '<string>',
'template' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'transactions' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'rentity_id' => '<string>',
'rentity_branch' => '<string>',
'submission_code' => 'E',
'entity_reference' => '<string>',
'fiu_ref_number' => '<string>',
'currency_code_local' => '<string>',
'submission_date' => '2023-11-07T05:31:56Z',
'reporting_person' => [
],
'location' => [
],
'reason' => '<string>',
'action' => '<string>',
'activity' => '<string>',
'narrative' => [
'who' => '<string>',
'what' => '<string>',
'when' => '<string>',
'where' => '<string>',
'why' => '<string>',
'how' => '<string>'
],
'report_indicators' => [
'<string>'
],
'included_fields' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/"
payload := strings.NewReader("{\n \"jurisdiction\": \"<string>\",\n \"template\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"transactions\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"rentity_id\": \"<string>\",\n \"rentity_branch\": \"<string>\",\n \"submission_code\": \"E\",\n \"entity_reference\": \"<string>\",\n \"fiu_ref_number\": \"<string>\",\n \"currency_code_local\": \"<string>\",\n \"submission_date\": \"2023-11-07T05:31:56Z\",\n \"reporting_person\": {},\n \"location\": {},\n \"reason\": \"<string>\",\n \"action\": \"<string>\",\n \"activity\": \"<string>\",\n \"narrative\": {\n \"who\": \"<string>\",\n \"what\": \"<string>\",\n \"when\": \"<string>\",\n \"where\": \"<string>\",\n \"why\": \"<string>\",\n \"how\": \"<string>\"\n },\n \"report_indicators\": [\n \"<string>\"\n ],\n \"included_fields\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"jurisdiction\": \"<string>\",\n \"template\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"transactions\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"rentity_id\": \"<string>\",\n \"rentity_branch\": \"<string>\",\n \"submission_code\": \"E\",\n \"entity_reference\": \"<string>\",\n \"fiu_ref_number\": \"<string>\",\n \"currency_code_local\": \"<string>\",\n \"submission_date\": \"2023-11-07T05:31:56Z\",\n \"reporting_person\": {},\n \"location\": {},\n \"reason\": \"<string>\",\n \"action\": \"<string>\",\n \"activity\": \"<string>\",\n \"narrative\": {\n \"who\": \"<string>\",\n \"what\": \"<string>\",\n \"when\": \"<string>\",\n \"where\": \"<string>\",\n \"why\": \"<string>\",\n \"how\": \"<string>\"\n },\n \"report_indicators\": [\n \"<string>\"\n ],\n \"included_fields\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"jurisdiction\": \"<string>\",\n \"template\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"transactions\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"rentity_id\": \"<string>\",\n \"rentity_branch\": \"<string>\",\n \"submission_code\": \"E\",\n \"entity_reference\": \"<string>\",\n \"fiu_ref_number\": \"<string>\",\n \"currency_code_local\": \"<string>\",\n \"submission_date\": \"2023-11-07T05:31:56Z\",\n \"reporting_person\": {},\n \"location\": {},\n \"reason\": \"<string>\",\n \"action\": \"<string>\",\n \"activity\": \"<string>\",\n \"narrative\": {\n \"who\": \"<string>\",\n \"what\": \"<string>\",\n \"when\": \"<string>\",\n \"where\": \"<string>\",\n \"why\": \"<string>\",\n \"how\": \"<string>\"\n },\n \"report_indicators\": [\n \"<string>\"\n ],\n \"included_fields\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"case_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"case_number": "<string>",
"report_type_display": "<string>",
"report_code": "<string>",
"report_number": "<string>",
"status_display": "<string>",
"jurisdiction": "<string>",
"rentity_id": "<string>",
"rentity_branch": "<string>",
"entity_reference": "<string>",
"fiu_ref_number": "<string>",
"currency_code_local": "<string>",
"submission_date": "2023-11-07T05:31:56Z",
"reporting_person": {},
"location": {},
"reason": "<string>",
"action": "<string>",
"activity": "<string>",
"narrative": {
"who": "<string>",
"what": "<string>",
"when": "<string>",
"where": "<string>",
"why": "<string>",
"how": "<string>"
},
"report_indicators": [
"<string>"
],
"included_fields": [
"<string>"
],
"transactions": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"validation_errors": [
{
"field": "<string>",
"message": "<string>"
}
],
"validated_at": "2023-11-07T05:31:56Z",
"finalized_at": "2023-11-07T05:31:56Z",
"created_by_email": "<string>",
"created_by_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": "<string>"
}Regulatory Reports
Create Report From Case
Create a draft FIU report for the case: DRAFT status, auto-populated from the optional template plus the case’s subject, linked transactions, and narrative. Validate then finalize to produce the goAML XML and PDF.
POST
/
v3
/
organization
/
{organization_id}
/
application
/
{application_id}
/
cases
/
{case_uuid}
/
regulatory-reports
/
curl
curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/regulatory-reports/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"template": "7ec00000-0000-4000-8000-000000000006"}'import requests
url = "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/"
payload = {
"jurisdiction": "<string>",
"template": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactions": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"rentity_id": "<string>",
"rentity_branch": "<string>",
"submission_code": "E",
"entity_reference": "<string>",
"fiu_ref_number": "<string>",
"currency_code_local": "<string>",
"submission_date": "2023-11-07T05:31:56Z",
"reporting_person": {},
"location": {},
"reason": "<string>",
"action": "<string>",
"activity": "<string>",
"narrative": {
"who": "<string>",
"what": "<string>",
"when": "<string>",
"where": "<string>",
"why": "<string>",
"how": "<string>"
},
"report_indicators": ["<string>"],
"included_fields": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
jurisdiction: '<string>',
template: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
transactions: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
rentity_id: '<string>',
rentity_branch: '<string>',
submission_code: 'E',
entity_reference: '<string>',
fiu_ref_number: '<string>',
currency_code_local: '<string>',
submission_date: '2023-11-07T05:31:56Z',
reporting_person: {},
location: {},
reason: '<string>',
action: '<string>',
activity: '<string>',
narrative: {
who: '<string>',
what: '<string>',
when: '<string>',
where: '<string>',
why: '<string>',
how: '<string>'
},
report_indicators: ['<string>'],
included_fields: ['<string>']
})
};
fetch('https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'jurisdiction' => '<string>',
'template' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'transactions' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'rentity_id' => '<string>',
'rentity_branch' => '<string>',
'submission_code' => 'E',
'entity_reference' => '<string>',
'fiu_ref_number' => '<string>',
'currency_code_local' => '<string>',
'submission_date' => '2023-11-07T05:31:56Z',
'reporting_person' => [
],
'location' => [
],
'reason' => '<string>',
'action' => '<string>',
'activity' => '<string>',
'narrative' => [
'who' => '<string>',
'what' => '<string>',
'when' => '<string>',
'where' => '<string>',
'why' => '<string>',
'how' => '<string>'
],
'report_indicators' => [
'<string>'
],
'included_fields' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/"
payload := strings.NewReader("{\n \"jurisdiction\": \"<string>\",\n \"template\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"transactions\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"rentity_id\": \"<string>\",\n \"rentity_branch\": \"<string>\",\n \"submission_code\": \"E\",\n \"entity_reference\": \"<string>\",\n \"fiu_ref_number\": \"<string>\",\n \"currency_code_local\": \"<string>\",\n \"submission_date\": \"2023-11-07T05:31:56Z\",\n \"reporting_person\": {},\n \"location\": {},\n \"reason\": \"<string>\",\n \"action\": \"<string>\",\n \"activity\": \"<string>\",\n \"narrative\": {\n \"who\": \"<string>\",\n \"what\": \"<string>\",\n \"when\": \"<string>\",\n \"where\": \"<string>\",\n \"why\": \"<string>\",\n \"how\": \"<string>\"\n },\n \"report_indicators\": [\n \"<string>\"\n ],\n \"included_fields\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"jurisdiction\": \"<string>\",\n \"template\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"transactions\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"rentity_id\": \"<string>\",\n \"rentity_branch\": \"<string>\",\n \"submission_code\": \"E\",\n \"entity_reference\": \"<string>\",\n \"fiu_ref_number\": \"<string>\",\n \"currency_code_local\": \"<string>\",\n \"submission_date\": \"2023-11-07T05:31:56Z\",\n \"reporting_person\": {},\n \"location\": {},\n \"reason\": \"<string>\",\n \"action\": \"<string>\",\n \"activity\": \"<string>\",\n \"narrative\": {\n \"who\": \"<string>\",\n \"what\": \"<string>\",\n \"when\": \"<string>\",\n \"where\": \"<string>\",\n \"why\": \"<string>\",\n \"how\": \"<string>\"\n },\n \"report_indicators\": [\n \"<string>\"\n ],\n \"included_fields\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"jurisdiction\": \"<string>\",\n \"template\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"transactions\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"rentity_id\": \"<string>\",\n \"rentity_branch\": \"<string>\",\n \"submission_code\": \"E\",\n \"entity_reference\": \"<string>\",\n \"fiu_ref_number\": \"<string>\",\n \"currency_code_local\": \"<string>\",\n \"submission_date\": \"2023-11-07T05:31:56Z\",\n \"reporting_person\": {},\n \"location\": {},\n \"reason\": \"<string>\",\n \"action\": \"<string>\",\n \"activity\": \"<string>\",\n \"narrative\": {\n \"who\": \"<string>\",\n \"what\": \"<string>\",\n \"when\": \"<string>\",\n \"where\": \"<string>\",\n \"why\": \"<string>\",\n \"how\": \"<string>\"\n },\n \"report_indicators\": [\n \"<string>\"\n ],\n \"included_fields\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"case_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"case_number": "<string>",
"report_type_display": "<string>",
"report_code": "<string>",
"report_number": "<string>",
"status_display": "<string>",
"jurisdiction": "<string>",
"rentity_id": "<string>",
"rentity_branch": "<string>",
"entity_reference": "<string>",
"fiu_ref_number": "<string>",
"currency_code_local": "<string>",
"submission_date": "2023-11-07T05:31:56Z",
"reporting_person": {},
"location": {},
"reason": "<string>",
"action": "<string>",
"activity": "<string>",
"narrative": {
"who": "<string>",
"what": "<string>",
"when": "<string>",
"where": "<string>",
"why": "<string>",
"how": "<string>"
},
"report_indicators": [
"<string>"
],
"included_fields": [
"<string>"
],
"transactions": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"validation_errors": [
{
"field": "<string>",
"message": "<string>"
}
],
"validated_at": "2023-11-07T05:31:56Z",
"finalized_at": "2023-11-07T05:31:56Z",
"created_by_email": "<string>",
"created_by_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": "<string>"
}
Create a draft report scoped to a case. Prefer this over the standalone create endpoint when you already have the case open - it can omit
template and derive report_type/jurisdiction directly.
Related
Authorizations
Path Parameters
Organization UUID.
Application UUID.
Case UUID.
Example:
"c1a5e000-0000-4000-8000-000000000001"
Body
application/json
Required unless a template is given; the template's report_type is used otherwise.
Available options:
SAR, STR, CTR, TTR, UTR, IFT, CBR, TFR Required unless a template is given.
Required string length:
2Report template UUID; its field_config seeds the draft before case-derived data is merged in.
Transactions to attach; defaults to the case's linked transactions.
Available options:
E, M Required string length:
3Show child attributes
Show child attributes
Response
Draft report created.
Available options:
SAR, STR, CTR, TTR, UTR, IFT, CBR, TFR goAML report code derived from report_type, e.g. STR, CTR, BCR.
Available options:
DRAFT, VALIDATED, FINALIZED Required string length:
2Reporting entity ID issued by the FIU.
Available options:
E, M Required string length:
3Five Ws narrative sections.
Show child attributes
Show child attributes
Result of the most recent validation; each entry is a {field, message} object.
Show child attributes
Show child attributes
⌘I