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.
last_used_at	string	Date the API key was last used in a Pinwheel API request. Null if the key hasn't been used.
is_active	boolean	If true, the API key can be used in Pinwheel API requests. Otherwise, the key is no longer useable.
revoked_at	string	Timestamp of when this key was revoked.

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."
    },
    "last_used_at": {
      "type": "string",
      "format": "date",
      "title": "last_used_at",
      "description": "Date the API key was last used in a Pinwheel API request. Null if the key hasn't been used."
    },
    "is_active": {
      "type": "boolean",
      "title": "is_active",
      "description": "If true, the API key can be used in Pinwheel API requests. Otherwise, the key is no longer useable."
    },
    "revoked_at": {
      "type": "string",
      "format": "date-time",
      "title": "revoked_at",
      "description": "Timestamp of when this key was revoked."
    }
  },
  "type": "object",
  "required": [
    "mode",
    "key",
    "created_at",
    "is_active"
  ],
  "title": "object",
  "x-tags": [
    "Schemas"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.pinwheelapi.com/ListAPIKeyResponseData.json"
}