Link updates
A new optional attribute was added to the pay distribution configs. Setting allow_add_allocation
to false
, reove the Add bank account button in the PD Edit screen.
Most relevant updates and all breaking changes.
A new optional attribute was added to the pay distribution configs. Setting allow_add_allocation
to false
, reove the Add bank account button in the PD Edit screen.
A new document_id
field was added to /payouts. It contains a unique ID of a document (e.g. paystub) associated with the payout.
The new features
object in link items contain information about direct deposit switching capabilities.
A new flag for Argyle Link configuration was added. closeOnOutsideClick
toggles the closing of Link when a user clicks outside the bounds of the UI element provided by Argyle.
accounts.source
field was added to /v1/accounts. It denotes the source of the account's employment records provided in the Argyle API.
A diagram explaining the Argyle data structure has been added to the Argyle Scan guide
A new /link-items endpoint was added. It is promoted in favor of /data-partners endpoint and has the same fields. /data-partners endpoint is now deprecated but still available for previously created integrations.
A new /employments endpoint was added. Employment objects contain information related to the employment information of the user: employment status and type, hire and termination dates, etc.
Employment-related fields in /profiles were deprecated in favor of the fields in /employments. This is a non-breaking change—the fields are still present in /profiles.
Employer
field was added to all data resources: profiles, employments, finances, reputations, documents, vehicles, payouts, activities. It denotes the company or entity that employs the user.
With Argyle Update, users can update their direct deposit information and include your bank account into their pay distribution.
New and improved account connection statuses and error codes were added. See the account object's API documentation for more details.
An auth_required
error code was added. This error means that a previously linked account disconnected from the work platform, and user needs to re-authenticate.