API Terms of Use

Before you start using the API, we have a few guidelines that we'd like to tell you about. We encourage you to read the full API Terms of Use, but here are the bullet points:

  • ID.me users own their data.
  • ID.me is a user-centric, permissions based platform that requires explicit permission for each transmission of information from a user to a partner brand through ID.me.
  • You may not sell ID.me user data to third party sites.
  • You cannot replicate the core user experience of ID.me

Endpoints
Choose API Version:
V3 V2

Protected REST endpoints can be access by making HTTP requests with the access token for a given user. The ID.me server will validate the access token to ensure it has not expired and that its scope covers the requested resource.


After receiving a successful verification response from the API, you should apply business logic to unlock the benefit you are offering to the end user. From a user experience perspective, it is recommended that you store the verified status in the user's session to keep the experience consistent in case the page is refreshed, the back button is pressed, etc. By hiding or disabling the button that inititiates the API call, you can prevent duplicate calls being made.


If you're writing an AJAX application, require a JSONP response, and would like to wrap our response with a callback, all you have to do is specify a callback parameter with the API call.


URI Type
https://api.id.me/api/public/v3/attributes.json?access_token=ACCESS_TOKEN
https://api.id.me/api/public/v2/attributes.json?access_token=ACCESS_TOKEN
JSON
https://api.id.me/api/public/v3/attributes.json?access_token=ACCESS_TOKEN&callback=callbackFunction
https://api.id.me/api/public/v2/attributes.json?access_token=ACCESS_TOKEN&callback=callbackFunction
JSONP

HTTP Method

GET

Response Content Type

application/json

Response
Choose API Version:
V3 V2

The response from ID.me's REST API attributes endpoint is returned in JSON format.

Example

