Search
K
Links
🌐

Global

Validate government-issued IDs and personal identifiable information (PII) globally
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 countries.
post
{{baseurl}}
/v2/api/identity/global/validate
Global ID Validation
Parameters
Header
token*
String
API secret token
Body
id*
String
Candidate's National ID. (Only Required by Argentina, Brazil, Chile, China, Colombia, Denmark, Finland, India, Malaysia, Mexico, Norway, Singapore, South Africa, Sweden, Turkey, and the United States.)
countryCode*
String
Country code for validation
The country code must match the ID issuing country. Use the two-letter country codes that comply with ISO 3166-1 alpha-2
isSubjectConsent*
Boolean
Indicate that subject has given consent. Must be true
lastName*
String
Last name to compare against the ID and/or credit file (Only Required by 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, Spain, Switzerland, Turkey, United Kingdom, and the United States)
firstName*
String
First name to compare against an ID and/or credit file (Only Required by 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, Spain, Switzerland, Turkey, the United Kingdom, and the United States)
dateOfBirth*
String
Date of Birth to compare against ID and/or credit file (Only Required by Belgium, Chile, Hong Kong, Ireland, Malaysia, Netherlands, Philippines, Singapore, and Turkey)
fullName*
String
Full name of the candidate to compare against the ID and/or credit file. (Only Required by Austria, Brazil, Canada, Chile, China, Colombia, France, Germany, Gibraltar, Malaysia, and Singapore.)
lastName and firstName can also be used where fullName is required.
mobile*
String
Phone Number to compare against the ID and/or credit file. (Only Required by Norway, and the Philippines)
advanced
Boolean
Perform an Advanced Search.
This option enable you to search multiple data sources simultaneously to increase coverage and accuracy.
(Not available in the Czech Republic, Gilbraltar, Greece, Hong Kong, Ireland, Japan, Luxembourg, Malaysia, Singapore, Slovakia, Spain, Switzerland, Thailand, Turkey, the United Kingdom, Nigeria, Kenya and Ghana)
addressDetails
Object
Address details object
addressLine1
String
Address line to compare against the ID and/or credit file. (Required by Austria, Canada, France, Germany, United Kingdom, and the United States)
Individual components can also provided, such as House Number and Street Name
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 Australia, Austria, Canada, France, Germany, Ireland, Italy, Netherlands, New Zealand, Norway, Poland, and Portugal)
street
String
Street name to compare against an ID and/or credit file. (Required by Australia, Austria, Canada, Germany, Ireland, Italy, New Zealand, Poland, Portugal and Spain)
city
String
City name to compare against the ID and/or credit file. (Only Required by Austria, Czech Republic, France, Germany, Ireland, Italy, Malaysia, New Zealand, Norway, Poland, Portugal, Slovakia, United Kingdom and the United States.)
postalCode
String
Postal code to compare against the ID and/or credit file. (Only Required by Australia, Austria, Canada, France, Germany, Ireland, Italy, Malaysia, Netherlands, New Zealand, Norway, Poland, Portugal, Spain, Switzerland, United Kingdom and the United States.)
state
String
State name to compare against the ID and/or credit file. (Only Required by Australia, Austria, Canada, Ireland, Italy and Malaysia.)
countryCode
String
Country code
The country code of the address. Use the two-letter country codes that comply with ISO 3166-1 alpha-2.
Responses
Global ID Validation Sample Request
{
"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
}
Global ID Validation Sample Response
{
"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": []
}
Error Response
{
"success": false,
"statusCode": 404,
"message": "You have attempted to get a resource that does not exist.",
"name": "ResourceNotFoundError",
"data": {}
}