KYC
Enable KYC form
Enable a KYC form (Qualified or EDD) for submission by prospect
PATCH
/
kyc
/
{kycId}
/
forms
/
{formId}
/
enable
Enable KYC form
curl --request PATCH \
--url https://app.api.getdal.sa/services/crm/kyc/{kycId}/forms/{formId}/enable \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-tenant: <x-tenant>' \
--data '
{
"enabledQuestionIds": [
"<string>"
]
}
'import requests
url = "https://app.api.getdal.sa/services/crm/kyc/{kycId}/forms/{formId}/enable"
payload = { "enabledQuestionIds": ["<string>"] }
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({enabledQuestionIds: ['<string>']})
};
fetch('https://app.api.getdal.sa/services/crm/kyc/{kycId}/forms/{formId}/enable', 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/{kycId}/forms/{formId}/enable",
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([
'enabledQuestionIds' => [
'<string>'
]
]),
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/kyc/{kycId}/forms/{formId}/enable"
payload := strings.NewReader("{\n \"enabledQuestionIds\": [\n \"<string>\"\n ]\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/kyc/{kycId}/forms/{formId}/enable")
.header("x-tenant", "<x-tenant>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabledQuestionIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.api.getdal.sa/services/crm/kyc/{kycId}/forms/{formId}/enable")
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 \"enabledQuestionIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"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
Body
application/json
Response
Success
Value Indicating process completion or failure, [Recommendation] Programatically check the HTTP status code to confirm the result of the operation if needed.
Example:
true
⌘I
Enable KYC form
curl --request PATCH \
--url https://app.api.getdal.sa/services/crm/kyc/{kycId}/forms/{formId}/enable \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-tenant: <x-tenant>' \
--data '
{
"enabledQuestionIds": [
"<string>"
]
}
'import requests
url = "https://app.api.getdal.sa/services/crm/kyc/{kycId}/forms/{formId}/enable"
payload = { "enabledQuestionIds": ["<string>"] }
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({enabledQuestionIds: ['<string>']})
};
fetch('https://app.api.getdal.sa/services/crm/kyc/{kycId}/forms/{formId}/enable', 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/{kycId}/forms/{formId}/enable",
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([
'enabledQuestionIds' => [
'<string>'
]
]),
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/kyc/{kycId}/forms/{formId}/enable"
payload := strings.NewReader("{\n \"enabledQuestionIds\": [\n \"<string>\"\n ]\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/kyc/{kycId}/forms/{formId}/enable")
.header("x-tenant", "<x-tenant>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabledQuestionIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.api.getdal.sa/services/crm/kyc/{kycId}/forms/{formId}/enable")
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 \"enabledQuestionIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"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": "لم يتم العثور على السجل المطلوب"
}
}