Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Death Master File

Post Dmf Search

Submit a DMF search request with a person's name and SSN.

post/dmf/searches

Headers

Preferstring nullable

Request execution preference (RFC 7240). Use respond-async for asynchronous execution, wait=N to specify a synchronous timeout hint in seconds, or priority=low to route the task to the low-priority queue.

Example:respond-async

Request execution preference (RFC 7240). Use respond-async for asynchronous execution, wait=N to specify a synchronous timeout hint in seconds, or priority=low to route the task to the low-priority queue.

Request body

namestring required

The name of the person of interest

ssnstring password required

The social security number of the person of interest

Response

Response

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 response

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