> For the complete documentation index, see [llms.txt](https://api.veratad.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api.veratad.com/v-pin/v-pin-as-an-add-on.md).

# V-PIN as an add-on

The Veratad V-PIN (Veratad Personal Identification Number) is a unique identifier assigned to each individual for reliable tracking. This service generates a unique, immutable V-PIN for every individual, creating a consistent reference point irrespective of changes in other personal details.

#### Request

To get a V-PIN returned just add `.VPIN` to the end of the service name in your request. 

<pre class="language-json"><code class="lang-json">{
    "user": "username",
<strong>    "pass": "password",
</strong>    "service": "IDMatch5.0.VPIN",
    "target": {
        // PII Params
    }    
}

</code></pre>

#### Example Output

When V-PIN is active as an add-on to a verification service you will recieve an additional block on response called `output` which will containt the `vpin` block and `uuid.`&#x20;

```json
"output": {
    "vpin": {
        "uuid": "15ebd7a0-2b4e-4d4b-b2a5-54b5a24becce"
    }
}
```

#### Full Example Response Body&#x20;

This is what the output block will look like when being returned as an add-on to a verification service transaction.&#x20;

```json
{
    "meta": {
        "confirmation": 158032933,
        "timestamp": "2023-09-01 11:34:35",
        "reference": "",
        "user": "user@veratad.com",
        "company": "Veratad Technologies, LLC",
        "service": "PhoneMatch5.0.VPIN"
    },
    "output": {
        "vpin": {
            "uuid": "15ebd7a0-4r5c-4d4b-b2a5-54b5a24becce"
        }
    },
    "result": {
        "action": "REVIEW",
        "detail": "TRANSACTION REQUIRES FURTHER ATTENTION",
        "issues": [
            "PHONE CHECK FAILED",
            "ADDRESS CHECK FAILED"
        ]
    }
}

```

{% hint style="info" %}
The V-PIN  serves as a unique identifier for each individual in our system. However, it's crucial to understand that the presence of a V-PIN does not automatically imply that the user has been verified. The V-PIN is solely used for tracking and identification purposes, and it is not an endorsement or confirmation of the user's validity or identity.You must still examine the service result to determine whether or not the user is verified.&#x20;
{% endhint %}

{% hint style="warning" %}
Please be aware that in some instances, the V-PIN may be empty.&#x20;
{% endhint %}

In an empty case the result will look like the below

```json
"output": {
    "vpin": {}
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://api.veratad.com/v-pin/v-pin-as-an-add-on.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.