External Account Updated

An external or funding Account has been unlinked or re-linked.

Example Use Case

Monitoring for potential account takeover by tracking associated external accounts.

Request Specifications

Required API FieldDefinitionNotes
timestampTimestamp of the event.The timestamp field likely will be the same as the value passed in to link_timestamp / unlink_timestamp, but both fields must be populated for schema consistency and clear delineation between unlinking/re-linking update events.
One of:
external_account_id
account_token
Unique identifier for the External Account being updated.The account_token is Alloy's assigned identifier for the Account record, returned in the response for bank_account_created/ external_account_created events.
One of:
unlink_timestamp
link_timestamp
Timestamp when the External Account was unlinked (or re-linked).The link_timestamp should only be provided on External Account update events if the account is being re-linked - if the Account is being unlinked, do not provide this field and use unlink_timestamp instead.
One of:
external_entity_id
entity_token
Unique identifier of one of the Entities associated with the External Account.Not strictly required if the event is not being monitored, but recommended to include for future proofing your integration.

This field has no impact on which Entities are attached to the Account, although it should match at least one of the Entities that the Account belongs to.

Example Request/Response:

{
    "event_type": "external_account_updated",
    "event_status": "successful",
    "event_lifecycle_id": "X99-43jf-74382",
    "data": {
        "external_account_id": "9478cf5a-61b6-4c73-a4bf-e71d133f4cd7",
        "external_entity_id": "efa4cfa2-379c-4f9e-aab5-1a9a933cde15",
        "timestamp": "2024-03-28T02:32:51.351Z",
        "unlink_timestamp": "2024-03-28T02:32:51.351Z"
    },
    "supplemental_data": {}
}
{
    "status_code": 201,
    "event_request_token": "EV-OYyPwOsoiYE7V6I6ncse",
    "_links": {
        "self": {
            "href": "/v1/events/EV-OYyPwOsoiYE7V6I6ncse"
        }
    },
    "event": {
        "event_type": "external_account_updated",
        "event_status": "PROCESSED",
        "data": {
            "account_number": "0123456",
            "account_number_encrypted": "4f76aaf90607...",
            "account_number_hashed": "3badcec68d9a6...",
            "cif_number": null,
            "account_type": null,
            "product_code": null,
            "product_name": null,
            "opening_date": null,
            "maturity_date": null,
            "closing_date": null,
            "activation_date": null,
            "expiration_date": null,
            "meta": null,
            "routing_number": "021000021",
            "external_ingestion_identifier": null,
            "card_network": null,
            "account_name": null,
            "tokenization_method": null,
            "merchant_category_code": null,
            "name_on_card": null,
            "account_number_last4": null,
            "avs": null,
            "account_class": null,
            "country_code": null,
            "description": null,
            "program_name": null,
            "mcc_description": null,
            "is_linked_account": true,
            "link_timestamp": "2024-03-28T02:16:26.983Z",
            "unlink_timestamp": "2024-03-28T02:32:51.351Z",
            "entities": [
                {
                    "entity_token": "P-pHoEYGBD5I0O7weUUOoo",
                    "external_entity_id": "efa4cfa2-379c-4f9e-aab5-1a9a933cde15",
                    "account_holder_type": "primary"
                }
            ],
            "currency": "USD",
            "account_hash": null,
            "external_account_id": "9478cf5a-61b6-4c73-a4bf-e71d133f4cd7",
            "account_token": "A-uiQyEF3kvfvBUZ7fXblb"
        },
        "evaluations": [],
        "journey_applications": []
    }
}