Verifications

Endpointhttps://api.kontier.eu/v1

Customer verification tracks identity checks and compliance validations performed through external verification providers. Each verification has a status lifecycle: pending → verified / failed / expired.

Use verifications for KYC/KYB compliance, age verification, or business entity validation.

List customer verifications

GET

https://api.kontier.eu/v1

/verifications

Returns a paginated list of verifications for the org. Pass ?customer_id= to scope to one customer; omit to see every verification across the org.

List customer verifications › query Parameters

customer_id

string

Filter by customer UUID

status

string

Filter by verification status

verification_type

string

Filter by verification type

occurred_after

string

Filter by created_at >= (RFC3339)

occurred_before

string

Filter by created_at < (RFC3339)

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

cursor

string

Opaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.

List customer verifications › Headers

X-Workspace-Id

string

Selects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.

Workspace UUID or slug.

List customer verifications › Responses

array | null · required

object · required

GET/verifications

curl --request GET \
  --url https://api.kontier.eu/v1/verifications

shell

Example Responses

{
  "data": [
    {
      "actor_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "check_type": "VAT",
      "created_at": "2024-08-25T15:00:00Z",
      "customer_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "expires_at": "2024-08-25T15:00:00Z",
      "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "last_checked_at": "2024-08-25T15:00:00Z",
      "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "provider": "provider",
      "provider_reference": "provider_reference",
      "reason": "reason",
      "result_payload": {},
      "status": "pending",
      "updated_at": "2024-08-25T15:00:00Z",
      "verification_type": "verification_type",
      "verified_at": "2024-08-25T15:00:00Z"
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Get a customer verification

GET

https://api.kontier.eu/v1

/verifications/{id}

Returns a single VAT verification check row with its status, provider reference, timestamps, and raw provider result payload.

Get a customer verification › path Parameters

id

string · uuid · required

Verification UUID

Get a customer verification › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get a customer verification › Responses

object · required

GET/verifications/{id}

curl --request GET \
  --url https://api.kontier.eu/v1/verifications/:id

shell

Example Responses

{
  "data": {
    "actor_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "check_type": "VAT",
    "created_at": "2024-08-25T15:00:00Z",
    "customer_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "expires_at": "2024-08-25T15:00:00Z",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "last_checked_at": "2024-08-25T15:00:00Z",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "provider": "provider",
    "provider_reference": "provider_reference",
    "reason": "reason",
    "result_payload": {},
    "status": "pending",
    "updated_at": "2024-08-25T15:00:00Z",
    "verification_type": "verification_type",
    "verified_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Update verification status

PATCH

https://api.kontier.eu/v1

/verifications/{id}/status

Admin override to transition a verification's status (e.g., approve, reject, expire).

Update verification status › path Parameters

id

string · uuid · required

Verification UUID

Update verification status › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Update verification status › Request Body

status

string · enum · required

New verification status: one of pending, verified, expired, failed, manual, or maintenance. Required, and must be a permitted transition from the current status.

Enum values:

pending

verified

expired

failed

manual

maintenance

Update verification status › Responses

object · required

PATCH/verifications/{id}/status

curl --request PATCH \
  --url https://api.kontier.eu/v1/verifications/:id/status \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "pending"
}
'

shell

Example Request Body

{
  "status": "pending"
}

json

Example Responses

{
  "data": {
    "actor_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "check_type": "VAT",
    "created_at": "2024-08-25T15:00:00Z",
    "customer_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "expires_at": "2024-08-25T15:00:00Z",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "last_checked_at": "2024-08-25T15:00:00Z",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "provider": "provider",
    "provider_reference": "provider_reference",
    "reason": "reason",
    "result_payload": {},
    "status": "pending",
    "updated_at": "2024-08-25T15:00:00Z",
    "verification_type": "verification_type",
    "verified_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Custom Fields Currencies

List customer verifications

GET

https://api.kontier.eu/v1

/verifications

Returns a paginated list of verifications for the org. Pass ?customer_id= to scope to one customer; omit to see every verification across the org.

List customer verifications › query Parameters

customer_id

string

Filter by customer UUID

status

string

Filter by verification status

verification_type

string

Filter by verification type

occurred_after

string

Filter by created_at >= (RFC3339)

occurred_before

string

Filter by created_at < (RFC3339)

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

cursor

string

List customer verifications › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List customer verifications › Responses

array | null · required

object · required

Get a customer verification

GET

https://api.kontier.eu/v1

/verifications/{id}

Returns a single VAT verification check row with its status, provider reference, timestamps, and raw provider result payload.

Get a customer verification › path Parameters

id

string · uuid · required

Verification UUID

Get a customer verification › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get a customer verification › Responses

object · required

Update verification status

PATCH

https://api.kontier.eu/v1

/verifications/{id}/status

Admin override to transition a verification's status (e.g., approve, reject, expire).

Update verification status › path Parameters

id

string · uuid · required

Verification UUID

Update verification status › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Update verification status › Request Body

status

string · enum · required

New verification status: one of pending, verified, expired, failed, manual, or maintenance. Required, and must be a permitted transition from the current status.

Enum values:

pending

verified

expired

failed

manual

maintenance

Update verification status › Responses

object · required