Changelog

Most relevant updates and all breaking changes.

Aug 5, 2021

Breaking

Now, either account or user is required to list activities on activities endpoint. At least one has to be filled.

Jul 8, 2021

Not Breaking

deduction_list, tax_list, and filing_status objects were added to the payouts endpoint. A field for fees was added to the same endpoint.

Jul 1, 2021

Not Breaking

unusable_bank_account and updated_too_recently were added to pay_distribution.error_code with corresponding messages in pay_distribution.error_message in the accounts endpoint.

Jun 28, 2021

Not Breaking

You can now use kind and kind.not_in filters to limit the scope based on the kind of Link items (e.g. employer, gig, platform) when using the Link items search endpoint.

Jun 18, 2021

Not Breaking

logo_url added to the Link items endpoint. Authentication is required to access this field.

Jun 3, 2021

Not Breaking

You can now search for Link items by utilizing the search Link items endpoint.

Jun 2, 2021

Not Breaking

It is now possible to remove pay allocations via the API. You can learn more about it here.

May 27, 2021

Not Breaking

Two new fields have been added in the reputations endpoint: achievements.points and achievements.metadata.

May 21, 2021

Not Breaking

A new reports endpoint can be used to generate VOIE reports via the API.

May 20, 2021

Not Breaking

Four new fields have been added in the user invite templates endpoint: page_config.page_success_heading, page_config.page_success_description, page_config.page_success_show_button and page_config.page_success_button.

May 17, 2021

Not Breaking

One new field has been added in the send an invite endpoint: link_config.link_items.

May 12, 2021

Not Breaking

One new field has been added in the link items endpoint: kind.

Apr 28, 2021

Not Breaking

The Argyle Console now supports inviting users in bulk and pay distribution changes. Additionally, an income summary is now available in the Activities data section.

Apr 26, 2021

Not Breaking

Seven new fields have been added in the employments endpoint: base_pay.amount, base_pay.period, base_pay.currency, pay_cycle, platform_ids.employee_id, platform_ids.position_id, platform_ids.platform_user_id.

Two new fields have been added in the payouts endpoint: payout_period.start_date, payout_period.end_date.

Apr 14, 2021

Not Breaking

It is now possible to receive the full account object in the payload of the accounts.added, accounts.updated, accounts.connected, and accounts.failed webhooks. To enable this, add "include_resource": true to your webhook subscription.

A new Invite users via the API guide provides a walkthrough in setting up user invite templates and sending out user invites.

dataPartners configuration attribute was deprecated in favor of linkItems in Argyle Link.

Apr 12, 2021

Not Breaking

It is now possible to invite users via the API (previously only available in the Console). For more information, please refer to the user invites and user invite templates endpoints.

Mar 22, 2021

Not Breaking

New unsupported_by_employer, unknown_bank_account_types and missing_allocation_type values were added to pay_distribution.error_message field in the Accounts resource.

Mar 17, 2021

Not Breaking

metadata was added to profiles, employments, reputations, documents, vehicles, activities, pay allocations.

New pay_distribution.error_message and connection.error_message fields were added in the Accounts resource.

Mar 9, 2021

Not Breaking

It is now possible to create a user with an associated user token without initiating Argyle Link.

It is now possible to set external metadata when creating or updating a user.

Mar 4, 2021

Not Breaking

available_date was added to the Documents resource.

Mar 3, 2021

Not Breaking

link_item was added to the Activities resource.

Mar 1, 2021

Not Breaking

other was added as a possible value for bank_account.account_type field in the Pay Allocations resource.

Feb 28, 2021

Not Breaking

inactive was added as a possible value for the status field in the Employments resource.

Jan 27, 2021

Not Breaking

pay_allocations were added into accounts.availability, allowing you to see whether the pay allocations objects have been synced or updated for an account.

Link items can now be filtered by greater/less than or equal number of max allocations allowed.

Jan 11, 2021

Not Breaking

It is now possible to limit the Link items shown to the user with respect to which pay distribution allocation types are defined in the payDistributionConfig. If you define only the amount_allocation or percent_allocation values in the pay-distribution-config, then only the Link items that support percent or amount allocations will be shown to the user. For more information, please refer to the Argyle Update guide.

Jan 8, 2021

Not Breaking

A new pay_distribution.error value was added in the Accounts resource. unsupported_mfa_method is displayed when the Link item connected by the user does not support updating pay distributions.

Jan 7, 2021

Not Breaking

The Sandbox environment has been updated to make the testing process easier. Please refer to either the Testing: Console guide for a no-code testing workflow via the Argyle Console, or the Testing: API guide for testing an API integration.

Dec 2, 2020

Not Breaking

A new document_id field was added to /payouts. It contains a unique ID of a document (e.g. paystub) associated with the payout.

Dec 1, 2020

Not Breaking

The new features object in link items contain information about pay distribution update capabilities.

Nov 11, 2020

Not Breaking

accounts.source field was added to /v1/accounts. It denotes the source of the account's employment records provided in the Argyle API.

Nov 9, 2020

Not Breaking

A diagram explaining the Argyle data structure has been added to the Argyle Scan guide

Oct 29, 2020

Not Breaking

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.

Oct 26, 2020

Not Breaking

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.

Oct 14, 2020

Not Breaking

With Argyle Update, users can update their direct deposit information and include your bank account into their pay distribution.

May 14, 2020

Not Breaking

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.

Jan 10, 2020

Breaking

activity.income will now return strings instead of json decimals.

activity lat and lng will now be strings for all data partners instead of decimals.

Jan 1, 2020

Not Breaking

account error upgrades have been introduced.