GEgetpinwheel
Link Tokens

Create Link Token

Changed on

Create a token used to launch a Link modal.

post/link_tokens

Request

Headers

Pinwheel-Version'2025-07-08' | '2023-11-22' | '2023-07-18' | '2023-04-18' | '2022-09-09' | '2022-06-22' | '2022-03-02' required

Version identifier specifying how the Pinwheel API should behave. See the Change Management page for more information.

Request body

org_namestring required

Organization or app name that is displayed to the user.

skip_intro_screenboolean

If set to true, intro screen is not shown to user.

employer_idstring uuid

UUID of an employer. If set, user is taken directly to Link login screen.

disable_direct_deposit_splittingboolean

If set to true, user will not be given the option to choose between a full or partial direct deposit switch. Only relevant with job direct_deposit_switch. Defaults to false.

platform_idstring uuid

UUID of a platform. If set, user is taken directly to Link login screen.

platform_type'payroll' | 'time_and_attendance' | 'tax' | 'merchant'

The type of the platform. payroll platforms are used for direct-deposit switching and for Verify use cases. time_and_attendance platforms contain data around shifts and hours. tax platforms are used for tax solutions. merchant type platforms are used for bill switching and cancellation.

language'en' | 'es' | 'es-419' | 'pt-br'

IETF code denoting which language to display in Link.

end_user_idstring

User ID provided by you, to associate Pinwheel users with your user model. Required if account_id is not provided. This ID will be returned in all webhook events and all account-affiliated API responses. Leading and trailing whitespace will be stripped. Do not include PII in this identifier.

account_idstring uuid

UUID of the payroll account.

document_uploads'direct' | 'fallback' | 'disabled'

Optional parameter to facilitate pathway into document uploads usage. Defaults to None.

tagsobject

Tags associated with the Link token. These are restricted to string key-value pairs.

deposit_forms'direct' | 'fallback' | 'disabled'

Optional parameter to facilitate pathway into deposit forms. Defaults to fallback if deposit forms are enabled for your workspace.

use_case'account_onboarding' | 'account_servicing' | 'underwriting'

Field to indicate where in your application Pinwheel is being launched. Required if leveraging Background Identify (PreMatch employee lookup check prior to SDK initialization).

partner_customer_idstring

The identifier for a partner's customer. This field is required for banking platforms and resellers. The value supplied must be preregistered with Pinwheel's customer success team.

reseller_customer_idstring

Deprecated: use partner_customer_id instead. The identifier for a partner's customer. The value supplied must be preregistered with Pinwheel's customer success team. If both partner_customer_id and reseller_customer_id are provided, they must match.

solution'Bill Manager' | 'Bill Switch' | 'Switch Kit' | 'Deposit Switch' | 'Verify' | 'Paycheck Viewer' required

The Pinwheel solution to be presented to the user.

featuresstring[]

A list of job types to be performed on the user's account. Platforms/merchants that do not support ALL of these jobs will not be visible to the user. This property is required unless the account_id property is set.

Response

OK

Changes

  • f6020f4b6ac7Revision changes
    • info

      added the new optional request property

    • info

      request property deprecated

  • 122cbe007e86Revision changes
    • warning

      removed the request property //