Pinwheel · Schema

Document for end user

PayrollDirect DepositIncome VerificationEmploymentTax FormsFintechOpen FinanceBill SwitchingFinancial Data

Properties

Name	Type	Description
id	string	Unique identifier of the document object.
created_at	string	ISO 8601 timestamp of created time.
end_user_id	string	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 respo
document	object	A document.
document_type	object	The type of the document.
parsed_data	object	The parsed data of the document.
warnings	array	Used to indicate if there are any warnings for fields returned in this response.
fraud	object	Used to indicate any fraud indications in this document.

View JSON Schema on GitHub

JSON Schema

{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "title": "id",
      "description": "Unique identifier of the document object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "created_at",
      "description": "ISO 8601 timestamp of created time."
    },
    "end_user_id": {
      "type": "string",
      "title": "end_user_id",
      "description": "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."
    },
    "document": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DocumentObjPublicResponseItem"
        }
      ],
      "title": "document",
      "description": "A document."
    },
    "document_type": {
      "allOf": [
        {
          "type": "string",
          "enum": [
            "paystub",
            "W-2",
            "1099",
            "direct_deposit_form",
            "verification_report",
            "1040",
            "bank_statement",
            "ssi_award_letter",
            "w2",
            "verification_photo"
          ]
        }
      ],
      "description": "The type of the document."
    },
    "parsed_data": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/UploadedPaystub"
        },
        {
          "$ref": "#/components/schemas/UploadedBankStatement"
        },
        {
          "$ref": "#/components/schemas/UploadedSSIAwardLetter"
        },
        {
          "$ref": "#/components/schemas/UploadedW2Informed"
        }
      ],
      "title": "parsed_data",
      "description": "The parsed data of the document.",
      "discriminator": {
        "propertyName": "document_type",
        "mapping": {
          "paystub": "#/components/schemas/UploadedPaystub",
          "bank_statement": "#/components/schemas/UploadedBankStatement",
          "ssi_award_letter": "#/components/schemas/UploadedSSIAwardLetter",
          "w2": "#/components/schemas/UploadedW2Informed"
        }
      }
    },
    "warnings": {
      "items": {
        "$ref": "#/components/schemas/FieldWarning"
      },
      "type": "array",
      "title": "warnings",
      "description": "Used to indicate if there are any warnings for fields returned in this response."
    },
    "fraud": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SharedFraud"
        }
      ],
      "title": "fraud",
      "description": "Used to indicate any fraud indications in this document."
    }
  },
  "type": "object",
  "required": [
    "id",
    "created_at",
    "end_user_id",
    "document",
    "document_type"
  ],
  "title": "Document for end user",
  "x-tags": [
    "Schemas"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.pinwheelapi.com/EndUserDocumentObjResponse.json"
}