Brand guidelines
These guidelines outline the general rules required to use IDMe’s brand assets. Consistent use of these assets helps people easily recognize references to IDMe and bring trust to every transaction.
You may only use the approved brand assets that are provided on this page. IDMe may suspend your application’s access to our services if these guidelines are not followed.
Buttons
Displaying IDMe’s button on your homepage, products, and promotional pages is a great way to show your customers that their personal information and identity is safe and will be handled securely.
There are two ways to add an IDMe button, and you can use whichever suits your application:
- Button widget is the recommended option. It renders and maintains the button for you, so your integration stays current.
- Button SVGs are available to download and host yourself.
Button widget
Add the widget by placing an <idme-button> element and the widget script on your page. The element reads its configuration from its attributes, and builds the IDMe authorize URL for you from the data- attributes.
Use <idme-button-widget> instead when you want the promotional widget, which wraps the button with a headline and category text.
One script serves both elements. Place the <script> tag above the button tag so the element is defined before the browser reaches it.
Code snippets
Choose the snippet that matches what you need:
- Sign in and Verify render the button on its own
- Promotional widget renders the same button wrapped in a headline, offer text, and community links
A single data-scope routes to api.id.me/oauth/authorize. Multiple comma-separated scopes route to groups.id.me for group verification. The promotional widget does not read data- attributes, so give it a pre-built action-url.
Load the script and your page over HTTPS, and include the script origin in your Content Security Policy script-src. Use only the documented attribute values, and do not build attributes from user-controlled input. Set action-url only to trusted IDMe URLs, and do not log or forward data from the idme-button-click and idme-button-widget-click events.
Parameters
These parameters establish both necessary and adaptable configurations, empowering customers to align with IDMe brand guidelines, utilize the appropriate button for specific scenarios, and guide users seamlessly through subsequent steps.
Button appearance
These attributes control how <idme-button> looks and behaves.
Promotional widget
These attributes apply to <idme-button-widget>, which wraps the button with promotional text.
The widget passes variant, color-variant, size, verified, disabled, loading, action-url, and target through to the button it renders, with the same values as the table above. The one difference is that color-variant defaults to green. The attributes below are specific to the widget.
The promotional widget does not read data- attributes. Supply a pre-built action-url instead.
Building the URL from data attributes
As a drop-in replacement for the legacy widget, <idme-button> can build the IDMe authorize URL itself. Resolution precedence is action-url, then data-hlp, then data-scope. A single scope routes to api.id.me/oauth/authorize; multiple comma-separated scopes route to groups.id.me. Navigation is restricted to id.me, www.id.me, api.id.me, and groups.id.me to prevent open redirects.
To read the resolved destination without navigating, call getResolvedUrl() on the element. The resolved URL is also included on the click event as event.detail.url.
Example popup redirect page
Users will authenticate, verify, and authorize your application inside the popup before being taken to the redirect URI.
IDMe recommends that you handle the OAuth token response, close the popup, and then refresh the parent window
Button SVGs
If you cannot use the button widget, the following button assets are available to download and host yourself.
Each button is available in three variants: low green with white type (recommended), white with black type, and black with white type.
”Sign in with IDMe” button
Use this button wherever people sign in to your application, whether you offer a single login option or several.
”Verify with IDMe” button
The “Verify with IDMe” button provides a pathway to invoke IDMe’s identity and community verification solution. This ensures a consistent design experience for IDMe’s members and customers.
”Verified by IDMe” state
Use this state to show that a member’s verification is complete.
”Continue with IDMe” button
Use this button where people continue into your application with IDMe alongside other social login options.
Logos
Bring trust to the community you wish to reach with the following IDMe logo tool kit.
Three logo variants are available for download. Dark Green (#032318) is the primary IDMe logo. Black (#000000) and White (#F7F7F7) are also available, for use on backgrounds where the primary logo does not provide enough contrast.
Logo checklist
Always ensure the following conditions are met when using the IDMe logo:
- The logo maintains the required clear space
- The logo is at least 85px by 30px
- The logo is dark green (#032318), black (#000000), or white (#F7F7F7)
- The logo must maintain co-equal prominence when displayed side-by-side