Vantage Webhooks - Vantage Card Services

ENVELOPE FIELDS

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.

Field	Type	Description
`eventId`	GUID	Unique identifier for this webhook event. Store this value to make processing idempotent.
`eventType`	String	The event name, such as `AccountStatus.Changed` or `GuestId.VerificationUpdated`.
`eventVersion`	Number	The payload contract version. The current webhook event version is `1`.
`occurredOn`	DateTime	UTC timestamp indicating when Vantage created the webhook event.
`data`	Object	The event-specific payload. Nullable fields may be omitted when no value is available.

ACCOUNT STATUS PAYLOAD

The AccountStatus.Changed event is sent when an account status changes through supported Vantage workflows, including hosted boarding progress, terms acceptance, or terms decline.

{
  "eventId": "96cf978f-73b6-47c1-9976-ffc03b821205",
  "eventType": "AccountStatus.Changed",
  "eventVersion": 1,
  "occurredOn": "2026-09-04T18:05:00Z",
  "data": {
    "companyId": 12345,
    "accountId": 36349,
    "externalId": "acct-123",
    "legalName": "Example Legal LLC",
    "dbaName": "Example Stay",
    "accountStatus": "Pending",
    "agreeToTerms": true,
    "approved": false,
    "merchantAccountNumber": "000123456",
    "merchantProfileId": "profile-123",
    "tierName": "Standard",
    "fundAt": "Default",
    "message": "Agreement Completed",
    "targets": [
      {
        "targetId": 5678,
        "targetName": "Primary Target",
        "clientTargetId": 9876
      }
    ]
  }
}

Field	Type	Description
`companyId`	Number	Vantage company identifier.
`accountId`	Number	Vantage account identifier.
`externalId`	String, nullable	Client-supplied account reference identifier.
`legalName`	String, nullable	Account legal name.
`dbaName`	String, nullable	Account DBA name.
`accountStatus`	String	Current account status, such as `Pending`, `Open`, `Disagree`, or `Declined`.
`agreeToTerms`	Boolean	Whether the account has agreed to terms.
`approved`	Boolean	Whether the account has been approved.
`merchantAccountNumber`	String, nullable	Processor merchant account number when available.
`merchantProfileId`	String, nullable	Processor merchant profile identifier when available.
`tierName`	String, nullable	Account tier name when available.
`fundAt`	String	Funding account usage value. Possible values: `Default`, `Booking`, `Event`.
`message`	String	Human-readable status message, such as `Hosted Boarding Completed`, `Account Steps Completed`, `Signer Steps Completed`, `Agreement Completed`, or `Agreement Disagree`.
`targets`	Array, nullable	Aptexx targets associated with the account when available.
`targets[].targetId`	Number	Vantage target identifier.
`targets[].targetName`	String	Target display name.
`targets[].clientTargetId`	Number	Client-facing target identifier.

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.

{
  "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"
  }
}

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.