API Reference

The number of objects to be returned. The default value is 10. The maximum value is 200.

The URL to request the next page. The returned value will be null if this is the last page.

The URL to request the previous page. The returned value will be null if this is the first page.

An array containing the resources requested.

Unique ID of the webhook.

An array of Argyle's webhook event types (e.g., ["activities.added"]). Refer to the webhooks reference for a full list of available event types.

The endpoint that will be invoked when the specified event occurs.

Configuration options of the webhook. Refer to the webhooks reference to learn more about available configuration parameters.

An arbitrary name that will be sent back to your system in the webhook payload.

The key that will be used to generate HMAC-SHA512 hex digest value in the X-Argyle-Signature header.

Identifier of the webhook object to be retrieved.

The number of webhook objects to be returned. The default is 10. Max value is 200.

An array of Argyle webhook event types. Specify ['*'] to subscribe to all webhook events.

The endpoint that will be invoked when the specified event occurs.

Configuration options of the webhook. Refer to the webhooks reference to learn more about available configuration parameters.

An arbitrary name that will be sent back to your system in the webhook payload.

If provided, secret will be used as a key in the HMAC-SHA512 algorithm to generate a hex digest, which will then be included in the X-Argyle-Signature header in every webhook request to your system.

ID of the webhook to be deleted.

Unique ID of the Link item. A lot of the time (but not always) Link item IDs will be human-readable. For human-readable values, refer to the name attribute.

Unique ID of the Link item. This ID is not human-readable.

Provides information on the health of a particular Link item. The healthy value indicates successful account connections. When Argyle’s data partners are experiencing issues and connections are not successful or partially degraded, the value will be issues. In this case, the status_details field can be used to provide additional information about the Link item’s status.

Possible values: healthy, issues.

The status_details field can be used to provide additional information about a particular Link item’s status. When status_details is not filled, the value returned will be null.

Name of the Link item (e.g., Walmart, Uber, Gusto).

Type of the Link item (e.g., delivery, retail, rideshare, services, technology).

Type of the Link item.

Possible values: employer, gig, platform, creator, benefits.

A URL to the Link item logo. Authentication is required to access this field.

Will be true if the Link item is disabled. Link items are disabled if there is an issue with the underlying data provider.

Will be true if the underlying data provider requires two-factor authorization to log in.

Contains information about pay distribution bank account update capabilities of a given Link item. Please refer to the Pay Distribution Guide for more information.

Denotes if the Link item supports pay distribution bank account updates.

If false, the features fields will not be shown in the API response.

Denotes the maximum amount of bank account allocations an account can have in the given Link item.

Denotes if the Link item allows setting amount allocations for bank accounts—for example, $500 to one bank account and remained to another.

Denotes if the Link item allows setting percent allocations for bank accounts—for example, 60% to one bank account and remainder to another.

Denotes the level of granularity of the pay distribution amount for bank accounts. This way you can define the amount up to the cent level of detail - with 2 decimals.

Possible values: 100, 10, 1, 0.1, 0.01

Denotes the level of granularity of the pay distribution percentage for bank accounts. This way you can define the percentage of the pay distribution with up to the 4 decimal places.

Possible values: 100, 10, 1, 0.1, 0.01, 0.001, 0.0001.

Lists string enum values that indicate what types of actions are required by the Link item to make any newly added allocations active for bank accounts.

If no action is required, then an empty list is returned.

Possible values: microdeposit_verification.

Contains information about pay distribution card update capabilities of a given Link item.

Denotes if the Link item supports card pay distribution updates. If false, the features fields will not be shown in the API response.

Denotes the maximum amount of card allocations an account can have in the given Link item.

Describes Item's known limitations, e.g. how far back historical data goes, degree of value obfuscation (if any).

The identifier of the Link item to be retrieved. Either id or item_id values can be used.

Only return Link items with the provided IDs. Multiple IDs should be separated by commas. Either id or item_id values can be used.

Only return Link items with the provided name. Only one name can be provided by using filtering by name. To filter multiple Link items, please use filtering by ID.

The number of Link item objects to be returned. The default is 10. Max value is 200.

Denotes if the Link item requests for microdeposit verification for bank accounts.

