Welcome to ID.me for developers! If you are interested in integrating ID.me, you are in the right place. Here we will cover how to get started implementing ID.me.
Best Practices
Every ID.me integration presents an opportunity for partners to uniquely optimize their ID.me flow. While this is a not an exhaustive list, please refer to the below suggestions. Work with your dedicated ID.me team to understand what might, or might not be right for you.
Data Usage
A key advantage of a full OAuth integration is that ID.me passes partners a JSON payload of user attributes post-verification. This payload can be used in various ways to power your applications and users' experience. Here are some suggestions for how you can leverage ID.me's verified data.
Pre-populating Subsequent Forms
Post-verification, partners will receive verified information about their users. This information can be used to automatically populate any forms that users may encounter after verifying with ID.me. Not only does this practice reduce redundant workflows, it reduces the risk of users accidentally entering inaccurate information.
Collecting Users' Affiliations and Using That Information To Re-Target Past Customer Communities
ID.me’s partners collect valuable, verified information about their users, including demographics and, most importantly, their affiliation with certain communities. As users consent to the release of this information, partners have an opportunity to collect this valuable data and use it to send targeted marketing communications.
Using Attributes To Customize Your User Experience
Many ID.me partners use ID.me’s verified data to tailor their users’ experience and ensure a positive interaction. For instance, e-commerce partners can use the verified first and last name of their customers to greet their customers by name when in-cart. Work with your ID.me team to understand how you can use ID.me to tailor your users’ experience.
Tracking and Associating Users With Their Unique Identifier
Post-verification, ID.me is sending partners a payload of valuable user data. Among other attributes, ID.me includes a unique identifier or UUID, which can be used as a means of tracking an ID.me user’s interactions within your own system. This unique identifier ensures that the data a user consents to releasing can’t be associated with another account and when ingested by the partner, allows for one to one association between one ID.me account and one account on the partner’s end. This ID is created upon account creation and remains the same regardless of any other attributes that change throughout the life of an account. If your use case invokes ID.me within a user’s account, talk to your dedicated ID.me team about how you can best leverage the UUID.
Example Responses
{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Fran"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Stracke"
},
{
"handle": "email",
"name": "Email",
"value": "fran.stracke@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "22022-8904"
}
],
"status": [
{
"group": "alumni",
"subgroups": [
null
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Reanna"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Bauch"
},
{
"handle": "email",
"name": "Email",
"value": "reanna.bauch@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "14401"
}
],
"status": [
{
"group": "doctor_canada",
"subgroups": [
null
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Bettie"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Kihn"
},
{
"handle": "email",
"name": "Email",
"value": "bettie.kihn@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "13881"
}
],
"status": [
{
"group": "medical",
"subgroups": [
"Respiratory Therapist"
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Lucius"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Parisian"
},
{
"handle": "email",
"name": "Email",
"value": "lucius.parisian@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "44548-0281"
}
],
"status": [
{
"group": "government",
"subgroups": [
"State"
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Ivelisse"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Smitham"
},
{
"handle": "email",
"name": "Email",
"value": "ivelisse.smitham@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "58418-7372"
}
],
"status": [
{
"group": "military",
"subgroups": [
"Military Family"
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Agustin"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Johns"
},
{
"handle": "email",
"name": "Email",
"value": "agustin.johns@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "74117"
}
],
"status": [
{
"group": "military_canada",
"subgroups": [
"Service Member for Canada"
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Toshiko"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Barton"
},
{
"handle": "email",
"name": "Email",
"value": "toshiko.barton@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "68843"
}
],
"status": [
{
"group": "nurse",
"subgroups": [
"Practical Nurse"
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Ryan"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Gleason"
},
{
"handle": "email",
"name": "Email",
"value": "ryan.gleason@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "96646-4093"
}
],
"status": [
{
"group": "nurse_canada",
"subgroups": [
"Registered Nurse for Canada"
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Stefan"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Doyle"
},
{
"handle": "email",
"name": "Email",
"value": "stefan.doyle@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "89241"
}
],
"status": [
{
"group": "responder",
"subgroups": [
"Firefighter"
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Willy"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Kihn"
},
{
"handle": "email",
"name": "Email",
"value": "willy.kihn@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "96751-5698"
}
],
"status": [
{
"group": "responder_canada",
"subgroups": [
"Police Officer for Canada"
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Gilda"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Hackett"
},
{
"handle": "email",
"name": "Email",
"value": "gilda.hackett@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "25517-5749"
}
],
"status": [
{
"group": "student",
"subgroups": [
null
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Hai"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Schamberger"
},
{
"handle": "email",
"name": "Email",
"value": "hai.schamberger@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "49951"
}
],
"status": [
{
"group": "student_canada",
"subgroups": [
null
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Oleta"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Gleichner"
},
{
"handle": "email",
"name": "Email",
"value": "oleta.gleichner@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "67861-8117"
}
],
"status": [
{
"group": "teacher",
"subgroups": [
"PreK-12 Principals or Assistant Principals"
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Lashell"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Rosenbaum"
},
{
"handle": "email",
"name": "Email",
"value": "lashell.rosenbaum@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "26463-2794"
}
],
"status": [
{
"group": "teacher_canada",
"subgroups": [
"College or University Professor for Canada"
],
"verified": true
}
]
}{
"attributes": [
{
"handle": "fname",
"name": "First Name",
"value": "Rosann"
},
{
"handle": "lname",
"name": "Last Name",
"value": "Wilderman"
},
{
"handle": "email",
"name": "Email",
"value": "rosann.wilderman@id.me"
},
{
"handle": "uuid",
"name": "Unique Identifier",
"value": "d733a89e2e634f04ac2fe66c97f71612"
},
{
"handle": "zip",
"name": "Zip Code",
"value": "10367-5612"
}
],
"status": [
{
"group": "employee",
"subgroups": [
"Sendwell, Inc."
],
"verified": true
}
]
}Security
At ID.me, data security is our #1 priority. We as a company go to great measures to protect our users’ data and ensure data are only released when explicit consent is granted. Here's how you can further fortify our commitment to security.
Encrypting The Data
Post-verification, ID.me is sending our partners a payload of user data in JSON format. At times, this data can include sensitive PII about our users and their associations. In order to ensure that this information is protected, we suggest that our partners elect to receive encrypted JSON responses from ID.me. This way we’re able to ensure the security of any data in transit and thus elevate your own security posture. Work with your dedicated ID.me team to learn more about encrypting and if it’s right for you.
Data Minimization
ID.me has a philosophy of data minimization. Meaning, partners should be working in collaboration with their dedicated ID.me team to ensure that we’re only sending a payload of relevant data points and nothing more. Relevant data can vary from partner to partner and is largely dependent on each respective partner’s use case. By being deliberate about the kind of data we’re including, we can minimize the risk around sending and storing data that may be useless for your purposes.
Testing
Testing your ID.me flow is an important step in a successful go-live. Partners should test to not only validate that they’re able to access the requested resource, but to ensure that the greater application is functioning properly. Depending on your use case, be sure to test and ensure that you’re:
Talk to your dedicated ID.me team to receive test credentials and learn more about what testing should mean for you.