POST /platform/v1/ens-verify

Verifies a callback so that it can receive notifications.

The Event Notification Service requires a two-step verification process for registering a callback. Two-step verification ensures that the stream of event notifications can’t be used to attack an external URL endpoint. To achieve this security, the URL endpoint must have a critical role in the verification process. Therefore, it’s the only receiver of the single-use verification key needed to complete callback verification.

In callback verification, a unique, single-use verification key is generated when you create a callback and is sent to the callback URL that you registered using the create callback route. The payload that is posted to the callback URL is the same payload used to call the verify callback route.

{
  "callbackId": "CALLBACK_ID_STRING",
  "verificationKey": "VERIFICATION_KEY_STRING"
}

The URL endpoint must capture verification details, including the verification key, and immediately return them by calling the verify callback route. Alternatively, you can capture the verification details so that developers can manually call the verify callback route.

To log the verification details in a request that uses manual verification, use this code in your callback implementation.

JSONObject req = new JSONObject(<httprequest>);

if (req.getString("verificationKey") != null) {
   // Return HTTP 200 code
  System.out.println("Verification details: " + <httprequest>);
} else {
   // Insert notification processing code here.
}

To manually verify the callback, use the logged verification details to invoke the verify callback route.

curl -X POST \
 https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com/platform/v1/ens-verify \
 -H 'Authorization: Bearer BEARER_TOKEN' \
 -H 'Content-Type: application/json' \
 -d '{
   "callbackId": "<callbackIDString>",
   "verificationKey": "<verificationKeyString>"
}'

Ensure that your callback completes verification within four hours.

Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
POST /platform/v1/ens-verify
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{
  "callbackId": "65b885ab-c2b4-46fe-85d0-d6cb8be8057d",
  "verificationKey": "CZwJw4XATH6LK1fPWFeMDkIyVbro6T3ijXK8CrzQe2s="
}