Create Link Token

post

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

Create a token used to launch a Link modal.

Body Params

account_id

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. Only one card can be provided. Supporting multiple cards to be released at a later date.

cards

deposit_forms

string

enum

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

Allowed:

disable_direct_deposit_splitting

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.

document_uploads

string

enum

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

Allowed:

employer_id

uuid

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

enable_bill_navigator

boolean

Defaults to false

Flag stating whether or not the user should be sent through the bill navigator flow. To enable automated switching after navigation inclue bill_switch in the required_jobs field.

enable_self_id

boolean

Defaults to false

Flag stating whether or not the user should be sent through the self-id flow.

end_user

object

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

end_user_id

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.

language

string

enum

Defaults to en

IETF code denoting which language to display in Link.

Allowed:

missing_user_authentication_fields

array of strings

List of missing user PII authentication fields, required for platform matching eligibility checks.

missing_user_authentication_fields

org_name

string

required

length between 3 and 30

Organization or app name that is displayed to the user.

platform_id

uuid

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

platform_type

string

enum

If included, filters results by the platform type. Platforms are either payroll or time_and_attendance. Most platforms are payroll. Payroll platforms support operations such as updating direct deposit allocation settings. Time & Attendance platforms contain data around shifts and hours worked, but do not support payroll operations.

Allowed:

required_jobs

array of strings

An array of job types required to be performed on the user's payroll account. Employers and platforms 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.

required_jobs

skip_intro_screen

boolean

Defaults to false

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

200OK