If set to true, the response will contain only Link items, which support pay distribution updates for bank accounts.

Return Link items with the specified number of maximum allocations allowed for bank accounts.

Return Link items where the max_allocations field is greater than this value for bank accounts.

Return Link items where the max_allocations field is greater than or equal to this value for bank accounts.

Return Link items where the max_allocations field is less than this value for bank accounts.

Return Link items where the max_allocations field is less than or equal to this value for bank accounts.

If set to true, the response will contain only Link items, which support percent allocations for bank accounts.

If set to true, the response will contain only Link items that support amount allocations for bank accounts.

If set to true, the response will only contain Link items that support card pay distribution updates.

Return Link items with the specified number of maximum allocations allowed.

Return Link items where the max_allocations field is greater than this value.

Return Link items where the max_allocations field is greater than or equal to this value.

Return Link items where the max_allocations field is less than this value.

Return Link items where the max_allocations field is less than or equal to this value.

The kind of Link items to be returned. A single value is accepted.

Possible values: employer, gig, platform, creator, benefits.

The kinds of Link items to be omitted. A comma-separated list of kinds is accepted.

Possible values: employer, gig, platform, creator, benefits.

The name of the Link Item to be searched.

The kind of Link items to be returned. A single value is accepted.

Possible values: employer, gig, platform, creator, benefits.

The kinds of Link items to be omitted. A comma-separated list of kinds is accepted.

Possible values: employer, gig, platform, creator, benefits.

The number of Link items to be returned. The default is 15. Max value is 200.

Unique ID of the user.

Time at which the user was created. Timestamps follow the ISO 8601 standard.

A list of names of employers that the user has connected to via Argyle Link. This list might be different from data_providers_connected, which can include payroll platforms (for example, MyADP). The connections might be active or previously connected employers, which are no longer active (for example, due to a user switching jobs).

This field is populated after the initial scan is completed and the account is connected successfully, so there is a short (a few seconds) delay before you can see the list. Use the employments webhook to know when this data is available on the platform.

A list of the IDs of Link items that the user has connected. The connections might be active or previously connected Link items, which are no longer active (for example, due to a user switching jobs). This field is populated immediately after user creation.

You can set external metadata when creating or updating a user. This external metadata can be used to map users between Argyle and your own database. External metadata can be any valid JSON, such as a string or an object.

External metadata can be any valid JSON—for example, a string or an object.

ID of the user whose metadata you want to retrieve.

External metadata can be any valid JSON—for example, a string or an object.

ID of the user, whose metadata should be updated.

External metadata can be any valid JSON — e.g. a string or an object.

The identifier of the user to be retrieved.

The number of user objects to be returned. The default is 10. Max value is 200.

ID of the user to be deleted.

ID of the user to create a new token for.

Unique ID of the account.

ID of the user associated with the account.

A list of names of all employers associated with this account. In most cases, this will return a single employer. However, sometimes the same payroll platform account (e.g., MyADP) is associated with more than one employer.

ID of the Link item (i.e. company or platform), that the user selected when connecting their account via Argyle Link. This value will oftentimes be human-readable.

link_item supersedes the now deprecated data_partner field.

Denotes the source of the account's employment records provided in the Argyle API. Source value will be the same as link_item when a company has an in-house solution for managing employment data:

link_item="uber"

source="uber"

Or it can be different when a company is utilizing a third-party payroll platform:

link_item="homedepot"

source="workday"

Time at which the account was connected. Timestamps follow the ISO 8601 standard.

Time at which the account was updated. Timestamps follow the ISO 8601 standard.

Indicates whether the account has been successfully connected at some point in the past. Once an account has been successfully connected, was_connected will return true and will stay true indefinitely, even if that account becomes disconnected later on.

Represents the status of the link between Argyle and the work platform. Possible values:

connecting – a connection to the Link item is being established. This status only occurs when a user submits their credentials through Argyle Link for a new account or for an existing account.

connected – account is linked with the Link item. Please note, that this does not mean the data pull has finished. Use the availability field to check if data has been synced.

error – the connection to the Link item is not currently live. Argyle is not able to pull data for the account. See connection.error_code below for details.

Provides information on why the connection failed when connection.status is error.

