Skip to navigation

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.

Note

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
<script src="https://assets.id.me/widgets/button-widget/button.js"></script>
<idme-button
variant="sign-in"
color-variant="green"
size="md"
data-client-id="[YOUR_CLIENT_ID]"
data-redirect="[YOUR_REDIRECT_URI]"
data-response="code"
data-scope="military">
</idme-button>

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.

Security

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.

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.

ParameterValuesDescriptionRequired
variantsign-in or verifySelects the button textYes
color-variantgreen, green-outline, black, or black-outlineSelects the button colorYes
sizexs, sm, md, lg, or xlButton size. Defaults to md.No
verifiedPresent, or trueShows the verified stateNo
disabledPresent, or trueDisables the button so it cannot be selectedNo
loadingPresent, or trueShows the loading state and replaces the label with Verifying.... Leading icons are hidden while loading.No
icon-leadingA short text or emoji stringDisplays the value before the button label. The value is inserted as text, so markup is not interpreted.No
action-urlA trusted IDMe URLThe destination to navigate to when the button is selected. Takes precedence over every data- attribute.No
target_self or _blankWhere the destination opens. Defaults to _self. Ignored when data-display is popup.No
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.

ParameterValuesDescriptionRequired
headlineExample: [AFFINITY GROUP] receives [OFFER] with IDMeThe headline displayed above the buttonNo
dealExample: 20% off, Exclusive offersThe offer text. Defaults to Exclusive offers.No
category1Example: Military, TeachersThe first community named in the widget textNo
category2Example: First Responders, NursesThe second community named in the widget textNo
more-categoriestrue or falseAppends “and others” to the community listNo
text-sizesm or mdSize of the promotional text blockNo
button-aligncenter or topVertical alignment of the button against the text blockNo
text-alignleft or rightWhich side of the widget the text block sits onNo
borderPresent, or trueDraws a border around the widgetNo

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.

ParameterValuesDescriptionRequired
data-scopemilitary, responder, student, teacher, governmentDefines the community you are requesting permission to access. A comma-separated list requests group verification.Yes
data-client-id[YOUR_CLIENT_ID]The client identifier received during app registration. It is automatically generated and can be found in your application dashboard.Yes
data-redirect[YOUR_REDIRECT_URI]The URL the user gets redirected to after authorizing an app. Set by the developer within the application dashboard.Yes
data-responsecode or tokenThe OAuth 2.0 grant type - Authorization Code (code) or Implicit (token)Yes
data-stateExample: 24730b6dA parameter to carry through any server-specific state you need to protect against CSRF issuesNo
data-displaypopupOpens the destination in a centered popup window. Overrides target, which is ignored while this is set.No
data-logo[YOUR_LOGO_URL]Displays a logo at the community selection pageNo
data-hero[YOUR_HERO_IMAGE_URL]Displays a hero image at the community selection pageNo
data-countryExample: USThe country to use for the verification flowNo
data-languageExample: enThe language to use for the verification flow, sent as langNo
data-opExample: signupThe operation to start the flow withNo
data-typeExample: linkThe presentation type passed through to the flowNo
data-app-idExample: SC529724439d8558619035353581An Application Identifier, used to reference the IDMe-managed Application representing the partner’s serviceNo
data-hlpA trusted IDMe URLOverrides the built URL. Validated against the allowlist.No
data-conversion-trackingtrue, false, or a window function nameOpts the button in to conversion tracking. See Conversion Reporting. Defaults to false.No

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.

Users will authenticate, verify, and authorize your application inside the popup before being taken to the redirect URI.

Example
<!-- This code snippet is not production quality -->
<html>
<head>
<script type="text/javascript">
// Your application logic to handle the OAuth response
window.opener.location.reload();
window.close();
</script>
</head>
<body></body>
</html>
Best practice

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.

Recommended - Most recognizable


Sign in with IDMe button, low green with white type
Additional options

Sign in with IDMe button, white with black type
Sign in with IDMe button, black with white type
Download SVGs

”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.

Recommended - Most recognizable


Verify with IDMe button, low green with white type
Additional options

Verify with IDMe button, white with black type
Verify with IDMe button, black with white type
Download SVGs

”Verified by IDMe” state

Use this state to show that a member’s verification is complete.

Verified by IDMe

Verified by IDMe, white with black type
Download SVGs

”Continue with IDMe” button

Use this button where people continue into your application with IDMe alongside other social login options.

Recommended - Most recognizable


Continue with IDMe button, low green with white type
Additional options

Continue with IDMe button, white with black type
Continue with IDMe button, black with white type
Download SVGs

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.

Dark Green

#032318


IDMe logo dark green
Black

#000000


IDMe logo black
White

#F7F7F7


IDMe logo white
Download SVGs

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