DocSpring · Schema

submission_data_request

PDFDocument GenerationPDF TemplatesE-SignaturesFormsHTML to PDFDocument Automation

Properties

Name	Type	Description
id	string
email	string
name	string
order	integer
sort_order	integer
fields	array
metadata	object
state	string
viewed_at	string
completed_at	string
data	object
auth_type	string
auth_second_factor_type	string
auth_provider	string
auth_session_started_at	string
auth_session_id_hash	string
auth_user_id_hash	string
auth_username_hash	string
auth_phone_number_hash	string
ip_address	string
user_agent	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/docspring/main/json-schema/submission_data_request.json",
  "title": "submission_data_request",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true
    },
    "email": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "order": {
      "type": "integer",
      "nullable": true
    },
    "sort_order": {
      "type": "integer"
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "metadata": {
      "type": "object",
      "nullable": true
    },
    "state": {
      "type": "string",
      "enum": [
        "pending",
        "completed"
      ]
    },
    "viewed_at": {
      "type": "string",
      "nullable": true
    },
    "completed_at": {
      "type": "string",
      "nullable": true
    },
    "data": {
      "type": "object",
      "nullable": true
    },
    "auth_type": {
      "type": "string",
      "enum": [
        "none",
        "password",
        "oauth",
        "email_link",
        "phone_number",
        "ldap",
        "saml"
      ]
    },
    "auth_second_factor_type": {
      "type": "string",
      "enum": [
        "none",
        "phone_number",
        "totp",
        "mobile_push",
        "security_key",
        "fingerprint"
      ]
    },
    "auth_provider": {
      "type": "string",
      "nullable": true
    },
    "auth_session_started_at": {
      "type": "string",
      "nullable": true
    },
    "auth_session_id_hash": {
      "type": "string",
      "nullable": true
    },
    "auth_user_id_hash": {
      "type": "string",
      "nullable": true
    },
    "auth_username_hash": {
      "type": "string",
      "nullable": true
    },
    "auth_phone_number_hash": {
      "type": "string",
      "nullable": true
    },
    "ip_address": {
      "type": "string",
      "nullable": true
    },
    "user_agent": {
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "auth_phone_number_hash",
    "auth_provider",
    "auth_second_factor_type",
    "auth_session_id_hash",
    "auth_session_started_at",
    "auth_type",
    "auth_user_id_hash",
    "auth_username_hash",
    "completed_at",
    "data",
    "email",
    "fields",
    "id",
    "ip_address",
    "metadata",
    "name",
    "order",
    "sort_order",
    "state",
    "user_agent",
    "viewed_at"
  ],
  "additionalProperties": false
}