v1

latestOpenAPI 3.1.02026-07-241695611.0 MB

Webhook Events

DMFSearch.submitted

Emitted when a Death Master File search has been submitted for processing.

postWebhookDMFSearch.submitted

Payload

idstring uuid required

The ID of the DMF search request

namestring required

The name of the person of interest

ssnstring required

The obfuscated social security number of the person of interest

state'PENDING' | 'EXECUTING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required

errorstring nullable

Any errors that occurred during the DMF search request.

Example payload

{
  "name": "Michael Smith",
  "ssn": "621-34-2918",
  "error": "TimeoutError The IRS could not be reached.",
  "user": {
    "first_name": "Austin",
    "last_name": "Taylor",
    "email": "jessicasimpson@example.com"
  }
}

Response

Successful Response

{"stackTrail":"webhooks:DMFSearch.submitted:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}