Vantage Webhooks

Webhook payloads sent from Vantage to client-configured endpoints.

« Back to API Documentation

GUEST ID WEBHOOK PAYLOAD FORMAT

Webhooks are sent as HTTP POST requests with a JSON body. Property names use camelCase. The outer envelope is consistent across webhook events, and the event-specific payload is included in the data property.

The internal webhookId used by Vantage to route delivery is not included in the client-facing payload.

{
  "eventId": "96cf978f-73b6-47c1-9976-ffc03b821205",
  "eventType": "GuestId.VerificationUpdated",
  "eventVersion": 1,
  "occurredOn": "2026-09-04T18:05:00Z",
  "data": {
    "transactionId": 123456156,
    "firstName": "Nevin",
    "lastName": "Chattey",
    "email": "[email protected]",
    "reservationId": "123456-156",
    "checkInOn": "2026-09-08T00:00:00-04:00",
    "dateBooked": "2026-09-04T00:00:00-04:00",
    "verificationStatus": "Incomplete",
    "fraudGuarantee": "approved",
    "totalReservationAmount": "1.00",
    "accountRefId": "36349",
    "phone": "(770) 231-3124",
    "phoneScore": 0,
    "nameScore": 95,
    "dobResult": true,
    "age": 56,
    "flaggedDescriptions": "Review reason"
  }
}
ENVELOPE FIELDS
Field Type Description
eventId GUID Unique identifier for this webhook event. Store this value to make processing idempotent.
eventType String The event name. Guest ID verification events use GuestId.VerificationUpdated.
eventVersion Number The payload contract version. The current Guest ID version is 1.
occurredOn DateTime UTC timestamp indicating when Vantage created the webhook event.
data Object The event-specific payload. For GuestId.VerificationUpdated, this contains the Guest ID fields listed below.
GUEST ID VERIFICATION PAYLOAD

The GuestId.VerificationUpdated event is sent when Guest ID verification results are available or updated. Nullable fields may be omitted when no value is available.

Field Type Description
transactionId Number Vantage transaction/payment identifier.
firstName String Guest first name.
lastName String Guest last name.
email String Guest email address.
reservationId String Reservation identifier supplied with the transaction.
checkInOn DateTime Reservation check-in date and time.
dateBooked DateTime Date and time the reservation was booked.
verificationStatus String Current Guest ID verification status.
fraudGuarantee String Fraud guarantee or decision status when available.
totalReservationAmount String Total reservation amount formatted as dollars.
accountRefId String Vantage account reference identifier.
phone String Phone number used for verification.
phoneScore Number, nullable Phone verification score when available.
nameScore Number, nullable Name verification score when available.
dobResult Boolean, nullable Date-of-birth match result when available.
age Number, nullable Guest age derived from date of birth when available.
flaggedDescriptions String, nullable Descriptions for any verification flags when available.

v. 3cdb70b9