Partner Implementations

This page is for platforms that use Argyle to run verifications for their customers. Each customer needs a client ID in Argyle so users and verifications created through your platform are associated with the correct organization.

Before you begin

Your Argyle Customer Success manager will provide a client ID for each customer using your integration. Store the ID with that customer’s configuration and include it when you create users on the customer’s behalf. The client value identifies your customer’s organization in Argyle’s system.

Authentication

Send requests from your backend using your partner API key ID and secret with HTTP basic authentication. Use https://api-sandbox.argyle.com/partners/v2 for Sandbox and https://api.argyle.com/partners/v2 for Production. Use the keys for the selected environment. Partner mode only changes the documentation you are viewing.

Partner credentials authenticate requests for both customers. Each create-user request supplies the client ID for the customer the user belongs to.

Create or reuse the user

For embedded payroll and banking flows, start with a user associated with your customer. Order a verification using the user ID, then create a session using the verification ID. Use the returned session link to launch the frontend.

Create a user with the customer's client ID, pass the returned user ID to order a verification, then pass the verification ID to create a session. Use the returned link to launch the frontend.

If the person already has a user ID for that customer, reuse it. Otherwise, create a user with POST /partners/v2/users. Include the required client ID for that customer, along with the personal information required for the verification type.

{
  "client": "39096494-45c8-4fd8-9454-3d1cb2d62db7",
  "first_name": "Jane",
  "last_name": "Doe",
  "ssn": "000-00-0000"
}

Continue using the same user ID when ordering another product for that person and customer. If the product requires additional information, update their details before placing the order.

Endpoint family

Use /partners/v2 when your platform creates users and orders verifications for your customers. Use /v2 when your organization is implementing Argyle for its own workflow.

Shared operation	Partner endpoint
Create a user	`POST /partners/v2/users`
Update a user	`PATCH /partners/v2/users/{id}`
Order a verification	`POST /partners/v2/verifications`
Create a session	`POST /partners/v2/sessions`
Refresh a verification	`POST /partners/v2/verifications/refresh`
Retrieve or update a verification	Partner Verifications API

Implementation guides

Follow the partner guides for request examples and implementation steps:

The partner guides use /partners/v2 throughout. Continue using this endpoint family for user, verification, session, and refresh requests.

Webhooks

Create partner webhook subscriptions through POST /partners/v2/webhooks. Set config.include_resource to true for the verifications.updated webhook so the webhook contains the full verification resource. Handle duplicate webhook deliveries without creating duplicate records. Store the verification ID and use the current verification resource when deciding what to do next. Partner webhook pages:

Data sets and receipts

Partner implementations can retrieve the accounts, payroll documents, and paystubs associated with supported verifications through the Partner Data Sets endpoints. Use Partner Receipts for receipt retrieval when enabled for the integration.

​Before you begin

​Authentication

​Create or reuse the user

​Endpoint family

​Implementation guides

​Webhooks

​Data sets and receipts