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",
  "country_code": "DE",
  "description": "Software consultancy",
  "registry_profile": "FULL",
  "contact_person": {
    "name": "<string>",
    "email": "jsmith@example.com",
    "country_code": "<string>",
    "address": "<string>",
    "phone_number": "<string>"
  },
  "risk_check_set_id": "550e8400-e29b-41d4-a716-446655440000",
  "pull_registry_documents": true
}'
{
  "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"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
website
string
required

The website of the business

Example:

"example.com"

​
email
string

The email of the business

Example:

"fulan@domain.com"

​
legal_name
string

The legal name of the business

Example:

"PayLane Sp. z o.o."

​
address
string

The address of the business

Example:

"Am Generalshof 12, 10117 Berlin, Germany"

​
external_id
string

Reference to be used in the customer's system

Example:

"1538c2f9-ff0f-489e-0099-a5f116a4af07"

​
vat_number
string

The VAT number of the business

Example:

"BE09999999XX."

​
register_number
string

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"

​
country_code
string

Country code in ISO 3166-1 alpha-2 format

Example:

"DE"

​
description
string

The description of the business

Example:

"Software consultancy"

​
registry_profile
enum<string>
Available options:
FULL,
BASIC
​
contact_person
object

Contact person details. At least one of 'name' or 'email' must be provided if the object exists.

​
risk_check_set_id
string

The risk check set id, if not set the default risk check set will be used

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
pull_registry_documents
boolean
default:false

Whether to pull registry documents for the company (Only supported for DE, and IT)

Example:

true

Response

OK

​
id
string

The id of the CDD request

Example:

"a91a8416-0a38-49e5-887e-8437519b3e78"

​
state
enum<string>

The state of the CDD process

Available options:
INITIATED,
IN_PROGRESS,
RUNNING_CHECKS,
COMPLETED,
INCONCLUSIVE,
FAILED
Example:

"INITIATED"

​
input
object

What was used to perform the CDD

​
created_at
string<ISO8601>
Example:

"2024-03-20T15:18:36.803Z"