Possible values: account_disabled, account_inaccessible, account_incomplete, auth_required, expired_credentials, invalid_account_type, invalid_auth, invalid_credentials, invalid_mfa, login_attempts_exceeded, mfa_attempts_exceeded, mfa_exhausted, mfa_not_configured, mfa_timeout, service_unavailable, system_error, tos_required, trial_period_expired, unsupported_auth_type, unsupported_mfa_method.

Each error_code has a corresponding error_message (see below).

Provides additional information on why the connection error occurred. Each error_message corresponds to a particular error_code (see above). The list below is formatted as:

error_code - error_message

Possible values:

account_disabled - this user's employment account appears to be suspended or disabled.

account_inaccessible - this user's account is not currently accessible. Our team has been notified and is investigating.

account_incomplete - this user's employment account is not yet active.

auth_required - this user's connection has expired and requires re-authentication.

expired_credentials - this user provided credentials which are out of date (i.e., a password reset is required).

invalid_account_type - this user provided credentials for the wrong account type (e.g., a passenger account rather than a driver account, or an admin account rather than an employee account).

invalid_auth - this user's account login was unsuccessful, either due to invalid credentials or unsuccessful multi-factor authentication.

invalid_credentials - this user provided invalid credentials.

invalid_mfa - this user did not provide the correct multi-factor authentication response.

login_attempts_exceeded - this user provided invalid credentials too many times, causing them to be temporarily unable to attempt further logins.

mfa_attempts_exceeded - this user failed multi-factor authentication too many times, causing them to be unable to attempt further logins until multi-factor authentication method is reset.

mfa_exhausted - this user failed multi-factor authentication too many times, requiring them to re-authenticate.

mfa_not_configured - this user has not configured multi-factor authentication for their employment account, restricting access to the user's employment data.

mfa_timeout - this user did not complete multi-factor authentication.

service_unavailable - the platform this user is attempting to connect to is currently unavailable. See the Coverage page in Console for additional information.

system_error - Argyle encountered a problem connecting to this account. Our team has been notified and is investigating.

tos_required - this user has not accepted the Terms of Service presented by their payroll provider, preventing access to their employment account.

trial_period_expired - this user's employment account is in a trial account, and is currently disabled because the trial period has expired.

unsupported_auth_type - this user tried to log in using single sign-on (e.g., Google, Facebook), which Argyle does not currently support.

unsupported_mfa_method - this user's employment account uses a multi-factor authentication method that Argyle does not currently support.

Timestamp denoting the last time connection status was updated. Timestamps follow the ISO 8601 standard.

Denotes the point in the process of the pay distribution update process. Possible values:

idle - pay distribution update process has not been initiated.

awaiting_confirmation - waiting for the user to confirm updated pay distribution.

awaiting_connection - waiting to establish connection to the user's employment account.

scanning - scanning existing pay allocations prior to update process.

updating - updating the user's pay distribution.

success - pay distribution update successful.

error – pay distribution update unsuccessful. See the pay_distribution.error_code below for details.

Provides information on why the pay distribution update was unsuccessful when pay_distribution.status is error.

Possible values: confirmation_timeout, incompatible_config, invalid_mfa, mfa_exhausted, mfa_not_configured, mfa_timeout, missing_allocation_type, not_supported, not_supported_by_employer, rejected_bank_account, rejected_routing_number, service_unavailable, system_error, unsupported_allocation_type, unsupported_bank_accounts, unsupported_mfa_method, waiting_period.

Each error_code has a corresponding error_message (see below).

Provides additional information on why the pay distribution update error occurred. Each error_message corresponds to a particular error_code (see above). The list below is formatted as:

error_code - error_message

Possible values:

confirmation_timeout - this user did not finish setting up their new pay distribution.

incompatible_config - the pay allocation details that have been submitted are not supported by this user's employment account.

invalid_mfa - this user did not provide the correct multi-factor authentication response.

mfa_exhausted - this user failed multi-factor authentication too many times, requiring them to re-authenticate.

mfa_not_configured - this user has not configured multi-factor authentication for their employment account, restricting access to the user's employment data.

mfa_timeout - this user did not complete multi-factor authentication.

missing_allocation_type - one or more of this account's pay allocations is missing a type (percent/amount/remainder), causing Argyle to be unable to update the user's pay distribution information.

