Skip to main content

​
Definition

A user is Argyle’s record for the person sharing accounts, data, or documents with your organization. Keep the same user ID across payroll, banking, document, and verification workflows.
A user can connect multiple payroll accounts, share payroll data sets, and receive verification reports.
The diagram above illustrates the payroll data structure. Banking verifications use the same user, but financial-account connections are not represented by the Accounts API or payroll data sets.
The same user can:
  • Complete one or more verification orders.
  • Connect multiple payroll accounts through Link.
  • Connect a financial account for a banking verification.
  • Have documents uploaded through the API or upload them through Link.
  • Return later to reconnect an account or complete a new verification.
Store the Argyle user id with your internal person or application record.

​
Create a user

Use POST /v2/users to create a user from your backend. The required person details depend on the workflow. For example, banking and Doc VOI require additional identity fields that a payroll verification may not require. Follow the relevant Verifications or Data APIs guide before choosing the request fields.

​
Returning users

Reuse the existing user ID when the same person returns.
  • For a new verification, create another verification for the existing user.
  • For an active verification with an expired session link, create another session for the existing verification.
  • For a direct-data workflow, create a new user token before launching Link again.
  • For an account that requires reauthentication, follow Reconnecting Accounts.
Creating another user for the same person separates their accounts, documents, and verifications across multiple user records.

​
External identifiers

Use external_id to associate the Argyle user with your own identifier, such as an application or member ID.
External IDs are metadata for your mapping. They do not replace the Argyle user ID and should not be used as the only deduplication mechanism.
An external ID associates an Argyle user with an identifier from your system.

​
View and manage users

​
Console

Use the Connections area to search for users, review associated accounts and data, and manage available actions.

​
API

Use the Users API to create, retrieve, update, list, or delete users.

​
Delete a user

Deleting a user is permanent and removes the resources associated with that user. Confirm your retention and deletion requirements before calling DELETE /v2/users/{id}.