GuidesAPI ReferenceChangelog
Log In
API Reference

Create Link Token

post
https://api.getpinwheel.com/v1/link_tokens

Create a token used to launch a Link modal.

Body Params
uuid

UUID of the payroll account.

allocation
object

Allocation specified for the link token.

cards
array of objects

Card details needed to attempt a bill switch.

cards
string
enum

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

Allowed:
boolean
Defaults to false

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.

string
enum

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

Allowed:
uuid

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

end_user
object

Optional field where data about an end user can be provided to enable products such as automated platform matching.

string
length between 1 and 255

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.

features
array of strings

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.

features
string
enum
Defaults to en

IETF code denoting which language to display in Link.

Allowed:
string
required
length between 3 and 30

Organization or app name that is displayed to the user.

uuid

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

string
enum

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.

Allowed:
string
length ≤ 40

The identifier for a reseller's customer. This field is required for resellers. For other customers, a non-null value will result in a 400 error. The value supplied must be preregistered with Pinwheel's customer success team.

boolean
Defaults to false

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

string
enum
required

The Pinwheel solution to be presented to the user.

Allowed:
tags
object

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

string
enum

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

Allowed:
Headers
string
enum
required
Defaults to 2025-07-08

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

Allowed:
Response

Updated 5 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago