Pinwheel · Schema

object

PayrollDirect DepositIncome VerificationEmploymentTax FormsFintechOpen FinanceBill SwitchingFinancial Data

Properties

Name	Type	Description
social_security_number	string	Full 9-digit social security number of the user (required). Using full SSN will improve conversion.
social_security_number_last_four	string	Last four digits of the user's social security number. Use this field only when the full 9-digit SSN (social_security_number) is not available. Passing the full SSN yields over 20% higher match rate c
date_of_birth	string	The user's date of birth in `YYYY-MM-DD` format (required).
last_name	string	The user's last name (required).
first_name	string	The user's first name (required).
mobile_phone_number	string	The users's 10-digit mobile phone number (required). Do not include country code.
home_address_zip_code	string	The user's 5-digit home zip code (required).
email	string	The user's email (strongly recommended). The email must have valid syntax with an @ and valid domain e.g. `[email protected]`. If provided email is invalid a 400 will be returned. For more details on v

View JSON Schema on GitHub

JSON Schema

{
  "properties": {
    "social_security_number": {
      "type": "string",
      "maxLength": 9,
      "minLength": 9,
      "pattern": "^[0-9]*$",
      "title": "social_security_number",
      "description": "Full 9-digit social security number of the user (required). Using full SSN will improve conversion."
    },
    "social_security_number_last_four": {
      "type": "string",
      "maxLength": 4,
      "minLength": 4,
      "pattern": "^[0-9]*$",
      "title": "social_security_number_last_four",
      "description": "Last four digits of the user's social security number. Use this field only when the full 9-digit SSN (social_security_number) is not available. Passing the full SSN yields over 20% higher match rate compared to using only the last four digits."
    },
    "date_of_birth": {
      "type": "string",
      "format": "date",
      "title": "date_of_birth",
      "description": "The user's date of birth in `YYYY-MM-DD` format (required)."
    },
    "last_name": {
      "type": "string",
      "title": "last_name",
      "description": "The user's last name (required)."
    },
    "first_name": {
      "type": "string",
      "title": "first_name",
      "description": "The user's first name (required)."
    },
    "mobile_phone_number": {
      "type": "string",
      "maxLength": 10,
      "minLength": 10,
      "pattern": "^[0-9]*$",
      "title": "mobile_phone_number",
      "description": "The users's 10-digit mobile phone number (required). Do not include country code."
    },
    "home_address_zip_code": {
      "type": "string",
      "maxLength": 5,
      "minLength": 5,
      "pattern": "^[0-9]*$",
      "title": "home_address_zip_code",
      "description": "The user's 5-digit home zip code (required)."
    },
    "email": {
      "type": "string",
      "format": "email",
      "title": "email",
      "description": "The user's email (strongly recommended). The email must have valid syntax with an @ and valid domain e.g. `[email protected]`. If provided email is invalid a 400 will be returned. For more details on validation see https://github.com/JoshData/python-email-validator."
    }
  },
  "type": "object",
  "title": "object",
  "x-tags": [
    "Schemas"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.pinwheelapi.com/LinkUserAuthenticationDataObjCreate.json"
}