Screening Entities
Activate screening entity
Convert a screening entity into a client for ongoing compliance monitoring
PATCH
/
entities
/
screening
/
{entityId}
/
status
Activate screening entity
curl --request PATCH \
--url https://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-tenant: <x-tenant>' \
--data '
{
"identities": [
{
"number": "A123456789",
"subtype": "<string>",
"expiresAt": "2030-12-31",
"issuingCountryCode": "SA",
"documentIds": [
"<string>"
]
}
],
"nameEn": "John Michael Doe",
"nameAr": "جون ميخائيل دو",
"email": "john.doe@example.com",
"countryCode": "966",
"phoneNumber": "501234567",
"accountOpenDate": "2025-06-15",
"dobGregorian": "1990-05-20",
"dobHijri": "1410-10-15",
"dateOfIncorporationGregorian": "2005-09-30",
"dateOfIncorporationHijri": "1426-08-20",
"nationalityCode": "SA",
"crmId": "550e8400-e29b-41d4-a716-446655440000",
"tagIds": [
"<string>"
],
"ongoingMonitoring": true
}
'import requests
url = "https://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status"
payload = {
"identities": [
{
"number": "A123456789",
"subtype": "<string>",
"expiresAt": "2030-12-31",
"issuingCountryCode": "SA",
"documentIds": ["<string>"]
}
],
"nameEn": "John Michael Doe",
"nameAr": "جون ميخائيل دو",
"email": "john.doe@example.com",
"countryCode": "966",
"phoneNumber": "501234567",
"accountOpenDate": "2025-06-15",
"dobGregorian": "1990-05-20",
"dobHijri": "1410-10-15",
"dateOfIncorporationGregorian": "2005-09-30",
"dateOfIncorporationHijri": "1426-08-20",
"nationalityCode": "SA",
"crmId": "550e8400-e29b-41d4-a716-446655440000",
"tagIds": ["<string>"],
"ongoingMonitoring": True
}
headers = {
"x-tenant": "<x-tenant>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-tenant': '<x-tenant>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
identities: [
{
number: 'A123456789',
subtype: '<string>',
expiresAt: '2030-12-31',
issuingCountryCode: 'SA',
documentIds: ['<string>']
}
],
nameEn: 'John Michael Doe',
nameAr: 'جون ميخائيل دو',
email: 'john.doe@example.com',
countryCode: '966',
phoneNumber: '501234567',
accountOpenDate: '2025-06-15',
dobGregorian: '1990-05-20',
dobHijri: '1410-10-15',
dateOfIncorporationGregorian: '2005-09-30',
dateOfIncorporationHijri: '1426-08-20',
nationalityCode: 'SA',
crmId: '550e8400-e29b-41d4-a716-446655440000',
tagIds: ['<string>'],
ongoingMonitoring: true
})
};
fetch('https://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status', 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://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'identities' => [
[
'number' => 'A123456789',
'subtype' => '<string>',
'expiresAt' => '2030-12-31',
'issuingCountryCode' => 'SA',
'documentIds' => [
'<string>'
]
]
],
'nameEn' => 'John Michael Doe',
'nameAr' => 'جون ميخائيل دو',
'email' => 'john.doe@example.com',
'countryCode' => '966',
'phoneNumber' => '501234567',
'accountOpenDate' => '2025-06-15',
'dobGregorian' => '1990-05-20',
'dobHijri' => '1410-10-15',
'dateOfIncorporationGregorian' => '2005-09-30',
'dateOfIncorporationHijri' => '1426-08-20',
'nationalityCode' => 'SA',
'crmId' => '550e8400-e29b-41d4-a716-446655440000',
'tagIds' => [
'<string>'
],
'ongoingMonitoring' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-tenant: <x-tenant>"
],
]);
$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://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status"
payload := strings.NewReader("{\n \"identities\": [\n {\n \"number\": \"A123456789\",\n \"subtype\": \"<string>\",\n \"expiresAt\": \"2030-12-31\",\n \"issuingCountryCode\": \"SA\",\n \"documentIds\": [\n \"<string>\"\n ]\n }\n ],\n \"nameEn\": \"John Michael Doe\",\n \"nameAr\": \"جون ميخائيل دو\",\n \"email\": \"john.doe@example.com\",\n \"countryCode\": \"966\",\n \"phoneNumber\": \"501234567\",\n \"accountOpenDate\": \"2025-06-15\",\n \"dobGregorian\": \"1990-05-20\",\n \"dobHijri\": \"1410-10-15\",\n \"dateOfIncorporationGregorian\": \"2005-09-30\",\n \"dateOfIncorporationHijri\": \"1426-08-20\",\n \"nationalityCode\": \"SA\",\n \"crmId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"tagIds\": [\n \"<string>\"\n ],\n \"ongoingMonitoring\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-tenant", "<x-tenant>")
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.patch("https://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status")
.header("x-tenant", "<x-tenant>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"identities\": [\n {\n \"number\": \"A123456789\",\n \"subtype\": \"<string>\",\n \"expiresAt\": \"2030-12-31\",\n \"issuingCountryCode\": \"SA\",\n \"documentIds\": [\n \"<string>\"\n ]\n }\n ],\n \"nameEn\": \"John Michael Doe\",\n \"nameAr\": \"جون ميخائيل دو\",\n \"email\": \"john.doe@example.com\",\n \"countryCode\": \"966\",\n \"phoneNumber\": \"501234567\",\n \"accountOpenDate\": \"2025-06-15\",\n \"dobGregorian\": \"1990-05-20\",\n \"dobHijri\": \"1410-10-15\",\n \"dateOfIncorporationGregorian\": \"2005-09-30\",\n \"dateOfIncorporationHijri\": \"1426-08-20\",\n \"nationalityCode\": \"SA\",\n \"crmId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"tagIds\": [\n \"<string>\"\n ],\n \"ongoingMonitoring\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-tenant"] = '<x-tenant>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identities\": [\n {\n \"number\": \"A123456789\",\n \"subtype\": \"<string>\",\n \"expiresAt\": \"2030-12-31\",\n \"issuingCountryCode\": \"SA\",\n \"documentIds\": [\n \"<string>\"\n ]\n }\n ],\n \"nameEn\": \"John Michael Doe\",\n \"nameAr\": \"جون ميخائيل دو\",\n \"email\": \"john.doe@example.com\",\n \"countryCode\": \"966\",\n \"phoneNumber\": \"501234567\",\n \"accountOpenDate\": \"2025-06-15\",\n \"dobGregorian\": \"1990-05-20\",\n \"dobHijri\": \"1410-10-15\",\n \"dateOfIncorporationGregorian\": \"2005-09-30\",\n \"dateOfIncorporationHijri\": \"1426-08-20\",\n \"nationalityCode\": \"SA\",\n \"crmId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"tagIds\": [\n \"<string>\"\n ],\n \"ongoingMonitoring\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"archivedAt": "2025-12-04 12:00:00.000",
"crmId": "550e8400-e29b-41d4-a716-446655440000",
"type": "Individual",
"email": "john.doe@example.com",
"nameEn": "John Michael Doe",
"nameAr": "جون ميخائيل دو",
"status": "Active",
"verificationBlocked": "Identity",
"classification": "Retail",
"category": "Retail",
"gender": "Male",
"countryCode": "966",
"phoneNumber": "501234567",
"accountOpenDate": "2025-06-15",
"dob": "1990-05-20",
"dateOfIncorporation": "2005-09-30",
"netIncome": "10500",
"netAssets": "20750",
"ongoingMonitoring": true,
"identities": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"verifiedAt": "2024-06-18",
"expiresAt": "2030-12-31",
"type": "Passport",
"subtype": "Iqama",
"number": "A123456789",
"issuingCountryCode": "SA",
"selfie": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
},
"documents": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"verification": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"status": "Pending",
"source": "Manual"
}
}
],
"nationalityCode": "SA",
"nationality": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "<string>",
"nameAr": "<string>",
"nationalityEn": "<string>",
"nationalityAr": "<string>",
"twoCode": "<string>",
"threeCode": "<string>"
},
"kyc": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"status": "KycComplete",
"completedAt": "2025-12-04 12:00:00.000",
"eddStatus": "Pending",
"qualifiedStatus": "Approved",
"entityId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"flowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"rmId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"rm": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
},
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"reason": "Default",
"riskBreakdown": {
"sectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"score": "45",
"maxScore": "50"
},
"riskScore": "85",
"riskLevel": "Medium",
"suitabilityScore": "90",
"suitabilitySucceeded": true,
"localMatchCount": 123,
"publicMatchCount": 123,
"overrideReasons": [
{
"category": "Question",
"case": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"archivedAt": "2025-12-04 12:00:00.000",
"matchedAt": "2025-12-04 12:00:00.000",
"source": "Nafith",
"status": "Pending",
"makerUserId": {},
"checkerUserId": {},
"entityId": {},
"customGroupId": {},
"originWatchlistId": {},
"indicatorSummaries": {
"count": 83,
"category": "News Media",
"isNetwork": false
},
"makerUser": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
},
"checkerUser": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
},
"entity": null,
"customGroup": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "<string>",
"description": {},
"userIds": [
"<string>"
],
"users": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
]
},
"originWatchlist": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"orderNumber": "<string>",
"resolutionNumber": {},
"idType": "NationalIdentity",
"idNumber": {},
"requestType": "Unblocking",
"amount": {},
"previousOrderNumber": {},
"banStatus": "Prohibited",
"timeOfRequest": "2023-11-07T05:31:56Z",
"name": {},
"unifiedNumber": {},
"source": "Nafith",
"isValid": true,
"nationality": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "<string>",
"nameAr": "<string>",
"nationalityEn": "<string>",
"nationalityAr": "<string>",
"twoCode": "<string>",
"threeCode": "<string>"
},
"attachment": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
},
"tags": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "<string>",
"nameAr": {},
"scope": "Watchlist"
}
]
},
"matchSummaries": [
{
"status": "Unreviewed",
"count": 123
}
],
"matches": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"deprecatedAt": "2025-12-04 12:00:00.000",
"criteria": "Identity",
"name": "John Doe",
"percentage": 85,
"riskScore": 75,
"status": "Unreviewed",
"reasons": [
"Name"
],
"comment": {},
"indicatorSummaries": {
"count": 83,
"category": "News Media",
"isNetwork": false
},
"matchingScore": {},
"matchedAlias": {},
"recommendation": "AutoMatch",
"signals": {
"name": {
"familyJW": 0.95,
"firstNameJW": 0.92,
"givenTokenScore": 0.88,
"fullJW": 0.93,
"phoneticScore": 0.85,
"exactNormalized": false,
"totalScore": 123
},
"dob": {
"score": 123,
"neglectScore": true
},
"gender": {
"score": 123,
"neglectScore": true
},
"nationality": {
"score": 123,
"neglectScore": true
},
"location": {
"score": 123,
"neglectScore": true
},
"identity": {
"matched": true,
"number": {},
"label": {}
}
},
"caseId": "<string>",
"sigmaId": {},
"gender": "Male",
"watchlistSource": "Nafith"
}
],
"relationshipCases": null,
"transactionAlerts": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"caseId": "<string>",
"severity": "Low",
"isCorrect": {},
"flagCategory": "ExternalAuthority",
"dispositionAt": "2023-11-07T05:31:56Z",
"transactionRule": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"activatedAt": "2023-11-07T05:31:56Z",
"nameEn": "<string>",
"nameAr": "<string>",
"descriptionEn": "<string>",
"descriptionAr": "<string>",
"code": "<string>",
"status": "Published",
"type": "Hard",
"autoSuspended": true,
"config": {},
"configVariables": {}
},
"dispositionBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
},
"notes": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"title": {},
"description": "<string>",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"transactions": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"externalRef": "<string>",
"orderRef": {},
"sourceSystem": "TenantDirect",
"transactionDate": "2023-11-07T05:31:56Z",
"valueDate": "2023-11-07T05:31:56Z",
"settlementDate": "2023-11-07T05:31:56Z",
"status": "Received",
"reviewStatus": "Unreviewed",
"amount": "<string>",
"currency": "Sar",
"exchangeRate": {},
"paymentForm": "BankTransfer",
"paymentType": "Deposit",
"internalTransferReason": "FundSubscription",
"securityDetails": {},
"correctsTransactionId": {},
"sourceEntity": "<unknown>",
"suspiciousSeverity": "Low",
"isBlocked": true,
"direction": "Credit",
"targetEntity": "<unknown>",
"sourceWallet": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"type": "ClientCash",
"status": "Draft",
"currency": "Sar",
"externalRef": {},
"vIban": {},
"availableBalance": "<string>",
"lockedBalance": "<string>",
"entityId": {},
"productId": {},
"lastTransactionAt": "2023-11-07T05:31:56Z",
"dormantAt": "2023-11-07T05:31:56Z",
"closedAt": "2023-11-07T05:31:56Z"
},
"targetWallet": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"type": "ClientCash",
"status": "Draft",
"currency": "Sar",
"externalRef": {},
"vIban": {},
"availableBalance": "<string>",
"lockedBalance": "<string>",
"entityId": {},
"productId": {},
"lastTransactionAt": "2023-11-07T05:31:56Z",
"dormantAt": "2023-11-07T05:31:56Z",
"closedAt": "2023-11-07T05:31:56Z"
},
"sourceBankAccount": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"iban": "GB33BUKB20201555555555",
"primary": true,
"bankNameEn": "Bank of Saudi",
"bankNameAr": "بنك السعودي",
"swiftCode": "BOSAUS3N",
"bankCode": "123456",
"holderName": "John Doe",
"status": "Active",
"source": "Automatic",
"verificationStatus": "Verified",
"attachment": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
},
"entity": "<unknown>"
},
"targetBankAccount": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"iban": "GB33BUKB20201555555555",
"primary": true,
"bankNameEn": "Bank of Saudi",
"bankNameAr": "بنك السعودي",
"swiftCode": "BOSAUS3N",
"bankCode": "123456",
"holderName": "John Doe",
"status": "Active",
"source": "Automatic",
"verificationStatus": "Verified",
"attachment": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
},
"entity": "<unknown>"
},
"strReport": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"status": "Draft",
"attachmentId": "<string>",
"transactionId": "<string>"
},
"triggeredAlerts": "<array>",
"activities": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"type": "ReviewStatusChange",
"reason": "RuleBased",
"reviewStatus": "Unreviewed",
"actor": "Crm",
"authorityRef": {},
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
},
"notes": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"title": {},
"description": "<string>",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"attachments": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
]
}
],
"tags": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "<string>",
"nameAr": {},
"scope": "Watchlist"
}
]
}
]
}
]
},
"question": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "What is your employment status?",
"nameAr": "ما هو وضعك الوظيفي؟",
"labelEn": "Please select your employment status",
"labelAr": "يرجى اختيار وضعك الوظيفي",
"required": true,
"type": "ShortText",
"allowMultiple": false,
"additionalInfoType": "ShortText",
"category": "Nationality",
"unit": "Currency",
"answerSource": "Dal",
"kycFlowId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"sortOrder": 1,
"subweights": 50,
"options": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
}
],
"answer": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"openAnswer": "I prefer Option A",
"attachments": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"questionId": "e085b776-fb4f-4454-b679-e8b14ba52e97",
"answerToOptions": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"option": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
},
"additionalInfo": "12.5"
}
],
"multipleChoiceAnswers": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
}
]
},
"sections": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Personal Information",
"nameAr": "المعلومات الشخصية",
"sortOrder": 1,
"formId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"form": "<unknown>",
"weights": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"value": 10
}
],
"questions": "<array>"
}
]
}
}
],
"reviews": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"status": "Approved",
"type": "First",
"comment": {},
"kycScoreId": "<string>",
"formId": "<string>",
"userId": "<string>",
"user": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
]
}
],
"remainingAttempts": 3,
"progress": {
"Kyc": "Complete",
"RiskAssessment": "Medium",
"Suitability": "Suitable",
"Edd": "Pending",
"QualifiedInvestor": "Pending",
"Aoa": true
},
"flow": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Retail KYC Flow",
"nameAr": "مسار الافراد",
"status": "Published",
"entityType": "Individual",
"classifications": [
"Retail"
],
"emailInvitationEnabled": true,
"idVerificationEnabled": true,
"selfSignupEnabled": true,
"clientEmailsEnabled": true,
"associationVerificationPreference": "Manual",
"monitoringTrigger": "Verification",
"pauseMonitoringAfter": 123,
"retakeLowAfter": 123,
"retakeMediumAfter": 123,
"retakeHighAfter": 123,
"riskSettings": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"lowScore": 1,
"mediumScore": 3,
"highScore": 5,
"lowThreshold": "1.0",
"mediumThreshold": "2.3",
"highThreshold": "3.6",
"maxThreshold": "5.0",
"localThreshold": 60,
"publicThreshold": 70
}
],
"suitabilitySettings": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"successPercentage": 75,
"attempts": 3
}
],
"forms": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"type": "Kyc",
"nameEn": "Risk Assessment",
"nameAr": "تقييم المخاطر",
"requestType": "DisclosureAndBlocking",
"source": "Nafith",
"status": "Published",
"submissions": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"submittedAt": "2023-11-07T05:31:56Z",
"attempt": 123,
"suitabilityScore": {},
"suitabilitySucceeded": {},
"enabledQuestions": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "What is your employment status?",
"nameAr": "ما هو وضعك الوظيفي؟",
"labelEn": "Please select your employment status",
"labelAr": "يرجى اختيار وضعك الوظيفي",
"required": true,
"type": "ShortText",
"allowMultiple": false,
"additionalInfoType": "ShortText",
"category": "Nationality",
"unit": "Currency",
"answerSource": "Dal",
"kycFlowId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"sortOrder": 1,
"subweights": 50,
"options": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
}
],
"answer": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"openAnswer": "I prefer Option A",
"attachments": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"questionId": "e085b776-fb4f-4454-b679-e8b14ba52e97",
"answerToOptions": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"option": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
},
"additionalInfo": "12.5"
}
],
"multipleChoiceAnswers": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
}
]
},
"sections": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Personal Information",
"nameAr": "المعلومات الشخصية",
"sortOrder": 1,
"formId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"form": "<unknown>",
"weights": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"value": 10
}
],
"questions": "<array>"
}
]
}
],
"answers": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"openAnswer": "I prefer Option A",
"attachments": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"questionId": "e085b776-fb4f-4454-b679-e8b14ba52e97",
"answerToOptions": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"option": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
},
"additionalInfo": "12.5"
}
],
"multipleChoiceAnswers": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
}
]
}
]
}
],
"kycReviews": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"status": "Approved",
"type": "First",
"comment": {},
"kycScoreId": "<string>",
"formId": "<string>",
"userId": "<string>",
"user": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"sections": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Personal Information",
"nameAr": "المعلومات الشخصية",
"sortOrder": 1,
"formId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"form": "<unknown>",
"weights": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"value": 10
}
],
"questions": "<array>"
}
]
}
]
}
},
"verifications": {
"identity": false,
"email": false,
"phoneNumber": false,
"address": false,
"bankAccount": false
},
"tags": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "<string>",
"nameAr": {},
"scope": "Watchlist"
}
]
},
"creationStatus": "Created"
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
},
"validationErrors": [
"<string>"
]
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
}
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
}
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
}
}Authorizations
Headers
Tenant identifier
Path Parameters
Body
application/json
Entity type (individual vs organization)
Available options:
Individual, Organization Entity status
Available options:
Active, Blocked, Deactivated, Deceased Show child attributes
Show child attributes
Full name in English. Either nameEn or nameAr must be provided
Example:
"John Michael Doe"
Full name in Arabic. Either nameEn or nameAr must be provided
Example:
"جون ميخائيل دو"
Entity gender
Available options:
Male, Female, NotSpecified Email address of the entity
Example:
"john.doe@example.com"
Country code for phone number (numeric digits as string, e.g., "966" for Saudi Arabia). If provided, phoneNumber must also be provided. If phoneNumber is provided, countryCode must also be provided.
Example:
"966"
Phone number. If provided, countryCode must also be provided. If countryCode is provided, phoneNumber must also be provided.
Example:
"501234567"
Account opening date (YYYY-MM-DD)
Example:
"2025-06-15"
Date of birth (Gregorian, YYYY-MM-DD)
Example:
"1990-05-20"
Date of birth (Hijri, YYYY-MM-DD). Converted to Gregorian internally.
Example:
"1410-10-15"
Entity incorporation date (Gregorian, YYYY-MM-DD)
Example:
"2005-09-30"
Entity incorporation date (Hijri, YYYY-MM-DD). Converted to Gregorian internally.
Example:
"1426-08-20"
Nationality code (ISO 3166-1 alpha-2)
Example:
"SA"
A string identifier from your organization's system (such as a database-generated ID) that you provide so it can also be stored and referenced in our database
Example:
"550e8400-e29b-41d4-a716-446655440000"
Tags to apply. On update, replaces the existing tags entirely; omit the field to leave them untouched.
Whether to monitor the entity against local/public watchlists. An unmonitored entity is not screened against local or public watchlists and does not count toward the public watchlist quota
⌘I
Activate screening entity
curl --request PATCH \
--url https://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-tenant: <x-tenant>' \
--data '
{
"identities": [
{
"number": "A123456789",
"subtype": "<string>",
"expiresAt": "2030-12-31",
"issuingCountryCode": "SA",
"documentIds": [
"<string>"
]
}
],
"nameEn": "John Michael Doe",
"nameAr": "جون ميخائيل دو",
"email": "john.doe@example.com",
"countryCode": "966",
"phoneNumber": "501234567",
"accountOpenDate": "2025-06-15",
"dobGregorian": "1990-05-20",
"dobHijri": "1410-10-15",
"dateOfIncorporationGregorian": "2005-09-30",
"dateOfIncorporationHijri": "1426-08-20",
"nationalityCode": "SA",
"crmId": "550e8400-e29b-41d4-a716-446655440000",
"tagIds": [
"<string>"
],
"ongoingMonitoring": true
}
'import requests
url = "https://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status"
payload = {
"identities": [
{
"number": "A123456789",
"subtype": "<string>",
"expiresAt": "2030-12-31",
"issuingCountryCode": "SA",
"documentIds": ["<string>"]
}
],
"nameEn": "John Michael Doe",
"nameAr": "جون ميخائيل دو",
"email": "john.doe@example.com",
"countryCode": "966",
"phoneNumber": "501234567",
"accountOpenDate": "2025-06-15",
"dobGregorian": "1990-05-20",
"dobHijri": "1410-10-15",
"dateOfIncorporationGregorian": "2005-09-30",
"dateOfIncorporationHijri": "1426-08-20",
"nationalityCode": "SA",
"crmId": "550e8400-e29b-41d4-a716-446655440000",
"tagIds": ["<string>"],
"ongoingMonitoring": True
}
headers = {
"x-tenant": "<x-tenant>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-tenant': '<x-tenant>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
identities: [
{
number: 'A123456789',
subtype: '<string>',
expiresAt: '2030-12-31',
issuingCountryCode: 'SA',
documentIds: ['<string>']
}
],
nameEn: 'John Michael Doe',
nameAr: 'جون ميخائيل دو',
email: 'john.doe@example.com',
countryCode: '966',
phoneNumber: '501234567',
accountOpenDate: '2025-06-15',
dobGregorian: '1990-05-20',
dobHijri: '1410-10-15',
dateOfIncorporationGregorian: '2005-09-30',
dateOfIncorporationHijri: '1426-08-20',
nationalityCode: 'SA',
crmId: '550e8400-e29b-41d4-a716-446655440000',
tagIds: ['<string>'],
ongoingMonitoring: true
})
};
fetch('https://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status', 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://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'identities' => [
[
'number' => 'A123456789',
'subtype' => '<string>',
'expiresAt' => '2030-12-31',
'issuingCountryCode' => 'SA',
'documentIds' => [
'<string>'
]
]
],
'nameEn' => 'John Michael Doe',
'nameAr' => 'جون ميخائيل دو',
'email' => 'john.doe@example.com',
'countryCode' => '966',
'phoneNumber' => '501234567',
'accountOpenDate' => '2025-06-15',
'dobGregorian' => '1990-05-20',
'dobHijri' => '1410-10-15',
'dateOfIncorporationGregorian' => '2005-09-30',
'dateOfIncorporationHijri' => '1426-08-20',
'nationalityCode' => 'SA',
'crmId' => '550e8400-e29b-41d4-a716-446655440000',
'tagIds' => [
'<string>'
],
'ongoingMonitoring' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-tenant: <x-tenant>"
],
]);
$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://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status"
payload := strings.NewReader("{\n \"identities\": [\n {\n \"number\": \"A123456789\",\n \"subtype\": \"<string>\",\n \"expiresAt\": \"2030-12-31\",\n \"issuingCountryCode\": \"SA\",\n \"documentIds\": [\n \"<string>\"\n ]\n }\n ],\n \"nameEn\": \"John Michael Doe\",\n \"nameAr\": \"جون ميخائيل دو\",\n \"email\": \"john.doe@example.com\",\n \"countryCode\": \"966\",\n \"phoneNumber\": \"501234567\",\n \"accountOpenDate\": \"2025-06-15\",\n \"dobGregorian\": \"1990-05-20\",\n \"dobHijri\": \"1410-10-15\",\n \"dateOfIncorporationGregorian\": \"2005-09-30\",\n \"dateOfIncorporationHijri\": \"1426-08-20\",\n \"nationalityCode\": \"SA\",\n \"crmId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"tagIds\": [\n \"<string>\"\n ],\n \"ongoingMonitoring\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-tenant", "<x-tenant>")
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.patch("https://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status")
.header("x-tenant", "<x-tenant>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"identities\": [\n {\n \"number\": \"A123456789\",\n \"subtype\": \"<string>\",\n \"expiresAt\": \"2030-12-31\",\n \"issuingCountryCode\": \"SA\",\n \"documentIds\": [\n \"<string>\"\n ]\n }\n ],\n \"nameEn\": \"John Michael Doe\",\n \"nameAr\": \"جون ميخائيل دو\",\n \"email\": \"john.doe@example.com\",\n \"countryCode\": \"966\",\n \"phoneNumber\": \"501234567\",\n \"accountOpenDate\": \"2025-06-15\",\n \"dobGregorian\": \"1990-05-20\",\n \"dobHijri\": \"1410-10-15\",\n \"dateOfIncorporationGregorian\": \"2005-09-30\",\n \"dateOfIncorporationHijri\": \"1426-08-20\",\n \"nationalityCode\": \"SA\",\n \"crmId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"tagIds\": [\n \"<string>\"\n ],\n \"ongoingMonitoring\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.api.getdal.sa/services/crm/entities/screening/{entityId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-tenant"] = '<x-tenant>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identities\": [\n {\n \"number\": \"A123456789\",\n \"subtype\": \"<string>\",\n \"expiresAt\": \"2030-12-31\",\n \"issuingCountryCode\": \"SA\",\n \"documentIds\": [\n \"<string>\"\n ]\n }\n ],\n \"nameEn\": \"John Michael Doe\",\n \"nameAr\": \"جون ميخائيل دو\",\n \"email\": \"john.doe@example.com\",\n \"countryCode\": \"966\",\n \"phoneNumber\": \"501234567\",\n \"accountOpenDate\": \"2025-06-15\",\n \"dobGregorian\": \"1990-05-20\",\n \"dobHijri\": \"1410-10-15\",\n \"dateOfIncorporationGregorian\": \"2005-09-30\",\n \"dateOfIncorporationHijri\": \"1426-08-20\",\n \"nationalityCode\": \"SA\",\n \"crmId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"tagIds\": [\n \"<string>\"\n ],\n \"ongoingMonitoring\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"archivedAt": "2025-12-04 12:00:00.000",
"crmId": "550e8400-e29b-41d4-a716-446655440000",
"type": "Individual",
"email": "john.doe@example.com",
"nameEn": "John Michael Doe",
"nameAr": "جون ميخائيل دو",
"status": "Active",
"verificationBlocked": "Identity",
"classification": "Retail",
"category": "Retail",
"gender": "Male",
"countryCode": "966",
"phoneNumber": "501234567",
"accountOpenDate": "2025-06-15",
"dob": "1990-05-20",
"dateOfIncorporation": "2005-09-30",
"netIncome": "10500",
"netAssets": "20750",
"ongoingMonitoring": true,
"identities": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"verifiedAt": "2024-06-18",
"expiresAt": "2030-12-31",
"type": "Passport",
"subtype": "Iqama",
"number": "A123456789",
"issuingCountryCode": "SA",
"selfie": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
},
"documents": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"verification": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"status": "Pending",
"source": "Manual"
}
}
],
"nationalityCode": "SA",
"nationality": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "<string>",
"nameAr": "<string>",
"nationalityEn": "<string>",
"nationalityAr": "<string>",
"twoCode": "<string>",
"threeCode": "<string>"
},
"kyc": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"status": "KycComplete",
"completedAt": "2025-12-04 12:00:00.000",
"eddStatus": "Pending",
"qualifiedStatus": "Approved",
"entityId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"flowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"rmId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"rm": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
},
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"reason": "Default",
"riskBreakdown": {
"sectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"score": "45",
"maxScore": "50"
},
"riskScore": "85",
"riskLevel": "Medium",
"suitabilityScore": "90",
"suitabilitySucceeded": true,
"localMatchCount": 123,
"publicMatchCount": 123,
"overrideReasons": [
{
"category": "Question",
"case": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"archivedAt": "2025-12-04 12:00:00.000",
"matchedAt": "2025-12-04 12:00:00.000",
"source": "Nafith",
"status": "Pending",
"makerUserId": {},
"checkerUserId": {},
"entityId": {},
"customGroupId": {},
"originWatchlistId": {},
"indicatorSummaries": {
"count": 83,
"category": "News Media",
"isNetwork": false
},
"makerUser": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
},
"checkerUser": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
},
"entity": null,
"customGroup": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "<string>",
"description": {},
"userIds": [
"<string>"
],
"users": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
]
},
"originWatchlist": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"orderNumber": "<string>",
"resolutionNumber": {},
"idType": "NationalIdentity",
"idNumber": {},
"requestType": "Unblocking",
"amount": {},
"previousOrderNumber": {},
"banStatus": "Prohibited",
"timeOfRequest": "2023-11-07T05:31:56Z",
"name": {},
"unifiedNumber": {},
"source": "Nafith",
"isValid": true,
"nationality": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "<string>",
"nameAr": "<string>",
"nationalityEn": "<string>",
"nationalityAr": "<string>",
"twoCode": "<string>",
"threeCode": "<string>"
},
"attachment": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
},
"tags": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "<string>",
"nameAr": {},
"scope": "Watchlist"
}
]
},
"matchSummaries": [
{
"status": "Unreviewed",
"count": 123
}
],
"matches": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"deprecatedAt": "2025-12-04 12:00:00.000",
"criteria": "Identity",
"name": "John Doe",
"percentage": 85,
"riskScore": 75,
"status": "Unreviewed",
"reasons": [
"Name"
],
"comment": {},
"indicatorSummaries": {
"count": 83,
"category": "News Media",
"isNetwork": false
},
"matchingScore": {},
"matchedAlias": {},
"recommendation": "AutoMatch",
"signals": {
"name": {
"familyJW": 0.95,
"firstNameJW": 0.92,
"givenTokenScore": 0.88,
"fullJW": 0.93,
"phoneticScore": 0.85,
"exactNormalized": false,
"totalScore": 123
},
"dob": {
"score": 123,
"neglectScore": true
},
"gender": {
"score": 123,
"neglectScore": true
},
"nationality": {
"score": 123,
"neglectScore": true
},
"location": {
"score": 123,
"neglectScore": true
},
"identity": {
"matched": true,
"number": {},
"label": {}
}
},
"caseId": "<string>",
"sigmaId": {},
"gender": "Male",
"watchlistSource": "Nafith"
}
],
"relationshipCases": null,
"transactionAlerts": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"caseId": "<string>",
"severity": "Low",
"isCorrect": {},
"flagCategory": "ExternalAuthority",
"dispositionAt": "2023-11-07T05:31:56Z",
"transactionRule": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"activatedAt": "2023-11-07T05:31:56Z",
"nameEn": "<string>",
"nameAr": "<string>",
"descriptionEn": "<string>",
"descriptionAr": "<string>",
"code": "<string>",
"status": "Published",
"type": "Hard",
"autoSuspended": true,
"config": {},
"configVariables": {}
},
"dispositionBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
},
"notes": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"title": {},
"description": "<string>",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"transactions": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"externalRef": "<string>",
"orderRef": {},
"sourceSystem": "TenantDirect",
"transactionDate": "2023-11-07T05:31:56Z",
"valueDate": "2023-11-07T05:31:56Z",
"settlementDate": "2023-11-07T05:31:56Z",
"status": "Received",
"reviewStatus": "Unreviewed",
"amount": "<string>",
"currency": "Sar",
"exchangeRate": {},
"paymentForm": "BankTransfer",
"paymentType": "Deposit",
"internalTransferReason": "FundSubscription",
"securityDetails": {},
"correctsTransactionId": {},
"sourceEntity": "<unknown>",
"suspiciousSeverity": "Low",
"isBlocked": true,
"direction": "Credit",
"targetEntity": "<unknown>",
"sourceWallet": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"type": "ClientCash",
"status": "Draft",
"currency": "Sar",
"externalRef": {},
"vIban": {},
"availableBalance": "<string>",
"lockedBalance": "<string>",
"entityId": {},
"productId": {},
"lastTransactionAt": "2023-11-07T05:31:56Z",
"dormantAt": "2023-11-07T05:31:56Z",
"closedAt": "2023-11-07T05:31:56Z"
},
"targetWallet": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"type": "ClientCash",
"status": "Draft",
"currency": "Sar",
"externalRef": {},
"vIban": {},
"availableBalance": "<string>",
"lockedBalance": "<string>",
"entityId": {},
"productId": {},
"lastTransactionAt": "2023-11-07T05:31:56Z",
"dormantAt": "2023-11-07T05:31:56Z",
"closedAt": "2023-11-07T05:31:56Z"
},
"sourceBankAccount": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"iban": "GB33BUKB20201555555555",
"primary": true,
"bankNameEn": "Bank of Saudi",
"bankNameAr": "بنك السعودي",
"swiftCode": "BOSAUS3N",
"bankCode": "123456",
"holderName": "John Doe",
"status": "Active",
"source": "Automatic",
"verificationStatus": "Verified",
"attachment": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
},
"entity": "<unknown>"
},
"targetBankAccount": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"iban": "GB33BUKB20201555555555",
"primary": true,
"bankNameEn": "Bank of Saudi",
"bankNameAr": "بنك السعودي",
"swiftCode": "BOSAUS3N",
"bankCode": "123456",
"holderName": "John Doe",
"status": "Active",
"source": "Automatic",
"verificationStatus": "Verified",
"attachment": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
},
"entity": "<unknown>"
},
"strReport": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"status": "Draft",
"attachmentId": "<string>",
"transactionId": "<string>"
},
"triggeredAlerts": "<array>",
"activities": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"type": "ReviewStatusChange",
"reason": "RuleBased",
"reviewStatus": "Unreviewed",
"actor": "Crm",
"authorityRef": {},
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
},
"notes": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"title": {},
"description": "<string>",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"attachments": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
]
}
],
"tags": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "<string>",
"nameAr": {},
"scope": "Watchlist"
}
]
}
]
}
]
},
"question": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "What is your employment status?",
"nameAr": "ما هو وضعك الوظيفي؟",
"labelEn": "Please select your employment status",
"labelAr": "يرجى اختيار وضعك الوظيفي",
"required": true,
"type": "ShortText",
"allowMultiple": false,
"additionalInfoType": "ShortText",
"category": "Nationality",
"unit": "Currency",
"answerSource": "Dal",
"kycFlowId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"sortOrder": 1,
"subweights": 50,
"options": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
}
],
"answer": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"openAnswer": "I prefer Option A",
"attachments": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"questionId": "e085b776-fb4f-4454-b679-e8b14ba52e97",
"answerToOptions": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"option": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
},
"additionalInfo": "12.5"
}
],
"multipleChoiceAnswers": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
}
]
},
"sections": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Personal Information",
"nameAr": "المعلومات الشخصية",
"sortOrder": 1,
"formId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"form": "<unknown>",
"weights": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"value": 10
}
],
"questions": "<array>"
}
]
}
}
],
"reviews": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"status": "Approved",
"type": "First",
"comment": {},
"kycScoreId": "<string>",
"formId": "<string>",
"userId": "<string>",
"user": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
]
}
],
"remainingAttempts": 3,
"progress": {
"Kyc": "Complete",
"RiskAssessment": "Medium",
"Suitability": "Suitable",
"Edd": "Pending",
"QualifiedInvestor": "Pending",
"Aoa": true
},
"flow": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Retail KYC Flow",
"nameAr": "مسار الافراد",
"status": "Published",
"entityType": "Individual",
"classifications": [
"Retail"
],
"emailInvitationEnabled": true,
"idVerificationEnabled": true,
"selfSignupEnabled": true,
"clientEmailsEnabled": true,
"associationVerificationPreference": "Manual",
"monitoringTrigger": "Verification",
"pauseMonitoringAfter": 123,
"retakeLowAfter": 123,
"retakeMediumAfter": 123,
"retakeHighAfter": 123,
"riskSettings": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"lowScore": 1,
"mediumScore": 3,
"highScore": 5,
"lowThreshold": "1.0",
"mediumThreshold": "2.3",
"highThreshold": "3.6",
"maxThreshold": "5.0",
"localThreshold": 60,
"publicThreshold": 70
}
],
"suitabilitySettings": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"successPercentage": 75,
"attempts": 3
}
],
"forms": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"type": "Kyc",
"nameEn": "Risk Assessment",
"nameAr": "تقييم المخاطر",
"requestType": "DisclosureAndBlocking",
"source": "Nafith",
"status": "Published",
"submissions": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"submittedAt": "2023-11-07T05:31:56Z",
"attempt": 123,
"suitabilityScore": {},
"suitabilitySucceeded": {},
"enabledQuestions": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "What is your employment status?",
"nameAr": "ما هو وضعك الوظيفي؟",
"labelEn": "Please select your employment status",
"labelAr": "يرجى اختيار وضعك الوظيفي",
"required": true,
"type": "ShortText",
"allowMultiple": false,
"additionalInfoType": "ShortText",
"category": "Nationality",
"unit": "Currency",
"answerSource": "Dal",
"kycFlowId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"sortOrder": 1,
"subweights": 50,
"options": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
}
],
"answer": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"openAnswer": "I prefer Option A",
"attachments": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"questionId": "e085b776-fb4f-4454-b679-e8b14ba52e97",
"answerToOptions": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"option": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
},
"additionalInfo": "12.5"
}
],
"multipleChoiceAnswers": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
}
]
},
"sections": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Personal Information",
"nameAr": "المعلومات الشخصية",
"sortOrder": 1,
"formId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"form": "<unknown>",
"weights": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"value": 10
}
],
"questions": "<array>"
}
]
}
],
"answers": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"openAnswer": "I prefer Option A",
"attachments": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"questionId": "e085b776-fb4f-4454-b679-e8b14ba52e97",
"answerToOptions": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"option": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
},
"additionalInfo": "12.5"
}
],
"multipleChoiceAnswers": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Option A",
"nameAr": "الخيار أ",
"sortOrder": 0,
"additionalInfoEnabled": false,
"min": 1000,
"max": 1000000,
"scores": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"override": false,
"riskLevel": "Low",
"modifiedByUser": true,
"syncedRiskAt": "2024-01-01T00:00:00.000Z",
"blocking": false,
"suitabilityScore": 8,
"countryRisk": {
"score": 42.5,
"corruptionScore": 35,
"financialCrimeScore": 50,
"geopoliticalScore": 40,
"regulationScore": 45,
"grade": "Medium"
}
}
]
}
]
}
]
}
],
"kycReviews": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"status": "Approved",
"type": "First",
"comment": {},
"kycScoreId": "<string>",
"formId": "<string>",
"userId": "<string>",
"user": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
}
],
"sections": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Personal Information",
"nameAr": "المعلومات الشخصية",
"sortOrder": 1,
"formId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"form": "<unknown>",
"weights": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"classification": "Retail",
"value": 10
}
],
"questions": "<array>"
}
]
}
]
}
},
"verifications": {
"identity": false,
"email": false,
"phoneNumber": false,
"address": false,
"bankAccount": false
},
"tags": [
{
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "<string>",
"nameAr": {},
"scope": "Watchlist"
}
]
},
"creationStatus": "Created"
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
},
"validationErrors": [
"<string>"
]
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
}
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
}
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
}
}