not_supported - this user's employment account does not support updating pay distribution information.

not_supported_by_employer - this user's employment account does not support changes to pay distribution information. This may be because the employer has disabled users from editing this information.

rejected_bank_account - the provided bank account cannot be used for pay distribution update. Please provide a different bank account.

rejected_routing_number - the provided routing number is considered invalid by this user's employment account.

service_unavailable - this user's employment platform is experiencing downtime and is currently unable to process updates to pay allocations.

system_error - Argyle encountered a problem when reading or updating pay distribution information. Our team has been notified and is investigating.

unsupported_allocation_type - one or more of this account's pay allocations is not currently supported, causing Argyle to be unable to update the user's pay distribution information. Supported allocation types are percent, amount and remainder.

unsupported_bank_accounts - this user's employment account includes pay allocations to bank account types that Argyle does not yet support, like HSAs.

unsupported_mfa_method - this user's employment account uses a multi-factor authentication method that Argyle does not currently support.

waiting_period - pay distribution update is temporarily unavailable. This can happen when an employer requires a waiting period after recent pay distribution updates or after initial account creation.

Timestamp denoting the last time pay distribution was updated. Timestamps follow the ISO 8601 standard.

The availability object shows the synchronization status and the updated_at fields for each data resource (e.g., documents, vehicles, payouts, etc.) within the account. Event data resources (e.g. payouts, activities) have additional information pertaining to event count and availability timeframe.

pay_allocations availability will only be present if your Argyle account has pay distribution updating enabled. Additionally, if pay distribution updating is enabled, but the pay allocation resource is not available within the Link item platform, then pay_allocations will be null.

For more information on data synchronization, please refer to Gradual Data Delivery.

Denotes the status of the data scan. Possible values:

in_progress - initial data pull is in progress.

synced - data is synced as of the time indicated in the updated_at field.

sync_failed - data pull failed. Please refer to connection.error_code to troubleshoot potential problems.

Timestamp of the last data scan. Timestamps follow the ISO 8601 standard.

The number of available events (e.g. activities, payouts).

During the first scan of an account, the value of this field will change with each scanning iteration until the availability.status becomes synced.

Denotes the end point of the time interval, for which the events (e.g. activities, payouts) are available. Timestamps follow the ISO 8601 standard.

During the first scan of an account, the value of this field will change with each scanning iteration until the availability.status becomes synced.

Denotes the start point of the time interval, for which the events (e.g. activities, payouts) are available. Timestamps follow the ISO 8601 standard.

During the first scan of an account, the value of this field will change with each scanning iteration until the availability.status becomes synced.

status is deprecated in favor of connection.status.

error_code is deprecated in favor of connection.error_code.

data_partner is deprecated in favor of link_item.

The identifier of the account to be retrieved

Only return accounts for the data partner with the provided ID.

Only return accounts for the user with the provided ID.

The number of account objects to be returned. The default is 10. Max value is 200.

ID of the account to be deleted.

Unique ID of the form.

Represents the status of the form. Possible values:

submitted: Signifies that a form has been submitted by the user with all mandatory fields completed.

The value entered by the user when prompted for their employer name. Only available if you have configured this form in Link Customizer. This field will be present if the user initiated the document upload flow via the Can't find your employer? button.

The value selected by the user when prompted for their payroll platform. Only available if you have configured this form in Link Customizer. This field will be present if the user initiated the document upload flow via the Can't find your employer? button.

A list of paystub documents uploaded by the user. Only relevant if you have configured paystubs in Link Customizer.

A list of 1099 documents uploaded by the user. Only relevant if you have configured 1099 documents in Link Customizer.

A list of W2 documents uploaded by the user. Only relevant if you have configured W2 documents in Link Customizer.

Unique ID of the file

Represents the status of the file. Possible values:

AVAILABLE: Signifies that the file can be viewed/downloaded using the URL reference provided in the url field

URL reference where the file can be found. The url contains a URL to the file. The URL is valid for 15 minutes.

The name of the file. The value will be the name of the file as it appeared on the users' device when they uploaded it, including the file extension.

The size of the file represented in bytes.

Time at which the file was created. Timestamps follow the ISO 8601 standard.

