> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Versium: Predictive Scores

> Get predictive scores for an identified US consumer from their name, address, email or phone. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Get predictive scores for an identified US consumer from their name, address, email or phone.

> [!NOTE]
>
> Tool ID: `versium_predictive_scores`

## 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:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline describe versium_predictive_scores --json
```

## Example response

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

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "versium": {
      "version": "example",
      "num_matches": 123,
      "num_results": 123,
      "query_id": "query_123",
      "query_time": 123,
      "results": [
        {}
      ],
      "input_query": {}
    }
  }
}
```

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

## Input reference

Return requested Versium predictive scores for an identified US consumer.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.output` | `unknown` | Yes | — | Minimum items: 1. Items must be unique. |
| `payload.first` | `string` | No | — | A person first name |
| `payload.last` | `string` | No | — | A person last name |
| `payload.address` | `string` | No | — | A house/building address |
| `payload.address2` | `string` | No | — | A house/building suite/unite number |
| `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.email` | `string` | No | — | A valid email address (consumer email) |
| `payload.phone` | `string` | No | — | A valid 10 digit North America phone number |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Return requested Versium predictive scores for an identified US consumer.",
    "properties": {
      "output": {
        "minItems": 1,
        "uniqueItems": true,
        "items": {
          "type": "string",
          "enum": [
            "auto_finance_score",
            "donor_score",
            "green_score",
            "wealth_score",
            "diy_score",
            "new_tech_adopter_score",
            "online_shopper_score",
            "travel_score"
          ]
        }
      },
      "first": {
        "type": "string",
        "description": "A person first name"
      },
      "last": {
        "type": "string",
        "description": "A person last name"
      },
      "address": {
        "type": "string",
        "description": "A house/building address"
      },
      "address2": {
        "type": "string",
        "description": "A house/building suite/unite number"
      },
      "city": {
        "type": "string",
        "description": "A city name"
      },
      "state": {
        "type": "string",
        "description": "A US state two letter abbreviation"
      },
      "zip": {
        "type": "string",
        "description": "A 5 digit US zip code"
      },
      "email": {
        "type": "string",
        "description": "A valid email address (consumer email)"
      },
      "phone": {
        "type": "string",
        "description": "A valid 10 digit North America phone number"
      }
    },
    "required": [
      "output"
    ],
    "anyOf": [
      {
        "required": [
          "email"
        ]
      },
      {
        "required": [
          "phone"
        ]
      },
      {
        "required": [
          "address",
          "city",
          "state",
          "zip"
        ]
      },
      {
        "required": [
          "first",
          "last",
          "city",
          "state"
        ]
      },
      {
        "required": [
          "first",
          "last",
          "zip"
        ]
      }
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Raw Versium REACH response.",
        "properties": {
          "versium": {
            "type": "object",
            "properties": {
              "version": {
                "type": "string"
              },
              "match_counts": {
                "type": "object",
                "additionalProperties": {
                  "type": "integer",
                  "minimum": 0
                }
              },
              "num_matches": {
                "type": "integer",
                "minimum": 0
              },
              "num_results": {
                "type": "integer",
                "minimum": 0
              },
              "query_id": {
                "type": "string"
              },
              "query_time": {
                "type": "number",
                "minimum": 0
              },
              "results": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "input_query": {
                "type": "object",
                "additionalProperties": true
              }
            },
            "required": [
              "version",
              "num_matches",
              "num_results",
              "query_id",
              "query_time",
              "results",
              "input_query"
            ],
            "additionalProperties": true
          }
        },
        "required": [
          "versium"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Versium provider guide](https://deepline.com/docs/providers/versium/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.