Versium: Contact Append

Find a US consumer’s email, phone or postal address from their name, address, phone or email.

Tool ID: versium_contact_append

Run this action

This action has conditional or dynamic inputs. A static example cannot describe these inputs reliably. Read the live contract before you execute this action:

deepline describe versium_contact_append --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "versium": {
      "version": "example",
      "num_matches": 123,
      "num_results": 123,
      "query_id": "query_123",
      "query_time": 123,
      "results": [
        {}
      ],
      "input_query": {}
    }
  }
}

Use deepline describe versium_contact_append --json for the latest machine-readable contract.

Input reference

Return requested contact fields for a US consumer identified by name, address, phone, or email.

Name	Type	Required	Default	Details
`payload.output`	`unknown`	Yes	—	Minimum items: 1. Items must be unique.
`payload.first`	`string`	No	—	A person’s first name
`payload.last`	`string`	No	—	A person’s last name
`payload.address`	`string`	No	—	A house/building number and street
`payload.address_2`	`string`	No	—	The unit number of an address
`payload.city`	`string`	No	—	A city name
`payload.state`	`string`	No	—	A US State two letter abbreviation
`payload.zip`	`string`	No	—	A 5 digit US ZIP code
`payload.country`	`string`	No	`"US"`	A 2 letter country code (only US is supported at present)
`payload.phone`	`string`	No	—	A valid 10 digit North American phone number
`payload.email`	`string`	No	—	A valid email address
`payload.match_type`	`string`	No	`"hhld"`	The match type (hhld or indiv)
`payload.cfg_maxrecs`	`string`	No	`"1"`	The number of returned records

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Raw Versium REACH response.
`result.data.versium`	`object`	Yes	—	—
`result.data.versium.version`	`string`	Yes	—	—
`result.data.versium.match_counts`	`record`	No	—	—
`result.data.versium.num_matches`	`integer`	Yes	—	Minimum: 0.
`result.data.versium.num_results`	`integer`	Yes	—	Minimum: 0.
`result.data.versium.query_id`	`string`	Yes	—	—
`result.data.versium.query_time`	`number`	Yes	—	Minimum: 0.
`result.data.versium.results`	`array`	Yes	—	—
`result.data.versium.input_query`	`record`	Yes	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

Example response

Input reference

Output reference

Deepline cost

Related documentation