The value entered by the user when prompted for their employer name. This field will be present if the user initiated the document upload flow via the Can't find your employer? button.

The value selected by the user when prompted for their payroll platform. This field will be present if the user initiated the document upload flow via the Can't find your employer? button.

The identifier of the account associated with the forms to be retrieved.

The identifier of the form to be retrieved.

A unique ID for the invite.

The user ID associated with this invite. It is available only when a user has accepted the invite and successfully connected via Argyle Link.

Denotes whether the invite has been accepted by connecting via Argyle Link and status becomes connected.

Possible values: true, false.

A unique token generated by Argyle Link. Only available when a user has attempted to connect via Argyle Link. Used to restore the session if a user comes back for a second time to update their information.

The full name of the user.

The email address which received the invite.

The phone number which received the invite.

Denotes the time when the invitation was sent out. This field is updated if you resend an invite.

ID of the user invite template that was used to send the invite.

The status of the invitation.

Possible values: connected, invited, revoked.

Denotes when the invite was revoked.

ID of the user invite template that should be used to send the invite.

The full name of the user.

The phone number of the user. Optional, but at least one of email and phone_number is required.

The email address of the user. Optional, but at least one of email and phone_number is required.

Allows you to customize Argyle Link UI that your users will see when they connect their employment accounts. Check here how to customize the Link and obtain the customization_id through Link Customizer.

Allows you to configure your pay distribution. See all available parameters in the Pay Distribution configuration section.

Deprecated in favor of customization_id.

Use this parameter to limit the number of Link items that your users can connect to. Provide an array of Link item IDs you want Argyle Link to display in the company selection screen. The order in which you list the IDs will define the order in which they are displayed in the UI.

If you provide a single Link item ID, the company selection screen will be skipped and the user will be navigated directly to the Link item login screen.

Deprecated in favor of customization_id.

When set to true, only Link items that support pay distribution will be shown. For more information on changing pay distributions, please refer to the Pay Distribution Guide.

If a payDistributionConfig is provided, then only the Link items that match the parameters in the config will be shown. For example, if the payDistributionConfig allows only amount allocations and a Link item supports percent allocations only, then that Link item will not be shown.

If no payDistributionConfig is provided then all Link items that have some pay distribution support (amount and/or percent) will be shown.

The default value is false.

ID of the invite to be resent.

ID of the invite to be revoked.

The identifier of the user invite to be retrieved.

The number of user invite objects to be returned. The default is 10. Max value is 200.

A unique ID for the template.

The name of the template.

Your company/brand name that is shown to users in the invite.

A link to the logo to be used in the invitation email. Logo dimensions: 120x120.

The text message content to be sent as part of the invitation.

The "From" field of the invitation email.

The email subject of the invitation email.

The title header of the invitation email.

The text content of the email that to be sent as part of the invitation.

The call-to-action button label within the email.

The heading 1 of the landing page.

The text content of the landing page.

The call-to-action button label on the landing page to initiate Argyle Link.

The heading 1 of the success page.

The text content of the success page.

Denotes if the action button on the success page is shown.

If true, the page_success_button is required.

The call-to-action button label on the success page.

It is required when page_success_show_button = true.

The name of the template.The text content of the email that to be sent as part of the invitation.

The text content of the email that to be sent as part of the invitation.

The text message content to be sent as part of the invitation.

The title header of the invitation email.

The call-to-action button label within the email.

The email subject of the invitation email.

The "From" field of the invitation email.

The company name to be displayed when using the [Sender] placeholder.

A link to the logo to be used in the invitation email.

The heading 1 of the landing page.

The text content of the landing page.

The call-to-action button label on the landing page to initiate Argyle Link.

The heading 1 of the success page.

The text content of the success page.

Denotes if the action button on the success page is shown.

If true, the page_success_button is required.

The call-to-action button label on the success page.

It is required when page_success_show_button = true.

The identifier of the user invite template to be retrieved.

The number of user invite template objects to be returned. The default is 10. Max value is 200.

ID of the user invite template to be deleted.

Unique ID of the profile associated with a user's data partner account.

ID of the account associated with the profile.

The name of the company or entity that employs the user.

The legal first name of the user.

The legal last name of the user.

The full legal name of the user.