{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Garret"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Jerde"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "garret.jerde@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "73945-5387"
    },
    {
      "handle": "military_branch",
      "name": "Military Branch",
      "value": "Air Force"
    },
    {
      "handle": "military_service_component",
      "name": "Military Service Component",
      "value": "reserve"
    },
    {
      "handle": "military_service_started",
      "name": "Military Service Started",
      "value": "2018-04-21"
    },
    {
      "handle": "military_service_ended",
      "name": "Military Service Ended",
      "value": "1998-04-21"
    }
  ],
  "status": [
    {
      "group": "military",
      "subgroups": [
        "Service Member"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Service Member",
  "fname": "Abbey",
  "lname": "Stokes",
  "email": "test.user@id.me",
  "zip": "39834-0376",
  "military_branch": "Coast Guard",
  "military_service_component": "reserve",
  "military_service_started": "2018-04-21",
  "military_service_ended": "1998-04-21"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Gracia"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Frami"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "gracia.frami@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "24747"
    },
    {
      "handle": "military_branch",
      "name": "Military Branch",
      "value": "Navy"
    },
    {
      "handle": "military_service_component",
      "name": "Military Service Component",
      "value": "natguard"
    },
    {
      "handle": "military_service_started",
      "name": "Military Service Started",
      "value": "2018-04-21"
    },
    {
      "handle": "military_service_ended",
      "name": "Military Service Ended",
      "value": "2014-04-21"
    }
  ],
  "status": [
    {
      "group": "military",
      "subgroups": [
        "Veteran"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Veteran",
  "fname": "Damion",
  "lname": "Heaney",
  "email": "test.user@id.me",
  "zip": "29850",
  "military_branch": "Air Force",
  "military_service_component": "active",
  "military_service_started": "2018-04-21",
  "military_service_ended": "2014-04-21"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Pasquale"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Murazik"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "pasquale.murazik@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "67293"
    },
    {
      "handle": "military_branch",
      "name": "Military Branch",
      "value": "Air Force"
    },
    {
      "handle": "military_service_component",
      "name": "Military Service Component",
      "value": "reserve"
    },
    {
      "handle": "military_service_started",
      "name": "Military Service Started",
      "value": "2018-04-21"
    },
    {
      "handle": "military_service_ended",
      "name": "Military Service Ended",
      "value": "1998-04-21"
    }
  ],
  "status": [
    {
      "group": "military",
      "subgroups": [
        "Retiree"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Retiree",
  "fname": "Yan",
  "lname": "Hahn",
  "email": "test.user@id.me",
  "zip": "08868-3872",
  "military_branch": "Army",
  "military_service_component": "active",
  "military_service_started": "2018-04-21",
  "military_service_ended": "1998-04-21"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Yesenia"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Denesik"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "yesenia.denesik@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "58110"
    },
    {
      "handle": "military_member_branch",
      "name": "Military Member Branch",
      "value": "Coast Guard"
    },
    {
      "handle": "military_member_service_component",
      "name": "Military Member Service Component",
      "value": "reserve"
    },
    {
      "handle": "military_member_service_started",
      "name": "Military Member Service Started",
      "value": "2018-04-21"
    },
    {
      "handle": "military_member_service_ended",
      "name": "Military Member Service Ended",
      "value": "1998-04-21"
    }
  ],
  "status": [
    {
      "group": "military",
      "subgroups": [
        "Military Spouse"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Military Spouse",
  "fname": "Billie",
  "lname": "Reilly",
  "email": "test.user@id.me",
  "zip": "16572",
  "military_branch": "Coast Guard",
  "military_service_component": "natguard",
  "military_service_started": "2018-04-21",
  "military_service_ended": "1998-04-21"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Melvin"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Schumm"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "melvin.schumm@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "36135"
    },
    {
      "handle": "military_member_branch",
      "name": "Military Member Branch",
      "value": "Air Force"
    },
    {
      "handle": "military_member_service_component",
      "name": "Military Member Service Component",
      "value": "reserve"
    },
    {
      "handle": "military_member_service_started",
      "name": "Military Member Service Started",
      "value": "2018-04-21"
    },
    {
      "handle": "military_member_service_ended",
      "name": "Military Member Service Ended",
      "value": "1998-04-21"
    }
  ],
  "status": [
    {
      "group": "military",
      "subgroups": [
        "Military Family"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Military Family",
  "fname": "Florentino",
  "lname": "Ledner",
  "email": "test.user@id.me",
  "zip": "82956",
  "military_branch": "Army",
  "military_service_component": "reserve",
  "military_service_started": "2018-04-21",
  "military_service_ended": "1998-04-21"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Venice"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Powlowski"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "venice.powlowski@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "02980"
    },
    {
      "handle": "canada_military_branch",
      "name": "Canadian Military Branch",
      "value": "Canadian Joint Operations Command"
    }
  ],
  "status": [
    {
      "group": "military_canada",
      "subgroups": [
        "Service Member for Canada"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Service Member for Canada",
  "fname": "Hugo",
  "lname": "Little",
  "email": "test.user@id.me",
  "zip": "00243",
  "canada_military_branch": "Cadet Organizations Administration and Training Service"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Hilton"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Jacobson"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "hilton.jacobson@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "82881-0784"
    },
    {
      "handle": "canada_military_branch",
      "name": "Canadian Military Branch",
      "value": "Canadian Rangers"
    }
  ],
  "status": [
    {
      "group": "military_canada",
      "subgroups": [
        "Veteran for Canada"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Veteran for Canada",
  "fname": "Pierre",
  "lname": "Conroy",
  "email": "test.user@id.me",
  "zip": "92910-6421",
  "canada_military_branch": "Canadian Army"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Sparkle"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "O'Kon"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "sparkle.o'kon@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "19390"
    },
    {
      "handle": "canada_military_branch",
      "name": "Canadian Military Branch",
      "value": "Canadian Joint Operations Command"
    }
  ],
  "status": [
    {
      "group": "military_canada",
      "subgroups": [
        "Retiree for Canada"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Retiree for Canada",
  "fname": "Louise",
  "lname": "Daugherty",
  "email": "test.user@id.me",
  "zip": "43801-5678",
  "canada_military_branch": "Royal Canadian Navy"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Irvin"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Luettgen"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "irvin.luettgen@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "85849-5570"
    },
    {
      "handle": "canada_military_branch",
      "name": "Canadian Military Branch",
      "value": "Canadian Special Operations Forces Command"
    }
  ],
  "status": [
    {
      "group": "military_canada",
      "subgroups": [
        "CAF Dependent"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "CAF Dependent",
  "fname": "Karri",
  "lname": "Krajcik",
  "email": "test.user@id.me",
  "zip": "50564-2623",
  "canada_military_branch": "Canadian Army"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Emmie"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Dach"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "emmie.dach@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "86871-3629"
    },
    {
      "handle": "government_department",
      "name": "Government Department",
      "value": "Department of the Treasury"
    }
  ],
  "status": [
    {
      "group": "government",
      "subgroups": [
        "Federal"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Federal",
  "fname": "Elbert",
  "lname": "Hettinger",
  "email": "test.user@id.me",
  "zip": "65859-2088",
  "government_department": "Department of the Treasury"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Broderick"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Howell"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "broderick.howell@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "48404"
    },
    {
      "handle": "government_department",
      "name": "Government Department",
      "value": "Department of the Treasury"
    }
  ],
  "status": [
    {
      "group": "government",
      "subgroups": [
        "State"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "State",
  "fname": "Roland",
  "lname": "Gislason",
  "email": "test.user@id.me",
  "zip": "72763",
  "government_department": "Department of the Treasury"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Anton"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Borer"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "anton.borer@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "25528"
    },
    {
      "handle": "government_department",
      "name": "Government Department",
      "value": "Department of the Treasury"
    }
  ],
  "status": [
    {
      "group": "government",
      "subgroups": [
        "Local"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Local",
  "fname": "Edna",
  "lname": "Shanahan",
  "email": "test.user@id.me",
  "zip": "58120-0747",
  "government_department": "Department of the Treasury"
}
{
  "attributes": null,
  "status": [
    {
      "group": "responder",
      "subgroups": [
        "EMT"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "EMT",
  "fname": "Warner",
  "lname": "Mohr",
  "email": "test.user@id.me",
  "zip": "11562-3306",
  "registry_status": "Valid",
  "registry_expiration": "2020-04-21"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Forest"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Kris"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "forest.kris@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "55202"
    },
    {
      "handle": "agency",
      "name": "Agency",
      "value": "Henderson FD - KY"
    }
  ],
  "status": [
    {
      "group": "responder",
      "subgroups": [
        "Firefighter"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Firefighter",
  "fname": "Hyman",
  "lname": "Klein",
  "email": "test.user@id.me",
  "zip": "38415-2905",
  "agency": "Henderson FD - KY"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Mayola"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Corkery"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "mayola.corkery@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "16881-5921"
    },
    {
      "handle": "student_school_name",
      "name": "Student School Name",
      "value": "Bruen Institute"
    },
    {
      "handle": "student_anticipated_graduation_date",
      "name": "Student Anticipated Graduation Date",
      "value": "2020-04-21"
    },
    {
      "handle": "student_enrollment_status",
      "name": "Student Enrollment Status",
      "value": "H"
    },
    {
      "handle": "student_school_type",
      "name": "Student School Type",
      "value": "2 YR"
    }
  ],
  "status": [
    {
      "group": "student",
      "subgroups": [
        null
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": null,
  "fname": "Dion",
  "lname": "McDermott",
  "email": "test.user@id.me",
  "zip": "01207-3572",
  "student_anticipated_graduation_date": "2018-04-21",
  "student_school_name": "Bailey University",
  "student_enrollment_status": "F",
  "student_school_type": "2 YR"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Shayne"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Tillman"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "shayne.tillman@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "14744"
    },
    {
      "handle": "alumni_school_name",
      "name": "Alumni School Name",
      "value": "The Collier"
    },
    {
      "handle": "alumni_graduation_date",
      "name": "Alumni Graduation Date",
      "value": "2018-04-21"
    }
  ],
  "status": [
    {
      "group": "alumni",
      "subgroups": [
        null
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": null,
  "fname": "Jimmy",
  "lname": "Zieme",
  "email": "test.user@id.me",
  "zip": "36749-1969",
  "alumni_graduation_date": "2018-04-21",
  "alumni_school_name": "North Morissette College"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Johnathon"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Torp"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "johnathon.torp@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "11735-7715"
    },
    {
      "handle": "teacher_school",
      "name": "Teacher School",
      "value": "Thomas Jefferson High School"
    },
    {
      "handle": "teacher_district",
      "name": "Teacher District",
      "value": "Fairfax County"
    },
    {
      "handle": "teacher_state",
      "name": "Teacher State",
      "value": "VA"
    }
  ],
  "status": [
    {
      "group": "teacher",
      "subgroups": [
        null
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": null,
  "fname": "Gayle",
  "lname": "Osinski",
  "email": "test.user@id.me",
  "zip": "45413-5292",
  "teacher_school": "Thomas Jefferson High School",
  "teacher_district": "Fairfax County",
  "teacher_state": "VA"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Deandra"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Feeney"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "deandra.feeney@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "64148"
    }
  ],
  "status": [
    {
      "group": "responder",
      "subgroups": [
        "Police Officer"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Police Officer",
  "fname": "Cinderella",
  "lname": "Schulist",
  "email": "test.user@id.me",
  "zip": "28591"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Callie"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "West"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "callie.west@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "51413-1658"
    }
  ],
  "status": [
    {
      "group": "responder_canada",
      "subgroups": [
        "EMT for Canada"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "EMT for Canada",
  "fname": "Kristle",
  "lname": "Shanahan",
  "email": "test.user@id.me",
  "zip": "79670"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Gregory"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Morar"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "gregory.morar@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "47882"
    }
  ],
  "status": [
    {
      "group": "responder_canada",
      "subgroups": [
        "Police Officer for Canada"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Police Officer for Canada",
  "fname": "Laure",
  "lname": "Gerlach",
  "email": "test.user@id.me",
  "zip": "56790"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Golda"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Quigley"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "golda.quigley@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "73766-4132"
    }
  ],
  "status": [
    {
      "group": "responder_canada",
      "subgroups": [
        "Firefighter for Canada"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "Firefighter for Canada",
  "fname": "Ivan",
  "lname": "Lockman",
  "email": "test.user@id.me",
  "zip": "36391"
}
{
  "attributes": [
    {
      "handle": "fname",
      "name": "First Name",
      "value": "Mario"
    },
    {
      "handle": "lname",
      "name": "Last Name",
      "value": "Becker"
    },
    {
      "handle": "email",
      "name": "Email",
      "value": "mario.becker@id.me"
    },
    {
      "handle": "uuid",
      "name": "Unique Identifier",
      "value": "d733a89e2e634f04ac2fe66c97f71612"
    },
    {
      "handle": "zip",
      "name": "Zip Code",
      "value": "60534-4789"
    }
  ],
  "status": [
    {
      "group": "employee",
      "subgroups": [
        "ID.me"
      ],
      "verified": true
    }
  ]
}
{
  "id": "d733a89e2e634f04ac2fe66c97f71612",
  "verified": true,
  "affiliation": "ID.me",
  "fname": "Andreas",
  "lname": "Upton",
  "email": "test.user@id.me",
  "zip": "98609"
}

Values

The JSON response contains the verification status and attributes for the user. The specific attributes returned depend on your application configuration and needs.

The JSON response contains the verification attributes for the user. The specific attributes returned depend on your application configuration and needs.


Attributes
Handle Name Value Description
uuid

Unique Identifier

ID randomly generated and unique to user

fname

First Name

First name set by user

lname

Last Name

Last name set by user

email

Email

Unique email set by user

zip

Zip Code

Zip code set by user

These are typical response values. The data passed back depends on your application configuration.

Status
Attributes
Parameter Description and Value Range
uuid

User unique identifier

fname

First name set by user

lname

Last name set by user

email

Unique email set by user

zip

Zip code set by user

group

Troop ID - military

Government ID - government

Responder ID - responder

Student ID - student

Alumni ID - alumni

Teacher ID - teacher

Employee ID - employee

subgroups affiliation

Troop ID - Service Member Veteran Retiree Military Spouse Military Family Service Member for Canada Veteran for Canada Retiree for Canada CAF Dependent

Government ID - Federal State Local

Responder ID - EMT Firefighter Police Officer EMT for Canada Police Officer for Canada Firefighter for Canada

Employee ID - ID.me

verified

true or false

These are typical response values. The data passed back depends on your application configuration.

Transactions

Transactional data can be passed back in the JSON response as well. If you are interested in learning more about the value of transactional data and how to add this data to the JSON response, please contact us.

Errors

If the user denies the access request or if the request is invalid, the client will be informed using the following parameters appended to the redirect uri:

Parameters

Name Description
error

A single error code as described below.

error_description

A human-readable text providing additional information, used to assist in the understanding and resolution of the error occurred.

error_uri

A URI identifying a human-readable web page with information about the error, used to provide the end-user with additional information about the error.

Codes

Code Description
invalid_request

The request is missing a required parameter, includes an unsupported parameter or parameter value, or is otherwise malformed.

invalid_client

The client identifier provided is invalid.

unauthorized_client

The client is not authorized to use the requested response type.

redirect_uri_mismatch

The redirection URI provided does not match a pre-registered value.

access_denied

The end-user or authorization server denied the request.

unsupported_response_type

The requested response type is not supported by the authorization server.

invalid_scope

The requested scope is invalid, unknown, or malformed.

Best Practices

Creating a session

Once you have retreived the user’s attributes it is recommended that you store them in the user’s session to keep the experience consistent in case the page is refreshed, the back button is pressed, etc.

Storing User Attribtues

Storing key attributes about the user is vital to a seamless group affiliation verification experience. It is recommended to store these attributes in a seperate table within your database with some relation to the user record.


Key Attributes

Handle Name Description
uuid Unique Identifer Unique identifier that is randomly generated and unique to user.
email E-Mail Unique email set by the user.
fname First Name First name set by user.
lname Last Name Last name set by user.