View KYC Flow

curl --request GET \
  --url https://app.api.getdal.sa/services/crm/kyc-flows/{flowId} \
  --header 'x-api-key: <api-key>' \
  --header 'x-tenant: <x-tenant>'

import requests

url = "https://app.api.getdal.sa/services/crm/kyc-flows/{flowId}"

headers = {
    "x-tenant": "<x-tenant>",
    "x-api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-tenant': '<x-tenant>', 'x-api-key': '<api-key>'}};

fetch('https://app.api.getdal.sa/services/crm/kyc-flows/{flowId}', 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/kyc-flows/{flowId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://app.api.getdal.sa/services/crm/kyc-flows/{flowId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-tenant", "<x-tenant>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.api.getdal.sa/services/crm/kyc-flows/{flowId}")
  .header("x-tenant", "<x-tenant>")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.api.getdal.sa/services/crm/kyc-flows/{flowId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-tenant"] = '<x-tenant>'
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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>"
        }
      ]
    }
  ]
}

{
  "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": "لم يتم العثور على السجل المطلوب"
  }
}