Email address.

Phone number. Value is returned in the E.164 international phone number format.

Date of birth. Timestamps follow the ISO 8601 standard.

In some rare cases, the Link item platform will obfuscate the birth year and the returned value will be formatted with having a dash instead of the year number: --01-20.

Profile picture of the user (if available from the data partner). The value will be a URL pointing to the internal storage where the image is held.

Address line 1 (e.g., street, PO Box, or company name).

Address line 2 (e.g., apartment, suite, unit, or building).

City, district, suburb, town, or village.

State, county, province, or region.

ZIP or postal code.

Two-letter country code returned in the ISO 3166-1 alpha-2 format.

Social Security Number.

Marital status of the user.

Gender of the user.

Metadata holds additional available, often unstructured, information about this data resource.

Deprecated in favor of employments.status.

Status of employment.

Possible values: active, terminated.

Deprecated in favor of employments.type.

Type of employment (e.g., part-time, full-time, hourly, salary, contractor).

Deprecated in favor of employments.job_title.

The current job title of the user. The value will usually be a free-form text returned from the data partner (e.g., sales associate, driver).

Deprecated in favor of employments.platform_user_id.

ID from the data partner platform.

Deprecated in favor of employments.hire_datetime.

An array of dates when the user was hired with respect to this particular profile. Timestamps follow the ISO 8601 standard.

Deprecated in favor of employments.termination_datetime and employments.termination_reason.

List of all termination events of a user with respect to this particular profile.

Deprecated in favor of employments.termination_datetime.

Date of the termination event. Timestamps follow the ISO 8601 standard.

Deprecated in favor of employments.termination_reason.

Reason for the termination event. Free-form text entry provided by the data partner.

The identifier of the profile to be retrieved.

Only return the profile for the account with the provided ID.

Only return profiles for the user with the provided ID.

The number of profile objects to be returned. The default is 10. Max value is 200.

Unique ID of the employment object associated with a user's data partner account.

ID of the account associated with the employment object.

The name of the company or entity that employs the user.

Status of employment.

Possible values: active, inactive, terminated.

Type of employment.

Possible values: full-time, part-time, contractor, seasonal, temporary, other.

The current job title of the user. The value will usually be a free-form text returned from the data partner (e.g., sales associate, driver).

The date when the user was hired by the employer. Timestamps follow the ISO 8601 standard.

The date when the user's employment was terminated by the employer. Timestamps follow the ISO 8601 standard.

Reason for the termination event. Free-form text entry provided by the employer or data partner.

A fixed amount of money paid to a user, not including any bonuses, commission, or other discretionary incentives.

The unit of time base_pay.amount corresponds to. biweekly occurs every two weeks while semimonthly occurs twice a month.

Possible values: hourly, weekly, biweekly, semimonthly, monthly, annual.

A user's base pay currency. Currencies follow the ISO 4217 format.

The frequency at which the user gets paid. biweekly occurs every two weeks while semimonthly occurs twice a month.

Possible values: weekly, biweekly, semimonthly, monthly, quarterly.

A unique ID assigned to a user by an employer.

A unique ID assigned to a position by an employer.

A unique ID assigned to a user by a payroll platform.

Metadata holds additional available, often unstructured, information about this data resource.

Deprecated in favor of platform_ids.platform_user_id.

A unique ID assigned to a user by a payroll platform.

The identifier of the employment to be retrieved.

Only return the employment for the account with the provided ID.

Only return employments for the user with the provided ID.

The number of employment objects to be returned. The default is 10. Max value is 200.

Unique ID of the payout associated with a user's data partner account.

ID of the account associated with the payout.

A unique ID of a document (e.g. paystub) associated with the payout.

The name of the company or entity that employs the user.

The status of the payout execution.

Possible values: completed, scheduled, cancelled.

Payout type.

Possible values: direct_deposit , paper_check, paypal, money_network, pay_card, other.

Some companies or platforms do not support the type attribute, in which case a null value will be returned.

Timestamp representing the payout execution date. Timestamps follow the ISO 8601 standard.

The start date of the work period for which the payout was executed. Timestamps follow the ISO 8601 standard.

The end date of the work period for which the payout was executed. Timestamps follow the ISO 8601 standard.

