Skip to content

New service | Last updated: 14 May 2025

Important

This documentation is for preview purposes only.

Receive events webhooks

What is a webhook?

Access Worldpay webhooks provide you with real-time information about the status of your parties. Setting up a webhook means you automatically receive updates when there is a status change on your party. At the moment, these updates are related only to identity verification process status changes, but in next releases, other updates will be available.

Prerequisite

To subscribe to webhook capability please contact your Implementation Manager.

Receiving the webhook

Network access

IP list

You must whitelist the following IP addresses for both Try and Live environments:

Try:

34.243.65.63
52.48.6.187
3.255.13.18

Live:

3.251.36.74
63.32.208.6
52.19.45.138

Events supported

You can get the following status updates:

notVerified

The party was created. The identity verification process has not yet started. No action is needed.

Example:

{
    "eventId": "a58b3573-8d5a-4ad3-ab22-94cb7586f059",
    "eventTimestamp": "2025-11-26T00:47:29.77Z",
    "eventDetails": {
        "entity": "exampleEntity",
        "partyId": "parixDUOryk3DXt9h6mrAqrT0",
        "description": "AnewPartyhasbeencreated."
    },
    "eventType": "partyCreated",
    "notificationId": "d2cefa3c-b4e2-4926-a6bb-de3fc7d41752",
    "createdAt": "2025-11-26T00:47:54.606Z"
}
pending

The identity verification is in progress, the process has started but there aren't any updates yet. The status changes once the validation has completed. No action is needed.

Example:

{
    "eventId": "5f075e88-7f86-475b-9f8b-add152213099",
    "eventTimestamp": "2025-11-26T00:47:55.154Z",
    "eventDetails": {
        "overall": {
            "identityVerificationState": "pending",
            "identityVerificationMethod": "identityVerificationService",
            "identityVerificationDate": null,
            "url": null,
            "message": null
        },
        "party": {
            "identityVerificationState": "pendingManualReview",
            "identityVerificationMethod": null,
            "identityVerificationDate": null,
            "url": null,
            "message": null,
            "partyId": "parixDUOryk3DXt9h6mrAqrT0",
            "partyReference": "exampleReference"
        },
        "entity": "exampleEntity"
    },
    "eventType": "identityVerificationSentToProvider",
    "notificationId": "c549ebd3-4a8d-449a-aba4-b775bd84f3b8",
    "createdAt": "2025-11-26T00:48:54.477Z"
}
pendingManualReview

The identity verification process is being manually reviewed. The status changes once the validation has completed. No action is needed.

Example:

{
    "eventId": "2a0067b0-be71-43be-9e99-4f6422d5c3c6",
    "eventTimestamp": "2025-11-26T00:48:06.715Z",
    "eventDetails": {
        "overall": {
            "identityVerificationState": "pending",
            "identityVerificationMethod": "identityVerificationService",
            "identityVerificationDate": null,
            "url": null,
            "message": null
        },
        "party": {
            "identityVerificationState": "pendingManualReview",
            "identityVerificationMethod": null,
            "identityVerificationDate": null,
            "url": null,
            "message": null,
            "partyId": "parixDUOryk3DXt9h6mrAqrT0",
            "partyReference": "exampleReference"
        },
        "entity": "exampleEntity"
    },
    "eventType": "identityVerificationRequiredManualReview",
    "notificationId": "7eb29e8f-36bc-4e06-ac5a-b0250161c198",
    "createdAt": "2025-11-26T00:48:54.648Z"
}
pendingStepUpAction

The identity verification process is not yet complete. You receive a URL in this notification with further details on next actions (e.g. uploading a scan of the ID or a liveness check). You must provide additional information.

Example:

{
    "eventId": "2a0067b0-be71-43be-9e99-4f6422d5c3c6",
    "eventTimestamp": "2025-11-26T00:48:06.715Z",
    "eventDetails": {
        "overall": {
            "identityVerificationState": "pending",
            "identityVerificationMethod": "identityVerificationService",
            "identityVerificationDate": null,
        },
        "party": {
            "identityVerificationState": "pendingStepUpAction",
            "url": "https://launch-workflow.provider.com/6841a098d4d44906e738eb75?x-hf-session=96022ce12a00003b005f0383",
            "message": "Additional information is required to complete identity verification. Please follow the URL provided in the url field to proceed.",
            "partyReference": "exampleReference",
            "partyId": "parixDUOryk3DXt9h6mrAqrT0"
        },
        "entity": "exampleEntity"
    },
    "eventType": "identityVerificationRequiredStepUpAction",
    "notificationId": "7eb29e8f-36bc-4e06-ac5a-b0250161c198",
    "createdAt": "2025-11-26T00:48:54.648Z"
}
rejected

The identity verification process has failed and the party's identity is not verified successfully. No action is needed.

Example:

{
    "eventId": "88b6d756-85ad-46a9-8ad0-f9d40b6de19a",
    "eventTimestamp": "2025-11-26T06:19:47.106Z",
    "eventDetails": {
        "overall": {
            "identityVerificationState": "rejected",
            "identityVerificationMethod": "identityVerificationService",
            "identityVerificationDate": null,
            "url": null,
            "message": null
        },
        "party": {
            "identityVerificationState": "rejected",
            "identityVerificationMethod": null,
            "identityVerificationDate": null,
            "url": null,
            "message": null,
            "partyId": "paruqMllx-SxUDA9T3d3AeZu0",
            "partyReference": "Kiana781"
        },
        "entity": "NoOverrides"
    },
    "eventType": "identityVerificationRejected",
    "notificationId": "278fa423-237f-4d93-98fb-babc1092d174",
    "createdAt": "2025-11-26T06:19:54.457Z"
}
verified

The identity verification process has completed successfully and the party's identity is now verified. No action is needed.

Example:

{
    "eventId": "3b5a6d34-270b-4f6d-a3ad-713775da95d7",
    "eventTimestamp": "2025-11-26T06:18:31.139Z",
    "eventDetails": {
        "overall": {
            "identityVerificationState": "verified",
            "identityVerificationMethod": "identityVerificationService",
            "identityVerificationDate": "2025-11-26",
            "url": null,
            "message": null
        },
        "party": {
            "identityVerificationState": "verified",
            "identityVerificationMethod": null,
            "identityVerificationDate": "2025-11-26",
            "url": null,
            "message": null,
            "partyId": "parixDUOryk3DXt9h6mrAqfG0",
            "partyReference": "Kimberly816"
        },
        "entity": "NoOverrides"
    },
    "eventType": "identityVerificationVerified",
    "notificationId": "637d1653-6e81-48de-8e54-cbac0b4f6e59",
    "createdAt": "2025-11-26T06:18:54.694Z"
}