JavaScript

Version 1.0 Released October 13, 2021

View on GitHub

This is JavaScript sample code to make API requests with ID.me using OAuth 2.0

You will need an ID.me developer account to complete this process

Prerequisites

You must include jquery and ID.me’s javascript dependencies in your application

You must have node installed

Dependencies

jQuery

1 <script type="text/javascript" src="https://code.jquery.com/jquery-3.7.1.min.js"></script>

ID.me

1 <script src="https://s3.amazonaws.com/idme/developer/idme-buttons-2.0.1/assets/js/idme-modal.min.js" type="text/javascript"></script>

Installation

Set your client configuration settings in idme.js with the values provided within your developer account

1 data-scope             = 'SCOPE' 
2 // possible scope values: "military", "student", "responder", "government", "teacher"
3 
4 data-client-id         = 'YOUR_CLIENT_ID'
5 data-redirect          = `YOUR_REDIRECT_URI`
6 data-response          = `RESPONSE`
7 // possible values: "code", "token"
8 
9 data-op                = `OP`
10 // possible values: "signin", "signup"
11 
12 data-text              = `OFFER_DESCRIPTION_TEXT`
13 data-display           = 'DISPLAY'
14 // possible values: "popup", "link"
15 
16 data-show-verify       = 'SHOW'
17 // possible values: "true", "false"

Run the following within the directory of the sample code:

$ npm install -g serve
$ serve -p 3000

View the app at http://localhost:3000

1	data-scope = 'SCOPE'
2	// possible scope values: "military", "student", "responder", "government", "teacher"
3
4	data-client-id = 'YOUR_CLIENT_ID'
5	data-redirect = `YOUR_REDIRECT_URI`
6	data-response = `RESPONSE`
7	// possible values: "code", "token"
8
9	data-op = `OP`
10	// possible values: "signin", "signup"
11
12	data-text = `OFFER_DESCRIPTION_TEXT`
13	data-display = 'DISPLAY'
14	// possible values: "popup", "link"
15
16	data-show-verify = 'SHOW'
17	// possible values: "true", "false"