Pinwheel · Schema
LinkToken
PayrollDirect DepositIncome VerificationEmploymentTax FormsFintechOpen FinanceBill SwitchingFinancial Data
Properties
| Name | Type | Description |
|---|---|---|
| mode | object | Token mode, i.e. `sandbox`, `development`, or `production`. |
| id | string | UUID of the link token. |
| token | string | Short-lived token that is used to initialize Pinwheel Link. |
| smart_branch_url | string | URL that will initiate a Pinwheel-hosted smart branch experience, if smart branch is configured for the workspace. |
| expires | string | The token will be invalid after this timestamp. |
JSON Schema
{
"properties": {
"mode": {
"allOf": [
{
"type": "string",
"enum": [
"sandbox",
"development",
"production"
]
}
],
"description": "Token mode, i.e. `sandbox`, `development`, or `production`."
},
"id": {
"type": "string",
"format": "uuid",
"title": "id",
"description": "UUID of the link token."
},
"token": {
"type": "string",
"title": "token",
"description": "Short-lived token that is used to initialize Pinwheel Link."
},
"smart_branch_url": {
"type": "string",
"title": "smart_branch_url",
"description": "URL that will initiate a Pinwheel-hosted smart branch experience, if smart branch is configured for the workspace."
},
"expires": {
"type": "string",
"format": "date-time",
"title": "expires",
"description": "The token will be invalid after this timestamp."
}
},
"type": "object",
"required": [
"mode",
"id",
"token",
"expires"
],
"title": "LinkToken",
"x-tags": [
"Schemas"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://schema.pinwheelapi.com/LinkTokenObjResponse_v2021_07_28.json"
}