Skip to main content
PATCH
/
v3
/
webhook
curl --request PATCH \
  --url https://verification.didit.me/v3/webhook/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "webhook_url": "https://myapp.com/webhooks/didit",
  "webhook_version": "v3"
}
'
{
  "webhook_url": "<string>",
  "webhook_version": "<string>",
  "secret_shared_key": "<string>",
  "capture_method": "<string>",
  "data_retention_months": 123
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
webhook_url
string<uri> | null

URL to receive webhook notifications. Set to null to disable webhooks.

​
webhook_version
enum<string>

Webhook payload version.

Available options:
v1,
v2,
v3
​
rotate_secret_key
boolean
default:false

Set to true to generate a new webhook secret. The old secret is immediately invalidated.

​
capture_method
enum<string>
Available options:
mobile,
desktop,
both
​
data_retention_months
integer | null
Required range: 1 <= x <= 120

Response

200 - application/json

Updated webhook configuration.

​
webhook_url
string | null
​
webhook_version
string
​
secret_shared_key
string

Current secret (new one if rotated)

​
capture_method
string
​
data_retention_months
integer | null