Pinwheel · Schema

object

PayrollDirect DepositIncome VerificationEmploymentTax FormsFintechOpen FinanceBill SwitchingFinancial Data

Properties

Name	Type	Description
mode	object	The mode that the Admin API token is authorized for.
key	string	The public token that refers to your API key, as distinct from the API Secret.
expires_at	string	Timestamp used to set when this key automatically expires.
created_at	string	ISO 8601 timestamp of created time.
secret	string	The secret token part of the API key used to authorize requests to the Pinwheel API.

View JSON Schema on GitHub

JSON Schema

{
  "properties": {
    "mode": {
      "allOf": [
        {
          "type": "string",
          "enum": [
            "sandbox",
            "development",
            "production"
          ]
        }
      ],
      "description": "The mode that the Admin API token is authorized for."
    },
    "key": {
      "type": "string",
      "title": "key",
      "description": "The public token that refers to your API key, as distinct from the API Secret."
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "title": "expires_at",
      "description": "Timestamp used to set when this key automatically expires."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "created_at",
      "description": "ISO 8601 timestamp of created time."
    },
    "secret": {
      "type": "string",
      "title": "secret",
      "description": "The secret token part of the API key used to authorize requests to the Pinwheel API."
    }
  },
  "type": "object",
  "required": [
    "mode",
    "key",
    "created_at",
    "secret"
  ],
  "title": "object",
  "x-tags": [
    "Schemas"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.pinwheelapi.com/CreateAPIKeyResponseData.json"
}