Skip to main content
POST
Post Dmf Search

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string | null

An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked Idempotent-Replayed: true, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.

Prefer
string | null

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"

Body

application/json
name
string
required

The name of the person of interest

Maximum string length: 250
ssn
string<password>
required
write-only

The social security number of the person of interest

Response

Response

id
string<uuid>
required

The ID of the DMF search request

name
string
required

The name of the person of interest

Maximum string length: 250
Example:

"Michael Smith"

ssn
string
required

The obfuscated social security number of the person of interest

Example:

"621-34-2918"

state
enum<string>
required

The status of the DMF search request

Available options:
PENDING,
EXECUTING,
COMPLETED,
FAILED,
CANCELLED
Example:

"COMPLETED"

idempotency_key
string | null

The Idempotency-Key header the request that created this resource carried, if any.

error
string | null

Any errors that occurred during the DMF search request.

Example:

"TimeoutError The IRS could not be reached."

user
UserAttributionResponse (v1) · object | null

Response model for user attribution operations.

This model defines the structure for user attribution API responses.