List CDDs - Godiligent API Documentation

Get list of CDD

curl --request GET \
  --url https://api.godiligent.ai/cdds \
  --header 'X-API-KEY: <api-key>'

{
  "count": 1,
  "cases": [
    {
      "id": "d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4",
      "state": "COMPLETED",
      "input": {
        "website": "https://example.com",
        "email": "[email protected]",
        "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",
      "checks": {
        "verdict": "ACCEPT",
        "groups": [
          {
            "name": "onboarding",
            "action": "ACCEPT"
          }
        ]
      }
    }
  ]
}

GET

cdds

Get list of CDD

curl --request GET \
  --url https://api.godiligent.ai/cdds \
  --header 'X-API-KEY: <api-key>'

{
  "count": 1,
  "cases": [
    {
      "id": "d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4",
      "state": "COMPLETED",
      "input": {
        "website": "https://example.com",
        "email": "[email protected]",
        "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",
      "checks": {
        "verdict": "ACCEPT",
        "groups": [
          {
            "name": "onboarding",
            "action": "ACCEPT"
          }
        ]
      }
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

from

string<date-time>

Start date for filtering CDD cases (optional)

string<date-time>

End date for filtering CDD cases (optional)

Response

count

integer

Example:

1

cases

object[]

Show child attributes

cases.id

string

Example:

"d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4"

cases.state

enum<string>

Available options:

INITIATED,

COMPLETED,

FAILED

Example:

"COMPLETED"

cases.input

object

What was used to perform the CDD

Show child attributes

cases.input.website

string

The website of the business

Example:

"https://example.com"

cases.input.email

string

The email of the business

Example:

"[email protected]"

cases.input.legal_name

string

The legal name of the business

Example:

"PayLane Sp. z o.o."

cases.input.registry_profile

enum<string>

Available options:

FULL,

BASIC

cases.input.address

string

The address of the business

Example:

"Am Generalshof 12, 10117 Berlin, Germany"

cases.input.external_id

string

Reference to be used in the customer's system

Example:

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

cases.input.vat_number

string

The VAT number of the business

Example:

"BE09999999XX."

cases.created_at

string<ISO8601>

Example:

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

cases.checks

object

Show child attributes

cases.checks.verdict

enum<string>

The final verdict of the CDD

Available options:

ACCEPT,

REVIEW,

REJECT

Example:

"ACCEPT"

cases.checks.groups

object[]

The groups of checks configured by the user

Show child attributes

cases.checks.groups.name

string

The name of the group

Example:

"onboarding"

cases.checks.groups.action

enum<string>

The action to take if the group fails

Available options:

ACCEPT,

REVIEW,

REJECT

Example:

"ACCEPT"

Add Document Get CDD Report

⌘I

API Reference

Authorizations

Query Parameters

Response