Registration Webhooks

Webhooks

Webhook registration events are sent to the URLs configured for your application. We initiate a POST request to the URL. The payload contains the registration id, status, and details about the impacted documents.

Example payload:

{
  "event_type": "registration_complete",
  "mers_action_id": "0b6f3a1e-4c9d-4f2a-9b7e-2d8c5e1a7f43",
  "status": "complete",
  "display_status": "complete",
  "action": "Registration",
  "documents": [
    {
      "min_number": "12345678901234567890",
      "document_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "emortgage_package_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
    }
  ],
  "event_timestamp": "2026-05-21T12:00:00Z"
}

A webhook is sent for the following events:

event type	description	direction
registration_complete	the registration was accepted by MERS	outbound
registration_notification_received	a registration notification was received from one of your partners	inbound
registration_failed	the registration failed	inbound / outbound

The display_status is a simplified status (this is what is typically shown in the registrations table in the UI). Possible values for display_status are:

value	description	direction
complete	the registration completed successfully	inbound / outbound
failed	an error occurred	inbound / outbound

Note that this parameter is available both in the webhook payload and in the registration object attributes.

---

Payload reference

Top-level fields

Field	Type	Description
event_type	string	The event that triggered the webhook (see event types above).
mers_action_id	string (UUID)	Unique identifier for this registration in eVault.
status	string	Processing status (e.g. complete, mers_responded_failed, snapdocs_error).
display_status	string	Customer-friendly status. complete or failed.
action	string | null	Registration action type. Registration or RegistrationAndTransferControl.
documents	array	List of impacted documents (see below).
errors	array (optional)	Present when MERS returned one or more errors.
event_timestamp	string	ISO 8601 timestamp of when the MERS response was received.

documents[]

Each entry includes:

Field	Type	Description
min_number	string	MERS MIN for the document.
document_id	string (UUID) | null	eVault document id (when available).
emortgage_package_id	string (UUID) | null	eMortgage package id (when available).

errors[] (optional)

Present when status is mers_responded_failed. Each entry includes:

Field	Type	Description
condition	string	Always Error.
min_number	string	The MIN associated with the error.
code	string	MERS error code.
name	string | null	MERS error name.
description	string | null	MERS error description.

---

Example payloads

Registration complete

{
  "event_type": "registration_complete",
  "mers_action_id": "0b6f3a1e-4c9d-4f2a-9b7e-2d8c5e1a7f43",
  "status": "complete",
  "display_status": "complete",
  "action": "Registration",
  "documents": [
    {
      "min_number": "12345678901234567890",
      "document_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "emortgage_package_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
    }
  ],
  "event_timestamp": "2026-05-21T12:00:00Z"
}

Registration failed

{
  "event_type": "registration_failed",
  "mers_action_id": 12346,
  "status": "mers_responded_failed",
  "display_status": "failed",
  "action": "Registration",
  "documents": [
    {
      "min_number": "12345678901234567890",
      "document_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "emortgage_package_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
    }
  ],
  "errors": [
    {
      "condition": "Error",
      "min_number": "12345678901234567890",
      "code": "1234",
      "name": "Error name from MERS",
      "description": "Error description from MERS"
    }
  ],
  "event_timestamp": "2026-05-21T12:00:00Z"
}

Registration notification received

Sent when one of your partners registers an eNote on your behalf.

{
  "event_type": "registration_notification_received",
  "mers_action_id": 12347,
  "status": "complete",
  "display_status": "complete",
  "action": "Registration",
  "documents": [
    {
      "min_number": "12345678901234567890",
      "document_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "emortgage_package_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
    }
  ],
  "event_timestamp": "2026-05-21T12:00:00Z"
}