Webhooks

Webhooks are an important part of the EyeDp platform. Checks are performed asynchronously in the background so webhooks are the only way of getting notified when they're completed.

Events

These are all the events webhooks can be setup for.

Event name	Description
tamper-detection/completed	Tamper detection check has completed
content-validation/completed	Content validation check has completed
reputation/completed	Reputation check has completed
kyc/completed	KYC check has completed
financial-vulnerability/completed	Financial vulnerability check has completed
bank-account-verification/completed	Bank account verification check has completed

Example webhook event

This is what a webhook event looks like.

{
  "caseId": 374,
  "eventType": "tamper-detection",
  "checkId": 123,
  "timestamp": "2025-08-26T10:04:59.513Z"
}

Authentication

Webhooks are sent with a custom header key value of your choosing. Use these to authenticate events coming into your endpoint.

E.g. x-my-auth: 758375

Create webhooks

Configures a new webhook.

Endpoint	api/webhooks
Method	POST
Content type	application/json

Request

{
    "url": "https://webhook.site/123",
    "eventType": "financial-vulnerability/completed",
    "authHeaderKey": "testheader",
    "authHeaderValue": "123"
}

IMPORTANT

Only one url can be configured per event type. Setting an event type will override the previous one.

Get webhooks

Returns all of webhooks configured for your company.

Endpoint	api/webhooks
Method	GET
Content type	application/json

[
        {
        "createTs": "2025-08-26T12:44:56.113",
        "url": "https://webhook.site/1234",
        "eventType": "financial-vulnerability/completed",
        "authHeaderKey": "testheader",
        "authHeaderValue": "123"
    },
    {
        "createTs": "2025-08-26T12:44:15.343",
        "url": "https://webhook.site/123",
        "eventType": "content-validation/completed",
        "authHeaderKey": "testheader",
        "authHeaderValue": "123"
    }
]