Perform CDD
curl --request POST \
--url https://api.godiligent.ai/cdds \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"website": "example.com",
"email": "fulan@domain.com",
"legal_name": "PayLane Sp. z o.o.",
"address": "Am Generalshof 12, 10117 Berlin, Germany",
"external_id": "1538c2f9-ff0f-489e-0099-a5f116a4af07",
"vat_number": "BE09999999XX.",
"register_number": "12345678",
"registry_access_code": "0000-0000-0000",
"country_code": "DE",
"description": "Software consultancy",
"contact_person": {
"name": "<string>",
"email": "jsmith@example.com",
"country_code": "<string>",
"address": "<string>",
"phone_number": "<string>",
"ip": "127.0.0.1"
},
"risk_check_set_id": "550e8400-e29b-41d4-a716-446655440000",
"pull_registry_documents": true,
"trading_name": "Acme Trading Co",
"trading_address": "123 Trade Street, London"
}
'import requests
url = "https://api.godiligent.ai/cdds"
payload = {
"website": "example.com",
"email": "fulan@domain.com",
"legal_name": "PayLane Sp. z o.o.",
"address": "Am Generalshof 12, 10117 Berlin, Germany",
"external_id": "1538c2f9-ff0f-489e-0099-a5f116a4af07",
"vat_number": "BE09999999XX.",
"register_number": "12345678",
"registry_access_code": "0000-0000-0000",
"country_code": "DE",
"description": "Software consultancy",
"contact_person": {
"name": "<string>",
"email": "jsmith@example.com",
"country_code": "<string>",
"address": "<string>",
"phone_number": "<string>",
"ip": "127.0.0.1"
},
"risk_check_set_id": "550e8400-e29b-41d4-a716-446655440000",
"pull_registry_documents": True,
"trading_name": "Acme Trading Co",
"trading_address": "123 Trade Street, London"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
website: 'example.com',
email: 'fulan@domain.com',
legal_name: 'PayLane Sp. z o.o.',
address: 'Am Generalshof 12, 10117 Berlin, Germany',
external_id: '1538c2f9-ff0f-489e-0099-a5f116a4af07',
vat_number: 'BE09999999XX.',
register_number: '12345678',
registry_access_code: '0000-0000-0000',
country_code: 'DE',
description: 'Software consultancy',
contact_person: {
name: '<string>',
email: 'jsmith@example.com',
country_code: '<string>',
address: '<string>',
phone_number: '<string>',
ip: '127.0.0.1'
},
risk_check_set_id: '550e8400-e29b-41d4-a716-446655440000',
pull_registry_documents: true,
trading_name: 'Acme Trading Co',
trading_address: '123 Trade Street, London'
})
};
fetch('https://api.godiligent.ai/cdds', 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://api.godiligent.ai/cdds",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'website' => 'example.com',
'email' => 'fulan@domain.com',
'legal_name' => 'PayLane Sp. z o.o.',
'address' => 'Am Generalshof 12, 10117 Berlin, Germany',
'external_id' => '1538c2f9-ff0f-489e-0099-a5f116a4af07',
'vat_number' => 'BE09999999XX.',
'register_number' => '12345678',
'registry_access_code' => '0000-0000-0000',
'country_code' => 'DE',
'description' => 'Software consultancy',
'contact_person' => [
'name' => '<string>',
'email' => 'jsmith@example.com',
'country_code' => '<string>',
'address' => '<string>',
'phone_number' => '<string>',
'ip' => '127.0.0.1'
],
'risk_check_set_id' => '550e8400-e29b-41d4-a716-446655440000',
'pull_registry_documents' => true,
'trading_name' => 'Acme Trading Co',
'trading_address' => '123 Trade Street, London'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.godiligent.ai/cdds"
payload := strings.NewReader("{\n \"website\": \"example.com\",\n \"email\": \"fulan@domain.com\",\n \"legal_name\": \"PayLane Sp. z o.o.\",\n \"address\": \"Am Generalshof 12, 10117 Berlin, Germany\",\n \"external_id\": \"1538c2f9-ff0f-489e-0099-a5f116a4af07\",\n \"vat_number\": \"BE09999999XX.\",\n \"register_number\": \"12345678\",\n \"registry_access_code\": \"0000-0000-0000\",\n \"country_code\": \"DE\",\n \"description\": \"Software consultancy\",\n \"contact_person\": {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"country_code\": \"<string>\",\n \"address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"ip\": \"127.0.0.1\"\n },\n \"risk_check_set_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"pull_registry_documents\": true,\n \"trading_name\": \"Acme Trading Co\",\n \"trading_address\": \"123 Trade Street, London\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.godiligent.ai/cdds")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"website\": \"example.com\",\n \"email\": \"fulan@domain.com\",\n \"legal_name\": \"PayLane Sp. z o.o.\",\n \"address\": \"Am Generalshof 12, 10117 Berlin, Germany\",\n \"external_id\": \"1538c2f9-ff0f-489e-0099-a5f116a4af07\",\n \"vat_number\": \"BE09999999XX.\",\n \"register_number\": \"12345678\",\n \"registry_access_code\": \"0000-0000-0000\",\n \"country_code\": \"DE\",\n \"description\": \"Software consultancy\",\n \"contact_person\": {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"country_code\": \"<string>\",\n \"address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"ip\": \"127.0.0.1\"\n },\n \"risk_check_set_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"pull_registry_documents\": true,\n \"trading_name\": \"Acme Trading Co\",\n \"trading_address\": \"123 Trade Street, London\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.godiligent.ai/cdds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"website\": \"example.com\",\n \"email\": \"fulan@domain.com\",\n \"legal_name\": \"PayLane Sp. z o.o.\",\n \"address\": \"Am Generalshof 12, 10117 Berlin, Germany\",\n \"external_id\": \"1538c2f9-ff0f-489e-0099-a5f116a4af07\",\n \"vat_number\": \"BE09999999XX.\",\n \"register_number\": \"12345678\",\n \"registry_access_code\": \"0000-0000-0000\",\n \"country_code\": \"DE\",\n \"description\": \"Software consultancy\",\n \"contact_person\": {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"country_code\": \"<string>\",\n \"address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"ip\": \"127.0.0.1\"\n },\n \"risk_check_set_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"pull_registry_documents\": true,\n \"trading_name\": \"Acme Trading Co\",\n \"trading_address\": \"123 Trade Street, London\"\n}"
response = http.request(request)
puts response.read_body{
"id": "a91a8416-0a38-49e5-887e-8437519b3e78",
"state": "INITIATED",
"input": {
"website": "https://example.com",
"email": "fulan@domain.com",
"legal_name": "PayLane Sp. z o.o.",
"registry_profile": "FULL",
"address": "Am Generalshof 12, 10117 Berlin, Germany",
"external_id": "1538c2f9-ff0f-489e-0099-a5f116a4af07",
"vat_number": "BE09999999XX."
},
"created_at": "2024-03-20T15:18:36.803Z",
"updated_at": "2024-03-20T15:20:12.456Z"
}{
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}{
"error": "Conflict: Idempotency key already used with different payload"
}Customer Due Diligence
Perform CDD
Perform Customer Due Diligence checks
POST
/
cdds
Perform CDD
curl --request POST \
--url https://api.godiligent.ai/cdds \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"website": "example.com",
"email": "fulan@domain.com",
"legal_name": "PayLane Sp. z o.o.",
"address": "Am Generalshof 12, 10117 Berlin, Germany",
"external_id": "1538c2f9-ff0f-489e-0099-a5f116a4af07",
"vat_number": "BE09999999XX.",
"register_number": "12345678",
"registry_access_code": "0000-0000-0000",
"country_code": "DE",
"description": "Software consultancy",
"contact_person": {
"name": "<string>",
"email": "jsmith@example.com",
"country_code": "<string>",
"address": "<string>",
"phone_number": "<string>",
"ip": "127.0.0.1"
},
"risk_check_set_id": "550e8400-e29b-41d4-a716-446655440000",
"pull_registry_documents": true,
"trading_name": "Acme Trading Co",
"trading_address": "123 Trade Street, London"
}
'import requests
url = "https://api.godiligent.ai/cdds"
payload = {
"website": "example.com",
"email": "fulan@domain.com",
"legal_name": "PayLane Sp. z o.o.",
"address": "Am Generalshof 12, 10117 Berlin, Germany",
"external_id": "1538c2f9-ff0f-489e-0099-a5f116a4af07",
"vat_number": "BE09999999XX.",
"register_number": "12345678",
"registry_access_code": "0000-0000-0000",
"country_code": "DE",
"description": "Software consultancy",
"contact_person": {
"name": "<string>",
"email": "jsmith@example.com",
"country_code": "<string>",
"address": "<string>",
"phone_number": "<string>",
"ip": "127.0.0.1"
},
"risk_check_set_id": "550e8400-e29b-41d4-a716-446655440000",
"pull_registry_documents": True,
"trading_name": "Acme Trading Co",
"trading_address": "123 Trade Street, London"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
website: 'example.com',
email: 'fulan@domain.com',
legal_name: 'PayLane Sp. z o.o.',
address: 'Am Generalshof 12, 10117 Berlin, Germany',
external_id: '1538c2f9-ff0f-489e-0099-a5f116a4af07',
vat_number: 'BE09999999XX.',
register_number: '12345678',
registry_access_code: '0000-0000-0000',
country_code: 'DE',
description: 'Software consultancy',
contact_person: {
name: '<string>',
email: 'jsmith@example.com',
country_code: '<string>',
address: '<string>',
phone_number: '<string>',
ip: '127.0.0.1'
},
risk_check_set_id: '550e8400-e29b-41d4-a716-446655440000',
pull_registry_documents: true,
trading_name: 'Acme Trading Co',
trading_address: '123 Trade Street, London'
})
};
fetch('https://api.godiligent.ai/cdds', 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://api.godiligent.ai/cdds",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'website' => 'example.com',
'email' => 'fulan@domain.com',
'legal_name' => 'PayLane Sp. z o.o.',
'address' => 'Am Generalshof 12, 10117 Berlin, Germany',
'external_id' => '1538c2f9-ff0f-489e-0099-a5f116a4af07',
'vat_number' => 'BE09999999XX.',
'register_number' => '12345678',
'registry_access_code' => '0000-0000-0000',
'country_code' => 'DE',
'description' => 'Software consultancy',
'contact_person' => [
'name' => '<string>',
'email' => 'jsmith@example.com',
'country_code' => '<string>',
'address' => '<string>',
'phone_number' => '<string>',
'ip' => '127.0.0.1'
],
'risk_check_set_id' => '550e8400-e29b-41d4-a716-446655440000',
'pull_registry_documents' => true,
'trading_name' => 'Acme Trading Co',
'trading_address' => '123 Trade Street, London'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.godiligent.ai/cdds"
payload := strings.NewReader("{\n \"website\": \"example.com\",\n \"email\": \"fulan@domain.com\",\n \"legal_name\": \"PayLane Sp. z o.o.\",\n \"address\": \"Am Generalshof 12, 10117 Berlin, Germany\",\n \"external_id\": \"1538c2f9-ff0f-489e-0099-a5f116a4af07\",\n \"vat_number\": \"BE09999999XX.\",\n \"register_number\": \"12345678\",\n \"registry_access_code\": \"0000-0000-0000\",\n \"country_code\": \"DE\",\n \"description\": \"Software consultancy\",\n \"contact_person\": {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"country_code\": \"<string>\",\n \"address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"ip\": \"127.0.0.1\"\n },\n \"risk_check_set_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"pull_registry_documents\": true,\n \"trading_name\": \"Acme Trading Co\",\n \"trading_address\": \"123 Trade Street, London\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.godiligent.ai/cdds")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"website\": \"example.com\",\n \"email\": \"fulan@domain.com\",\n \"legal_name\": \"PayLane Sp. z o.o.\",\n \"address\": \"Am Generalshof 12, 10117 Berlin, Germany\",\n \"external_id\": \"1538c2f9-ff0f-489e-0099-a5f116a4af07\",\n \"vat_number\": \"BE09999999XX.\",\n \"register_number\": \"12345678\",\n \"registry_access_code\": \"0000-0000-0000\",\n \"country_code\": \"DE\",\n \"description\": \"Software consultancy\",\n \"contact_person\": {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"country_code\": \"<string>\",\n \"address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"ip\": \"127.0.0.1\"\n },\n \"risk_check_set_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"pull_registry_documents\": true,\n \"trading_name\": \"Acme Trading Co\",\n \"trading_address\": \"123 Trade Street, London\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.godiligent.ai/cdds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"website\": \"example.com\",\n \"email\": \"fulan@domain.com\",\n \"legal_name\": \"PayLane Sp. z o.o.\",\n \"address\": \"Am Generalshof 12, 10117 Berlin, Germany\",\n \"external_id\": \"1538c2f9-ff0f-489e-0099-a5f116a4af07\",\n \"vat_number\": \"BE09999999XX.\",\n \"register_number\": \"12345678\",\n \"registry_access_code\": \"0000-0000-0000\",\n \"country_code\": \"DE\",\n \"description\": \"Software consultancy\",\n \"contact_person\": {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"country_code\": \"<string>\",\n \"address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"ip\": \"127.0.0.1\"\n },\n \"risk_check_set_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"pull_registry_documents\": true,\n \"trading_name\": \"Acme Trading Co\",\n \"trading_address\": \"123 Trade Street, London\"\n}"
response = http.request(request)
puts response.read_body{
"id": "a91a8416-0a38-49e5-887e-8437519b3e78",
"state": "INITIATED",
"input": {
"website": "https://example.com",
"email": "fulan@domain.com",
"legal_name": "PayLane Sp. z o.o.",
"registry_profile": "FULL",
"address": "Am Generalshof 12, 10117 Berlin, Germany",
"external_id": "1538c2f9-ff0f-489e-0099-a5f116a4af07",
"vat_number": "BE09999999XX."
},
"created_at": "2024-03-20T15:18:36.803Z",
"updated_at": "2024-03-20T15:20:12.456Z"
}{
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}{
"error": "Conflict: Idempotency key already used with different payload"
}Authorizations
Headers
Optional idempotency key to ensure the same request is not processed multiple times. If the same key is sent with a different payload, a 409 Conflict error is returned. The result is cached for 7 days.
Body
application/json
- Option 1
- Option 2
- Option 3
The website of the business
Example:
"example.com"
The email of the business
Example:
"fulan@domain.com"
The legal name of the business
Example:
"PayLane Sp. z o.o."
The address of the business
Example:
"Am Generalshof 12, 10117 Berlin, Germany"
Reference to be used in the customer's system
Example:
"1538c2f9-ff0f-489e-0099-a5f116a4af07"
The VAT number of the business
Example:
"BE09999999XX."
The registry number of the business (i.e. company house number, SIRET, SIREN, P.IVA, only GB, FR and IT companies are supported)
Example:
"12345678"
Portuguese registry access code used to retrieve the official registry document: the 12 character validation code from Portal das Finanças for sole traders, or the certidão permanente access code (0000-0000-0000) from Registo de Justiça for companies. Requires country_code PT and register_number set to the NIF/NIPC.
Example:
"0000-0000-0000"
Country code in ISO 3166-1 alpha-2 format
Example:
"DE"
The description of the business
Example:
"Software consultancy"
Available options:
FULL, BASIC Contact person details. At least one of 'name' or 'email' must be provided if the object exists.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
The risk check set id, if not set the default risk check set will be used
Example:
"550e8400-e29b-41d4-a716-446655440000"
Whether to pull registry documents for the company (Only supported for DE, and IT)
Example:
true
The trading name (DBA) of the business
Example:
"Acme Trading Co"
The trading address of the business
Example:
"123 Trade Street, London"
Response
OK
The id of the CDD request
Example:
"a91a8416-0a38-49e5-887e-8437519b3e78"
The state of the CDD process
Available options:
INITIATED, IN_PROGRESS, RUNNING_CHECKS, COMPLETED, INCONCLUSIVE, FAILED Example:
"INITIATED"
What was used to perform the CDD
Show child attributes
Show child attributes
Example:
"2024-03-20T15:18:36.803Z"
Example:
"2024-03-20T15:20:12.456Z"
⌘I