Currency of the payout (e.g., EUR, USD). Currencies follow the ISO 4217 format.

The amount received by the worker before any taxes or deductions are taken out.

The amount of gross pay received in this calendar year.

Argyle does not calculate the value of gross_pay_ytd. This field will only return any values in case those values are found on your user’s paystubs, and otherwise will return null.

Compensation to the user for paying for work-related expenses by using personal money.

Deductions are benefits, like health insurance or retirement plans, that are taken out from gross pay. The deductions amount does not include taxes.

Provides a breakdown of the deductions for the given payout. Please note that not all payroll platforms provide this breakdown and thus the sum of deduction_list.amount fields might not add up to the number in the deductions field.

The name of the deduction as shown in the payout (e.g. Dental, Vision, Roth).

The amount of the deduction.

The tax classification of the deduction.

Possible values: pre_tax, post_tax.

The amount of taxes that are withheld from the user's gross pay.

Provides a breakdown of the taxes for the given payout. Please note that not all payroll platforms provide this breakdown and thus the sum of tax_list.amount fields might not add up to the number in the taxes field.

The name of the tax as shown in the payout (e.g. Federal Withholding, Social Security Tax, Medicare).

The type of the tax.

Possible values: federal, state, local, fica, other.

The amount of the tax.

The fee associated with receiving the payout. This field is relevant to gig platforms, which sometimes allow a user to receive a payout quicker than usual for a small fee.

The total amount of money received by the user after all taxed and required and voluntary deductions were taken into account.

The amount of net pay received in this calendar year.

Argyle does not calculate the value of net_pay_ytd. This field will only return any values in case those values are found on your user’s paystubs, and otherwise will return null.

Additional amount added to the base pay.

A fee paid to a user for transacting a piece of business, like closing a sale or making a deal.

The amount of pay that is generated during overtime work hours.

Total number of hours worked during the work period for which the payout was executed.

Address line 1 (e.g., street, PO Box, or company name).

Address line 2 (e.g., apartment, suite, unit, or building).

City, district, suburb, town, or village.

State, county, province, or region.

ZIP or postal code.

Two-letter country code returned in the ISO 3166-1 alpha-2 format.

Provides the objects that contain the location, status, and type of filing for a payout.

The location of the filing status will correspond to filing_status.type.

For filing_status.type = federal, a null value will be returned.

For filing_status.type = state, the value could be the name a state name ("Virginia"), state code ("VA"), or similar

For filing_status.type = local, the value could be a city name ("New Orleans"), an area code (for example, "395"), or similar.

The filing status, for example: single, married, married filing jointly, married filing separately, head of household, or qualifying widow(er) with dependent child.

The type of the filing status.

Possible values: federal, state, local.

Metadata holds additional available information about this data resource.

The identifier of the payout to be retrieved.

Only return payouts for the account with the provided ID.

Only return payouts for the user with the provided ID.

The timestamp the payouts should be retrieved from. The following formats are accepted:

• just date - 2019-01-01
• date with time - 2019-01-01T07:30:00Z
• date with time and with timezone - 2019-01-01T07:30:00+02:00

If an exact time is not provided, the value will be set to 00:00:00+00:00 – midnight in UTC.

The timestamp the payouts should be retrieved to. The formatting is the same as in from_start_date.

The number of payouts objects to be returned. The default is 10. Max value is 200.

Unique ID of the document associated with a user's data partner account.

ID of the account associated with the document.

The name of the company or entity that employs the user.

The identification number on the document.

Describes the document type.

Possible values: W-2, payout-statement, W-4, W-9, 1099, 1095, profile-picture, drivers-licence, vehicle-insurance, vehicle-registration, vehicle-inspection, other.

A free-form text describing the document's type (e.g., W-2 Form 2019).

The expiration date of the document. Timestamps follow the ISO 8601 standard.

Represents the timestamp when the document was made available to the employee.

If available, file_url contains a URL to the file. The URL is valid for 15 minutes.

Metadata holds additional available, often unstructured, information about this data resource.

The identifier of the document to be retrieved.

Only return documents for the account with the provided ID.

Only return documents for the user with the provided ID.

The number of document objects to be returned. The default is 10. Max value is 200.

Unique ID of the report object.

