VerificationCreateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/getsmileapi/main/json-schema/getsmileapi-verification-create-request-schema.json",
  "title": "VerificationCreateRequest",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/getsmileapi-smile-api-openapi.yml#/components/schemas/VerificationCreateRequest",
  "type": "object",
  "required": [
    "consent"
  ],
  "properties": {
    "firstName": {
      "type": "string",
      "description": "First Name"
    },
    "middleName": {
      "type": "string",
      "description": "Middle Name"
    },
    "lastName": {
      "type": "string",
      "description": "Last Name"
    },
    "suffix": {
      "type": "string",
      "description": "Suffix"
    },
    "fullName": {
      "type": "string",
      "description": "Full Name"
    },
    "additionalData": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string",
          "description": "Email Address"
        },
        "phone": {
          "type": "string"
        },
        "dob": {
          "allOf": [
            {
              "$ref": "#/$defs/RefDate"
            }
          ]
        },
        "gender": {
          "allOf": [
            {
              "$ref": "#/$defs/RefGender"
            }
          ]
        },
        "address": {
          "type": "string",
          "description": "The address you want to verify"
        },
        "employer": {
          "type": "string",
          "description": "Employer name"
        },
        "employmentStatus": {
          "type": "string",
          "description": "Employment status",
          "enum": [
            "EMPLOYED",
            "UNEMPLOYED",
            "SELF-EMPLOYED",
            "GIG",
            "RETIRED"
          ]
        },
        "ids": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/VerificationId"
          }
        }
      }
    },
    "consent": {
      "$ref": "#/$defs/Consent"
    }
  },
  "$defs": {
    "Consent": {
      "type": "object",
      "required": [
        "consentedAt",
        "consentedWith"
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "The internal name of your consent document (e.g. \"Terms and Conditions\" or \"Privacy Policy\"); your own reference label"
        },
        "version": {
          "type": "string",
          "description": "Your internal version identifier for this consent document (e.g. \"1.0.0\")"
        },
        "consentedAt": {
          "allOf": [
            {
              "$ref": "#/$defs/RefDateTime"
            }
          ],
          "description": "The date and time the subject accepted your consent document, typically when they tapped \"I agree\" in your app. Not the time of this API call. Use ISO 8601 format, e.g. \"2024-04-14T09:30:24Z\""
        },
        "consentedWith": {
          "type": "string",
          "description": "The exact text of the button or checkbox the user clicked to give consent, e.g. \"I agree to the Terms and Conditions\""
        },
        "consentTemplateId": {
          "type": "string",
          "description": "ID of a stored Consent Template. Retrieve from the Developer Portal or GET /consentTemplates. Overrides any inline fields above when provided."
        }
      }
    },
    "RefDate": {
      "type": "string",
      "format": "date",
      "description": "The date, yyyy-MM-dd"
    },
    "RefDateTime": {
      "type": "string",
      "title": "Date and Time string",
      "format": "date-time",
      "description": "Date and time"
    },
    "RefGender": {
      "type": "string",
      "title": "GenderEnum",
      "enum": [
        "Male",
        "Female",
        "Non-binary",
        null
      ],
      "description": "Gender"
    },
    "VerificationId": {
      "type": "object",
      "required": [
        "idType",
        "idNumber"
      ],
      "properties": {
        "idType": {
          "allOf": [
            {
              "$ref": "#/$defs/VerificationIdType"
            }
          ]
        },
        "idSubType": {
          "type": "string",
          "description": "If idType = prclicense_ph, subtype should be one of the PrcProfessionEnum value."
        },
        "idNumber": {
          "type": "string",
          "description": "The ID number"
        }
      }
    },
    "VerificationIdType": {
      "type": "string",
      "enum": [
        "tin_ph",
        "pagibig_ph",
        "prclicense_ph",
        "nbi_ph"
      ]
    }
  }
}