Idme.getProfile()

Return profile information for a specified end-point

Clients access protected data by making API calls with the access token for a given user. Please see the OAuth Implementation page for instructions on how to retrieve an access token. The ID.me server will validate the access token to ensure it has not expired and that its scope covers the requested resource.

Usage

Hover over inputs/exits for more info.

var Idme = require('machinepack-idme');


// Return profile information for a specified end-point

Idme.getProfile({

access_token: '3b57cc74ec7f1cf3e32527b1fa47e842a00755d643695a3dcbd0ee85885adb5c',

end_point: 'military,student,responder,teacher,government',

}).exec({

// An unexpected error occurred.

error: function (err) {

 

},

// OK.

success: function (result) {

 

},

});

Inputs

access_token required

Access code requested from and OAuth response. See Get-Auth-Token

'3b57cc74ec7f1cf3e32527b1fa47e842a00755d643695a3dcbd0ee85885adb5c'
end_point required

The specified group affiliation

'military,student,responder,teacher,government'

Exits

error

An unexpected error occurred.

success

OK.

{ id: 'c34a81aa25e2a3d0402806',
  verified: true,
  affiliation: 'Veteran',
  email: 'partner+military_veteran_1@id.me',
  fname: 'Franc',
  lname: 'Footer',
  phone: '555-555-5555' }