# Global

The Youverify eIDv service API allows you to validate user-provided data and personal identifiable information (PII) like government-issued IDs, names, mobile numbers, and addresses against government, authoritative and commercial data sources in multiple countries.

Kindly note special annotations for some <mark style="color:red;">**countries.**</mark>

## Global ID Validation

<mark style="color:green;">`POST`</mark> `{{baseurl}}/v2/api/identity/global/validate`

#### Headers

| Name                                    | Type   | Description      |
| --------------------------------------- | ------ | ---------------- |
| token<mark style="color:red;">\*</mark> | String | API secret token |

#### Request Body

| Name                                               | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| -------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id<mark style="color:red;">\*</mark>               | String  | Candidate's National ID. (Only Required by <mark style="color:red;">Argentina, Brazil, Chile, China, Colombia, Denmark, Finland, India,</mark> [<mark style="color:red;">**Malaysia**</mark>](#user-content-fn-1)[^1]<mark style="color:red;">, Mexico, Norway, Singapore, South Africa, Sweden, Turkey, and the United States.</mark>)                                                                                                                                                                                                           |
| isSubjectConsent<mark style="color:red;">\*</mark> | Boolean | Indicate that subject has given consent. <mark style="color:red;">`Must be true`</mark>                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| lastName<mark style="color:red;">\*</mark>         | String  | Last name to compare against the ID and/or credit file (Only Required by <mark style="color:red;">Argentina, Australia, Austria, Belgium, Canada, Czech Republic, Finland, France, Germany, Gibraltar, Hong Kong, Ireland, Italy, Japan, Luxembourg, Malaysia, Netherlands, New Zealand, Norway, Philippines, Poland, Portugal, Slovakia,</mark>[ ](#user-content-fn-2)[^2][<mark style="color:red;">**Spain**</mark>](#user-content-fn-3)[^3]<mark style="color:red;">, Switzerland, Turkey, United Kingdom, and the United States</mark>)       |
| firstName<mark style="color:red;">\*</mark>        | String  | First name to compare against an ID and/or credit file (Only Required by <mark style="color:red;">Argentina, Australia, Austria, Belgium, Canada, Czech Replublic, Finland, France, Germany, Gibraltar, Hong Kong, Ireland, Italy, Japan, Luxembourg, Malaysia, Netherlands, New Zealand, Norway, Philippines, Poland, Portugal, Slovakia,</mark> [<mark style="color:red;">**Spain**</mark>](#user-content-fn-3)[^3]<mark style="color:red;">, Switzerland, Turkey, the United Kingdom, and the United States</mark>)                            |
| dateOfBirth<mark style="color:red;">\*</mark>      | String  | Date of Birth to compare against ID and/or credit file (Only Required by <mark style="color:red;">Belgium, Chile, Hong Kong, Ireland, Malaysia, Netherlands, Philippines, Singapore, and Turkey)</mark>                                                                                                                                                                                                                                                                                                                                           |
| fullName<mark style="color:red;">\*</mark>         | String  | <p>Full name of the candidate to compare against the ID and/or credit file. (Only Required by <mark style="color:red;">Austria, Brazil, Canada, Chile, China, Colombia, France, Germany, Gibraltar, Malaysia, and Singapore.</mark>)</p><p>lastName and firstName can also be used where fullName is required.</p>                                                                                                                                                                                                                                |
| mobile<mark style="color:red;">\*</mark>           | String  | Phone Number to compare against the ID and/or credit file. (Only Required by <mark style="color:red;">Norway, and the Philippines</mark>)                                                                                                                                                                                                                                                                                                                                                                                                         |
| advanced                                           | Boolean | <p>Perform an Advanced Search.</p><p>This option enable you to search multiple data sources simultaneously to increase coverage and accuracy. </p><p>(Not available in the <mark style="color:red;">Czech Republic, Gilbraltar, Greece, Hong Kong, Ireland, Japan, Luxembourg, Malaysia, Singapore, Slovakia,</mark> <a data-footnote-ref href="#user-content-fn-3"><mark style="color:red;"><strong>Spain</strong></mark></a><mark style="color:red;">, Switzerland, Thailand, Turkey, the United Kingdom, Nigeria, Kenya and Ghana</mark>) </p> |
| addressDetails                                     | Object  | Address details object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| addressLine1                                       | String  | <p>Address line to compare against the ID and/or credit file. (Required by <mark style="color:red;">Austria, Canada, France, Germany, United Kingdom, and the United States</mark>)</p><p>Individual components can also provided, such as House Number and Street Name</p>                                                                                                                                                                                                                                                                       |
| addressLine2                                       | String  | Address line to compare against ID and/or credit file.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| houseNumber                                        | String  | House number to compare against the ID and/or credit file. (Only Required by <mark style="color:red;">Australia, Austria, Canada, France, Germany, Ireland, Italy, Netherlands, New Zealand, Norway, Poland, and Portugal</mark>)                                                                                                                                                                                                                                                                                                                 |
| street                                             | String  | Street name to compare against an ID and/or credit file. (Required by <mark style="color:red;">Australia, Austria, Canada, Germany, Ireland, Italy, New Zealand, Poland, Portugal and</mark> [<mark style="color:red;">**Spain**</mark>](#user-content-fn-3)[^3])                                                                                                                                                                                                                                                                                 |
| city                                               | String  | City name to compare against the ID and/or credit file. (Only Required by <mark style="color:red;">Austria, Czech Republic, France, Germany, Ireland, Italy, Malaysia, New Zealand, Norway, Poland, Portugal, Slovakia, United Kingdom and the United States.</mark>)                                                                                                                                                                                                                                                                             |
| postalCode                                         | String  | Postal code to compare against the ID and/or credit file. (Only Required by <mark style="color:red;">Australia, Austria, Canada, France, Germany, Ireland, Italy, Malaysia, Netherlands, New Zealand, Norway, Poland, Portugal,</mark> [<mark style="color:red;">**Spain**</mark>](#user-content-fn-3)[^3]<mark style="color:red;">, Switzerland, United Kingdom and the United States.</mark>)                                                                                                                                                   |
| state                                              | String  | State name to compare against the ID and/or credit file. (Only Required by <mark style="color:red;">Australia, Austria, Canada, Ireland, Italy and Malaysia.</mark>)                                                                                                                                                                                                                                                                                                                                                                              |
| countryCode                                        | String  | <p>Country code</p><p>The country code of the address. Use the two-letter country codes that comply with ISO 3166-1 alpha-2. </p>                                                                                                                                                                                                                                                                                                                                                                                                                 |
| countryCode<mark style="color:red;">\*</mark>      | String  | <p>Country code for validation </p><p>The country code must match the ID issuing country. Use the two-letter country codes that comply with ISO 3166-1 alpha-2</p>                                                                                                                                                                                                                                                                                                                                                                                |

{% tabs %}
{% tab title="Global ID Validation Sample Request" %}

```json
{
    "addressDetails": {
        "addressLine1": "19 CASUARINA",
        "addressLine2": "",
        "houseNumber": "19",
        "street": "CASUARINA",
        "city": "KILMORE",
        "postalCode": "3764",
        "state": "",
        "countryCode": "AU"
    },
    "fullName": "TOM CLARKE",
    "firstName": "TOM",
    "lastName": "CLARKE",
    "id": "12345678",
    "countryCode": "AU",
    "dateOfBirth": "1800-01-01",
    "mobile": "",
    "email": "",
    "advanced": true,
    "isSubjectConsent": true
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Global ID Validation Sample Response" %}

```json
{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "6525026f085d5ae6ac556b6f",
        "fullName": "TOM CLARKE",
        "firstName": "TOM",
        "lastName": "CLARKE",
        "dateOfBirth": "1800-01-01",
        "mobile": "",
        "email": "",
        "addressDetails": {
            "addressLine1": "19 CASUARINA",
            "addressLine2": "",
            "houseNumber": "19",
            "street": "CASUARINA",
            "city": "KILMORE",
            "postalCode": "3764",
            "state": "",
            "countryCode": "AU"
        },
        "validationDetails": {
            "fullName": {
                "status": "partial_matched",
                "value": "TOM CLARKE",
                "validationMessage": "Partial match made on Complete Name"
            },
            "lastName": {
                "status": "full_matched",
                "value": "CLARKE",
                "validationMessage": "Full match made on Last Name/Surname"
            },
            "address": {
                "status": "partial_matched",
                "value": "19 CASUARINA",
                "validationMessage": "Partial match made on Address Elements provided in Address Lines"
            },
            "city": {
                "status": "full_matched",
                "value": "KILMORE",
                "validationMessage": "Full match made on City/Locality"
            },
            "postalCode": {
                "status": "full_matched",
                "value": "3764",
                "validationMessage": "Full match made on Postal Code/Zip Code"
            },
            "state": {
                "status": "full_matched",
                "value": "",
                "validationMessage": "Full match made on State/Province"
            },
            "firstName": {
                "status": "not_matched",
                "value": "TOM",
                "validationMessage": "No match made on First Name/Given Name"
            },
            "houseNumber": {
                "status": "not_matched",
                "value": "19",
                "validationMessage": "No match made on House Number/Street Number"
            },
            "street": {
                "status": "not_matched",
                "value": "CASUARINA",
                "validationMessage": "No match made on Street/Thoroughfare"
            },
            "dateOfBirth": {
                "status": "not_matched",
                "value": "1800-01-01",
                "validationMessage": "No match made on Date of Birth"
            },
            "dayOfBirth": {
                "status": "not_matched",
                "value": "01",
                "validationMessage": "No match made on Day of Birth"
            },
            "monthOfBirth": {
                "status": "not_matched",
                "value": "01",
                "validationMessage": "No match made on Month of Birth"
            },
            "yearOfBirth": {
                "status": "not_matched",
                "value": "1800",
                "validationMessage": "No match made on Year of Birth"
            },
            "percentage": {
                "percentageFullyMatched": 36,
                "percentageNotMatched": 40,
                "percentagePartialMatched": 24
            }
        },
        "addressReliability": {
            "reliability": "10",
            "adaptation": "30"
        },
        "identityReliability": {
            "reliability": "30",
            "adaptation": "0"
        },
        "overallReliability": {
            "reliability": "30",
            "adaptation": "30"
        },
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": true,
        "isConsent": true,
        "idNumber": "12345678",
        "businessId": "62b2e8b281442b03187f7896",
        "type": "globalIdentityValidation",
        "requestedAt": "2023-10-10T07:51:12.278Z",
        "requestedById": "62b2e8b381442b75857f7898",
        "country": "Global",
        "createdAt": "2023-10-10T07:51:12.487Z",
        "lastModifiedAt": "2023-10-10T07:51:12.487Z",
        "adverseMediaReport": null,
        "metadata": {},
        "requestedBy": {
            "firstName": "API",
            "lastName": "user",
            "middleName": "",
            "id": "62b2e8b381442b25857f788"
        }
    },
    "links": []
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Error Response" %}

```json
{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}
```

{% endtab %}
{% endtabs %}

[^1]: Only last 4-digits are required.

[^2]:

[^3]: Spanish territories, such as the Canary Islands, Ceuta, and Melilla, are included in this coverage.


---

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

```
GET https://doc.youverify.co/know-your-customer-services-kyc/id-data-matching-eidv/global.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.