Identity Match

We are supporting countries in Europe, Latin America, and North America listed in the table below. Countries marked with a * symbol require additional carrier approval before using Identity Match.

Europe

• France* $0.55/query
• Germany* $0.40/query
• Italy* $1.20/query
• Netherlands* $0.60/query
• Spain* $0.40/query
• United Kingdom* $0.50/query

Latin America

• Brazil $0.20/query

North America

• Canada* $0.28/query
• United States $0.10/query
• Puerto Rico $0.10/query

What is the recommended implementation of Identity Match

Identity Match is most frequently used in your new user onboarding workflow. We suggest submitting all of the end user PII (including FirstName, LastName, and AddressLine1 at a minimum for best results) whenever a new user signs up for your service. Depending on how much information you decide to validate with the Identity Match API, you can decide if you want to leverage our Summary Score or if you would prefer to use more sophisticated logic based on individual parameter match values. If you are validating more than the three parameters mentioned above, we suggest using your own match logic, as the Summary score will only be based on those three parameters.

What is considered a "good match rate?"

What is considered a "good match rate" for Identity Match really depends on the attribute(s) you focus on for your particular use case, and the quality of the data that you are sending through to the Identity Match API.

For example, imagine an end user is signing up for an online bank account - they are very likely to provide all the correct information. In turn, this will drive higher match rates across all data elements when that customer data is compared with data held at our authoritative sources.

Now imagine an end user is signing up for a social media account, they may not necessarily provide all the correct data to the customer. In turn, this will impact match rates when that end user data is compared with data held at our authoritative sources.

Therefore, it is your use case that determines which data elements are important and what you should look for when evaluating the responses from the API. The quality of the data supplied for those data elements will have a direct impact on the output from Identity Match.

How does Twilio measure the accuracy of our data providers?

We ensure accuracy of a given provider when we onboard them - we validate accuracy using a truth file.

Truth files start with PII match data that results in an "exact match" - then, a series of permutations of this data are generated to gradually reduce the match quality to "no match." If the resultant match value at each stage are as expected, it helps us to confirm the accuracy of that provider.

Can Identity Match requests contain multiple addresses?

Currently, the Identity Match API only allows for a single input data set (name/address/DOB/NationalId against the end-user's mobile phone number), and returns a single set of match results in response.

You can include parameters in your request that represent user-provided information. Lookup will provide match scores for how the given parameters compare against authoritative phone-based data sources.

Most of these parameters are optional for phone numbers based in most countries. However, some countries require the inclusion of certain parameters and have different data formatting rules. If a country-required parameter is not included, Error 60617 will be returned. See the Query parameter country requirements section for more information.

Note: We are not accepting new customers for Identity Match in Australia at this time. AddressLine1: Optional parameter. Use only the address formats in the examples below for flats, units, or apartments.

AddressLine2: Do not include this parameter, this information should be included in AddressLine1.

State: Optional parameter. Use state abbreviations such as "QLD" instead of the full state name.

FirstName: Required parameter. For a name with multiple words, only the first word should be used for this field. For example, the name "Luis Carlos Teixeira Brito Junior" should be set as "Luis".

LastName: Required parameter. For a name with multiple words, every word after the first should be used for this field. For example, the name "Luis Carlos Teixeira Brito Junior" should be set as "Carlos Teixeira Brito Junior".

AddressLine1: Required parameter. Use the format "streetName streetNumber BL blNumber APT aptNumber neighborhoodName". For example: "RUA COSTA ESMERALDA 50 BL 14 APT 22 CENTR".

AddressLine2: Do not include this parameter, this information should be included in AddressLine1.

City: Do not include this parameter, it cannot be evaluated in Brazil.

AddressCountryCode: Do not include this parameter, it cannot be evaluated in Brazil.

PostalCode: Do not include this parameter, it cannot be evaluated in Brazil.

DateOfBirth: Optional parameter. Use the format YYYYMMDD.

NationalId : Optional parameter. Use this parameter for national ID, such as CPF.

FirstName: Required parameter.

LastName: Required parameter.

AddressLine1: Required parameter. The street name and house number should be used for this field. For example: "Immermannstraße 26", "Oderbergerstrasse 12".

City: Required parameter.

PostalCode: Required parameter

DateOfBirth: Optional parameter. Use the format YYYYMMDD.

FirstName: Required parameter.

LastName: Required parameter.

AddressLine1: Required parameter. The street name and house number or house name should be used for this field. Include both the house number and name if they are available.

PostalCode: Required parameter

FirstName: Required parameter.

LastName: Required parameter.

AddressLine1: Required parameter. The street type, street name, and building name/number should be used for this field. For example: "via Garibaldi 27" or "27 via Garibaldi", "Via Giacomo Quarenghi 34" or "34 Via Giacomo Quarenghi".

PostalCode: Optional parameter. Field must be five digits long. For example: "00015", "80044", "00145".

FirstName: Optional parameter. The first initial should be used for this field. For example, the name "Luca" should be set as "L".

AddressLine1: Optional parameter. The street name and house number should be used for this field. For example: "Jaarbeursplein 6A", "Joris van Andringastraat 172"

PostalCode: Optional parameter. Field must be composed of four digits and two characters with no spaces. For example: "3054SP", "3521AL", "1055VV".

DateOfBirth: Optional parameter. Use the format YYYYMMDD.

Lookup generates scores to represent the level of match between the user-provided information and the authoritative information.

The following additional response properties are returned for an Identity Match request.

The summary_score indicates an overall level of match, ranging from 0 (no match) to 100 (exact match) with possible values being 0, 40, 80, or 100. The summary_score property is not a percentage score, its value is derived from the values of the first_name_match, last_name_match, and address_line_match properties.

The table below shows how the summary_score is calculated in different scenarios.

1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3

4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9

10
async function fetchPhoneNumber() {
11
  const phoneNumber = await client.lookups.v2
12
    .phoneNumbers("+14159929960")
13
    .fetch({
14
      addressCountryCode: "US",
15
      addressLine1: "321 Main Street",
16
      addressLine2: "Suite 2",
17
      city: "New York",
18
      dateOfBirth: "19901214",
19
      fields: "identity_match",
20
      firstName: "John",
21
      lastName: "Doe",
22
      nationalId: "YZ3456883",
23
      postalCode: "10021",
24
      state: "NY",
25
    });
26

27
  console.log(phoneNumber.callingCountryCode);
28
}
29

30
fetchPhoneNumber();

1
{
2
  "calling_country_code": "1",
3
  "country_code": "US",
4
  "phone_number": "+14159929960",
5
  "national_format": "(415) 992-9960",
6
  "valid": true,
7
  "validation_errors": [],
8
  "caller_name": null,
9
  "sim_swap": null,
10
  "call_forwarding": null,
11
  "line_status": null,
12
  "line_type_intelligence": null,
13
  "identity_match": {
14
    "first_name_match": "exact_match",
15
    "last_name_match": "high_partial_match",
16
    "address_lines_match": "no_match",
17
    "city_match": "no_match",
18
    "state_match": "high_partial_match",
19
    "postal_code_match": "no_data_available",
20
    "address_country_match": "exact_match",
21
    "national_id_match": "exact_match",
22
    "date_of_birth_match": "exact_match",
23
    "summary_score": 90,
24
    "error_code": null,
25
    "error_message": null
26
  },
27
  "reassigned_number": null,
28
  "sms_pumping_risk": null,
29
  "phone_number_quality_score": null,
30
  "pre_fill": null,
31
  "url": "https://lookups.twilio.com/v2/PhoneNumbers/+14159929960"
32
}