A unique ID assigned to a user.

Unique ID of the report referenced on the PDF used as a single reference point.

Shows the date and time when the report was generated.

Type of report. Possible values:

voie - Verification of Income and Employment (VOIE) report.

The status of the report generation process. Possible values:

waiting_for_sync - account is being synced.

generating - report is being generated.

generated - report is ready to be downloaded.

URL reference where the report can be found. The file_url contains a URL to the file. The URL is valid for 15 minutes.

Other report metadata. For type = VOIE, this would include the purpose field value.

Defines the email address to which a generated report will be sent.

Unique user ID.

Specifies which report to generate. Possible values:

voie - Verification of Income and Employment (VOIE) report.

Specifies the permissible purpose for report generation. It is required when the field type = VOIE.

Defines the email address to which a generated report will be sent.

The identifier of the report to be retrieved.

Only returns reports for the user with the provided ID.

The number of report objects to be returned. The default is 10. Max value is 200.

Unique ID of the activity associated with a user's data partner account.

ID of the account associated with the activity.

The name of the company or entity that employs the user.

ID of the Link item (i.e. company or platform), that the user selected when connecting their account via Argyle Link. This value will oftentimes be human-readable.

link_item supersedes the now deprecated data_partner field.

Deprecated in favor of link_item.

ID of the data partner associated with the user's account, within which the activity was recorded.

The current state of this activity.

Possible values: scheduled, in_progress, completed, cancelled.

The type of activity that the worker undertook.

Possible values: delivery, rideshare, hourly, services.

Activity-specific data attributes (metadata) provided by the Link item.

The number of tasks performed. Will contain 1 if the activity object represents a single job (e.g. a shift or trip). Will be 2 or more if the object represents an aggregate of tasks performed between start_datetime and end_datetime. It will contain null if the number of tasks performed is not known. This will be the case for companies that only provide aggregate data.

Timestamp representing the start of the activity. Timestamps follow the ISO 8601 standard.

Timestamp representing the end of the activity. Timestamps follow the ISO 8601 standard.

The various timestamps of events inside of the activity. E.g.,* *shift_start, shift_end, break_start, break_end, task_start, task_end, pickup_at, dropoff_at, request_at, cancelled_at.

The formatting of all_timestamps can vary depending on the data partner. See all_datetimes below for values formatted according to the ISO 8601 standard.

Same attributes as in all_timestamps but all timestamps are converted to the ISO 8601 standard.

Duration time for the activity displayed in seconds.

The timezone of the activity. A list of possible time zone values is maintained at the IANA Time Zone Database.

The reason for specific earning. Not all earnings are due to activities. Some are just bonuses after the fact, some are incentives to work on peak hours, etc. Possible values:

• offer - not yet completed earning, but a promise to get money when work is completed.
• work - earning for completed work.
• incentive - incentive to work odd hours, etc.
• adjustment - additional earning after the work (for example, to meet minimum wage).
• other - any other value that doesn't fit in the above (for example, might be a work-related product purchase provided to the user by the company that is subtracted from the user's earnings).

An object that contains information about the amount earned for an activity

Currency the income was received in (e.g. USD, EUR). Currencies follow the ISO 4217 format.

The amount the company associated with the Link Item has charged for an activity (inclusive of any fees).

income.total_charge = income.fees + income.total

Fees charged by the company associated with the Link Item (e.g. Uber) for an activity assigned to the user.

Total amount received for this activity by a user: the sum of pay, tips, and bonus.

The amount received for the job excluding tips, bonus, and fees.

The amount of tips received for the activity.

The amount of bonus payment received for the activity.

Taxes incurred by the worker during this activity.

Deprecated.

This object will contain various rates as returned from the data partner. Rates can be per mile, minute or other unit.

The geographical location of where the activity has started.

The geographic latitude of where the activity started.

The geographic longitude of where the activity started.

Full address of where the activity started.

Location of where the activity has ended.

The geographic latitude of where the activity ended.

The geographic longitude of where the activity ended.

Full address of where the activity ended.

URL to the data provider page that contains the route of the activity.

Distance traveled during the activity.

Distance measurement unit for the activity.

Possible options: miles; km.

Metadata holds additional available, often unstructured, information about this data resource.