ID.me

ID.me is a digital identity platform that helps people prove and share their identity online so they can access online services.

In order to integrate ID.me with Relyance AI you will need Client ID and Client Secret and complete an Oauth flow.

In ID.me:

1. Login to your ID.me account.
2. Go here: https://developers.id.me/organizations
3. Create an organization if need be, select Verify Additional Groups, and click Continue.
4. Select the desired groups and click Continue.
5. Copy the Client ID and Client Secret on the resulting page.
6. Click Continue.
7. Once the wizard is completed, this will bring you to an Application dashboard. Select the Edit Tab.
8. Set the Redirect URI to be https://root.relyance.ai/api/oauth2.
9. Click the Testing tab and add an email address (also generate a new password to be used in ID.me) to test your Relyance connection with. Copy the testing email and password to be used in the Oauth flow. Ensure you have access to this email account as you may not be able to change it going forward.
10. Log out of ID.me.

In the Relyance AI application:

1. Login to your Relyance account.
2. Navigate to the Settings Menu in the bottom left-hand side.
3. Select Integrations.
4. Click on the Vendor Integration tab.
5. Find the ID.me integration card and click it to open its connections.
6. Under Authentication Method, choose Oauth2 / App Token / << group >>.
7. Paste the Client ID and Client Secret into their respective fields.

9. Click Authenticate.
10. This will bring you to the ID.me login page, login using your testing email and password. If you get an error, logout of ID.me and try again.
11. Once logged in, you may be prompted to subscribe, make a selection and click Continue.

12. This will then bring you to the permission access page. Click Allow to continue.

13. At this point, you should see the following result on the Vendor Integrations page:

14. Now that it's connected, log back into ID.me with your regular credentials, go back into the application and click on REQUEST PRODUCTION MODE on the main application page (step 7 in the ID.me section above).
15. Congratulations, you are now connected to ID.me.

If the connection reports Connected but returns nothing

These are the ways this integration comes back empty without reporting an error. Generated from the integration catalog, so it tracks what the connection actually asks for.

1. Authorised, then empty. The connection carries an authorisation, not a password: it stops returning data if the account that granted it loses access, its own permissions narrow, or the grant is revoked at the vendor. None of that reports an error here -- the connection keeps its last status until the next scan.
2. A credential rotated at the vendor is not picked up here. Client Secret is stored when you save the connection, so regenerating the value at the vendor breaks the next scan until it is re-pasted here. Recording the expiry on the connection means Relyance warns you before it lapses.

Authentication methods and fields

Pick one of these under Authentication Method on the connection wizard's Authentication step. This table is generated from the integration catalog, so it always matches what the form actually asks for.

Manage this integration with Terraform

Connections for this integration can be managed as code with the Relyance Terraform provider. Non-secret fields go in auth.params; secret fields go in auth.secrets_wo, which is write-only — never stored in Terraform state. Rotate secrets by bumping auth.secrets_wo_version.

OAuth (browser authorization) — Oauth2 / App Token / Alumni

The OAuth (browser authorization) — Oauth2 / App Token / Alumni method uses a browser authorization flow, so the connection is created in the Relyance app. Manage it in Terraform afterwards by importing it (terraform import relyance_integration_connection.example idme/<connection_id>) or reading it with the relyance_integration_connection data source.

OAuth (browser authorization) — Oauth2 / App Token / Employee

The OAuth (browser authorization) — Oauth2 / App Token / Employee method uses a browser authorization flow, so the connection is created in the Relyance app. Manage it in Terraform afterwards by importing it (terraform import relyance_integration_connection.example idme/<connection_id>) or reading it with the relyance_integration_connection data source.

OAuth (browser authorization) — Oauth2 / App Token / Government

The OAuth (browser authorization) — Oauth2 / App Token / Government method uses a browser authorization flow, so the connection is created in the Relyance app. Manage it in Terraform afterwards by importing it (terraform import relyance_integration_connection.example idme/<connection_id>) or reading it with the relyance_integration_connection data source.

OAuth (browser authorization) — Oauth2 / App Token / Military

The OAuth (browser authorization) — Oauth2 / App Token / Military method uses a browser authorization flow, so the connection is created in the Relyance app. Manage it in Terraform afterwards by importing it (terraform import relyance_integration_connection.example idme/<connection_id>) or reading it with the relyance_integration_connection data source.

OAuth (browser authorization) — Oauth2 / App Token / Nurse

The OAuth (browser authorization) — Oauth2 / App Token / Nurse method uses a browser authorization flow, so the connection is created in the Relyance app. Manage it in Terraform afterwards by importing it (terraform import relyance_integration_connection.example idme/<connection_id>) or reading it with the relyance_integration_connection data source.

OAuth (browser authorization) — Oauth2 / App Token / Responder

The OAuth (browser authorization) — Oauth2 / App Token / Responder method uses a browser authorization flow, so the connection is created in the Relyance app. Manage it in Terraform afterwards by importing it (terraform import relyance_integration_connection.example idme/<connection_id>) or reading it with the relyance_integration_connection data source.

OAuth (browser authorization) — Oauth2 / App Token / Student

The OAuth (browser authorization) — Oauth2 / App Token / Student method uses a browser authorization flow, so the connection is created in the Relyance app. Manage it in Terraform afterwards by importing it (terraform import relyance_integration_connection.example idme/<connection_id>) or reading it with the relyance_integration_connection data source.

OAuth (browser authorization) — Oauth2 / App Token / Teacher

The OAuth (browser authorization) — Oauth2 / App Token / Teacher method uses a browser authorization flow, so the connection is created in the Relyance app. Manage it in Terraform afterwards by importing it (terraform import relyance_integration_connection.example idme/<connection_id>) or reading it with the relyance_integration_connection data source.