Footprint Webhook Event Types
This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.
entity_kind
string
event_kind
WebhookEventKind
fp_id
string
is_live
boolean
status
EntityStatusPayload
2 Items
timestamp
string
(date-time)
Example EntityStatusChangedPayload
JSON
{
"entity_kind": "person",
"event_kind": "footprint.entity.entity_status_set",
"fp_id": "fp_id_xyz",
"is_live": false,
"status": {
"kind": "verification_status",
"value": "verified"
},
"timestamp": "2024-06-14T02:40:00Z"
}event_kind
WebhookEventKind
external_id
string
null
Optionalfp_id
string
is_live
boolean
onboarding_external_id
string
null
Optionalonboarding_id
string
playbook_key
string
playbook_version
integer
null
(int32)
Optionalrequires_manual_review
boolean
status
TerminalStatus
timestamp
string
(date-time)
Example OnboardingCompletedPayload
JSON
{
"event_kind": "footprint.onboarding.completed",
"external_id": null,
"fp_id": "fp_id_xyz",
"is_live": false,
"onboarding_external_id": null,
"onboarding_id": "ob_SRFT2a1mN7DAWJ0VPXkiqK",
"playbook_key": "pb_test_QoEYTOve49Q2IAmaKVYnPs",
"playbook_version": 3,
"requires_manual_review": false,
"status": "pass",
"timestamp": "2024-06-14T02:40:00Z"
}event_kind
WebhookEventKind
external_id
string
null
Optionalfp_id
string
is_live
boolean
onboarding_external_id
string
null
Optionalonboarding_id
string
playbook_key
string
playbook_version
integer
null
(int32)
Optionaltimestamp
string
(date-time)
Example OnboardingIncompletePayload
JSON
{
"event_kind": "footprint.onboarding.incomplete",
"external_id": null,
"fp_id": "fp_id_xyz",
"is_live": false,
"onboarding_external_id": null,
"onboarding_id": "ob_SRFT2a1mN7DAWJ0VPXkiqK",
"playbook_key": "pb_test_QoEYTOve49Q2IAmaKVYnPs",
"playbook_version": 3,
"timestamp": "2024-06-14T02:40:00Z"
}event_kind
WebhookEventKind
fp_id
string
is_live
boolean
new_status
ScopedVaultStatus
requires_manual_review
boolean
timestamp
string
(date-time)
Example OnboardingStatusChangedPayload
JSON
{
"event_kind": "footprint.onboarding.status_changed",
"fp_id": "fp_id_xyz",
"is_live": false,
"new_status": "pass",
"requires_manual_review": false,
"timestamp": "2024-06-14T02:40:00Z"
}error_message
string
null
OptionalAn error message if the update failed
event_kind
WebhookEventKind
fp_id
string
The id of the user the link belongs to
is_live
boolean
Whether the link was created in live mode
link_error
string
null
OptionalThe current error state of the link
link_event_kind
object
The kind of link event update performed
link_external_id
string
null
OptionalThe external id of the bank link
link_id
string
The id of the bank link
link_product_refresh
anyOf
OptionalIf a product was refreshed, this will be populated
link_state
string
null
OptionalThe current state of the link
timestamp
string
(date-time)
The timestamp of the event
user_external_id
string
null
OptionalThe external id of the user the link belongs to
Example UserBankLinkUpdatedPayload
JSON
{
"error_message": null,
"event_kind": "footprint.user.bank_link_updated",
"fp_id": "fp_id_xyz",
"is_live": false,
"link_error": null,
"link_event_kind": "link_product_refreshed",
"link_external_id": null,
"link_id": "bank_link_abcd1234",
"link_product_refresh": {
"product": "transactions",
"success": true
},
"link_state": "connected",
"timestamp": "2024-06-14T02:40:00Z",
"user_external_id": null
}event_kind
WebhookEventKind
external_id
string
null
Optionalfp_id
string
is_live
boolean
timestamp
string
(date-time)
Example UserInfoRequestedPayload
JSON
{
"event_kind": "footprint.user.info_requested",
"external_id": null,
"fp_id": "fp_id_xyz",
"is_live": false,
"timestamp": "2024-06-14T02:40:00Z"
}event_kind
WebhookEventKind
external_id
string
null
Optionalfp_id
string
is_live
boolean
timestamp
string
(date-time)
Example UserManualReviewPayload
JSON
{
"event_kind": "footprint.user.manual_review",
"external_id": null,
"fp_id": "fp_id_xyz",
"is_live": false,
"timestamp": "2024-06-14T02:40:00Z"
}event_kind
WebhookEventKind
external_id
string
null
Optionalfields
array[]
fp_id
string
is_live
boolean
source
UserVaultUpdateSource
timestamp
string
(date-time)
Example UserVaultUpdatedPayload
JSON
{
"event_kind": "footprint.vault.updated",
"external_id": null,
"fields": [
"id.ssn9",
"id.first_name"
],
"fp_id": "fp_id_xyz",
"is_live": false,
"source": "dashboard",
"timestamp": "2024-06-14T02:40:00Z"
}error
anyOf
Optionalevent_kind
WebhookEventKind
external_id
string
null
Optionalfp_id
string
is_live
boolean
onboarding_id
string
status
WatchlistCheckStatusKind
timestamp
string
(date-time)
Example WatchlistCheckCompletedPayload
JSON
{
"error": null,
"event_kind": "footprint.watchlist_check.completed",
"external_id": null,
"fp_id": "fp_id_xyz",
"is_live": false,
"onboarding_id": "ob_SRFT2a1mN7DAWJ0VPXkiqK",
"status": "pending",
"timestamp": "2024-06-14T02:40:00Z"
}