
Choose an integration model
Verifications
Use the Verifications API when the POS creates and tracks standardized payroll, banking, or Doc VOI orders.- Create or reuse the borrower as an Argyle user.
- Order the required verification products.
- Create a session for payroll or banking user action.
- Launch the connection flow from the POS.
- Wait for the
verifications.updatedwebhook and retrieve the completed reports.
Direct Data APIs
Use the Data APIs when the POS already has a custom workflow that consumes connected-account data directly.- Create the user and a user token.
- Embed Link in the application.
- Track each connected account independently.
- Wait for the required account and resource events.
- Retrieve the data sets used by the application.
Launch the user experience
Payroll
- Embed the Web SDK or a supported Mobile SDK.
- Use a verification session
linkasconnectUrl, or initialize a direct-data flow withuserToken. - Use Link callbacks to update the immediate POS experience.
Banking
- Create a verification session and pass its
linkto the banking SDK asconnectURL. - Use banking SDK callbacks for immediate frontend handling.
- Use the
verifications.updatedwebhook for backend status.
Doc VOI
- Collect documents in the POS and upload them through the User Uploads API, or direct the borrower to the configured document-upload experience.
- Track document processing through the verification lifecycle.
Return to the application
Set a sessionredirect_url or handle the relevant SDK callback after the borrower finishes the current step. Treat the backend verification or account webhook as the source of truth for processing status.
Reports and data
- Verification implementations retrieve completed reports from the verification resource.
- Direct-data implementations retrieve users, accounts, identities, paystubs, payroll documents, and other required data sets from the API.
- Source files and report URLs require Argyle authentication headers.