Smile · Schema

Archive Create Response

Create Archive Response

CompanyEmployment VerificationCredit ScoringKYCFraud PreventionPhilippines

Properties

Name Type Description
code object
message object
requestId object
data object
View JSON Schema on GitHub

JSON Schema

getsmileapi-archive-create-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/getsmileapi/json-schema/getsmileapi-archive-create-response-schema.json",
  "title": "Archive Create Response",
  "description": "Create Archive Response",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/getsmileapi-archives-api-openapi.yml#/components/schemas/ArchiveCreateResponse",
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/$defs/ObjectMetadataRefCode"
    },
    "message": {
      "$ref": "#/$defs/ObjectMetadataRefMessage"
    },
    "requestId": {
      "$ref": "#/$defs/ObjectMetadataRefRequestID"
    },
    "data": {
      "$ref": "#/$defs/Archive"
    }
  },
  "$defs": {
    "Archive": {
      "title": "Archive",
      "type": "object",
      "description": "Collection of files.",
      "x-tags": [
        "Archives"
      ],
      "properties": {
        "id": {
          "$ref": "#/$defs/RefObjectID"
        },
        "createdAt": {
          "$ref": "#/$defs/RefDateTime"
        },
        "providerId": {
          "type": "string",
          "description": "ID of the data provider, 'user-provided' if files are provided by the user, or 'tenant-provided' if files are provided via API"
        },
        "userId": {
          "type": "string",
          "description": "User ID associated with this archive"
        },
        "type": {
          "$ref": "#/$defs/FileTypeId"
        },
        "state": {
          "type": "object",
          "required": [
            "status",
            "updatedAt"
          ],
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "STARTED",
                "ANALYZED",
                "UNSUPPORTED",
                "ERROR",
                "REVOKED"
              ],
              "description": "Archive status"
            },
            "errorCode": {
              "type": [
                "string",
                "null"
              ],
              "description": "Error code",
              "enum": [
                "MISSING_MANDATARY_FIELD",
                "MISSING_MANDATORY_FIELD",
                "INVALID_FIELD_FORMAT",
                "SYSTEM_ERROR",
                null
              ]
            },
            "errorMessage": {
              "type": [
                "string",
                "null"
              ],
              "description": "Error message"
            },
            "updatedAt": {
              "$ref": "#/$defs/RefDateTime"
            }
          }
        },
        "rawFiles": {
          "description": "Collection of files",
          "type": "array",
          "items": {
            "$ref": "#/$defs/RawFile"
          }
        },
        "classification": {
          "$ref": "#/$defs/ArchiveClassification"
        },
        "analysis": {
          "$ref": "#/$defs/ArchiveAnalysis"
        },
        "extraction": {
          "$ref": "#/$defs/ArchiveExtraction"
        },
        "validation": {
          "$ref": "#/$defs/ArchiveValidation"
        }
      },
      "required": [
        "id",
        "createdAt",
        "providerId",
        "userId",
        "type",
        "state",
        "rawFiles"
      ]
    },
    "ArchiveAnalysis": {
      "deprecated": true,
      "allOf": [
        {
          "$ref": "#/$defs/ArchivePayslipAnalysis"
        },
        {
          "$ref": "#/$defs/ArchiveTaxDocumentAnalysis"
        },
        {
          "$ref": "#/$defs/ArchiveNbiClearanceDocumentAnalysis"
        },
        {
          "$ref": "#/$defs/ArchiveTelcoBillAnalysis"
        },
        {
          "$ref": "#/$defs/ArchiveElectricityBillAnalysis"
        },
        {
          "$ref": "#/$defs/ArchiveWaterBillAnalysis"
        },
        {
          "$ref": "#/$defs/ArchiveEmploymentCertificateAnalysis"
        }
      ]
    },
    "ArchiveClassification": {
      "type": "object",
      "required": [
        "fileType"
      ],
      "properties": {
        "fileType": {
          "type": "string",
          "enum": [
            "PAYSLIP",
            "TAX_DOCUMENT",
            "EMPLOYMENT_CERTIFICATE",
            "BANK_STATEMENT",
            "COMPANY_ID",
            "CLEARANCE_NBI",
            "GOVERNMENT_ID",
            "TELCO_BILL",
            "ELECTRICITY_BILL",
            "WATER_BILL",
            "OTHERS"
          ]
        }
      }
    },
    "ArchiveElectricityBillAnalysis": {
      "type": "object",
      "properties": {
        "fullName": {
          "type": "string",
          "description": "Full name"
        },
        "firstName": {
          "type": "string",
          "description": "First name"
        },
        "lastName": {
          "type": "string",
          "description": "Last name"
        },
        "middleName": {
          "type": "string",
          "description": "Middle name"
        },
        "accountNumber": {
          "type": "string",
          "description": "Account number"
        },
        "address": {
          "type": "string",
          "description": "Address"
        },
        "startDate": {
          "type": "string",
          "format": "date",
          "description": "Period start date, in YYYY-MM-DD format"
        },
        "endDate": {
          "type": "string",
          "format": "date",
          "description": "Period end date, in YYYY-MM-DD format"
        },
        "statementDate": {
          "type": "string",
          "format": "date",
          "description": "Statement date, in YYYY-MM-DD format"
        },
        "dueDate": {
          "type": "string",
          "format": "date",
          "description": "Due date, in YYYY-MM-DD format"
        },
        "paymentDate": {
          "type": "string",
          "format": "date",
          "description": "Payment date, in YYYY-MM-DD format"
        },
        "dueAmount": {
          "type": "number",
          "description": "Due amount"
        },
        "vatAmount": {
          "type": "number",
          "description": "Vat amount"
        },
        "currentBillAmount": {
          "type": "number",
          "description": "Current bill amount"
        },
        "balanceAmount": {
          "type": "number",
          "description": "Balance amount"
        },
        "previousDueAmount": {
          "type": "number",
          "description": "Previous due amount"
        },
        "currency": {
          "$ref": "#/$defs/RefCurrency"
        },
        "emailAddress": {
          "type": "string",
          "description": "Email address"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Phone number"
        },
        "statementNumber": {
          "type": "string",
          "description": "Statement number"
        },
        "currentPeriodUsage": {
          "type": "number",
          "description": "Current period usage"
        },
        "previousReading": {
          "type": "number",
          "description": "Previous period usage"
        },
        "presentReading": {
          "type": "number",
          "description": "Present period usage"
        },
        "supplier": {
          "type": "string",
          "description": "Supplier name"
        }
      }
    },
    "ArchiveElectricityBillExtraction": {
      "type": "object",
      "required": [
        "fileType"
      ],
      "properties": {
        "fileType": {
          "type": "string"
        },
        "analysis": {
          "$ref": "#/$defs/ArchiveElectricityBillAnalysis"
        }
      }
    },
    "ArchiveEmploymentCertificateAnalysis": {
      "type": "object",
      "properties": {
        "employerName": {
          "type": "string",
          "description": "Name of the company or business employing the individual"
        },
        "fullName": {
          "type": "string",
          "description": "Name of the employee the CoE is for"
        },
        "firstName": {
          "type": "string",
          "description": "First name"
        },
        "middleName": {
          "type": "string",
          "description": "Middle name"
        },
        "lastName": {
          "type": "string",
          "description": "Last name"
        },
        "employeeIdNumber": {
          "type": "string",
          "description": "Any ID number of the employee found in the document (optional) - may be employee ID, may be any government ID"
        },
        "employeeIdType": {
          "type": "string",
          "description": "Type of ID if found; required if employeeIdNumber is found"
        },
        "position": {
          "type": "string",
          "description": "Position of the employee if found"
        },
        "department": {
          "type": "string",
          "description": "Department of the employee if found"
        },
        "employmentStatus": {
          "type": "string",
          "description": "Employment status of the employee if found"
        },
        "startDate": {
          "type": "string",
          "format": "date",
          "description": "Start date of the employee's employment with the company, in YYYY-MM-DD format"
        },
        "endDate": {
          "type": "string",
          "format": "date",
          "description": "End date of the employee's employment with the company, if found, in YYYY-MM-DD format"
        },
        "salaryAmount": {
          "type": "number",
          "description": "Salary amount"
        },
        "salaryTerm": {
          "type": "string",
          "description": "Salary term"
        },
        "currency": {
          "$ref": "#/$defs/RefCurrency",
          "description": "ISO 4217 currency code"
        },
        "purpose": {
          "type": "string",
          "description": "Purpose of the certificate of employment"
        },
        "remarks": {
          "type": "string",
          "description": "Any additional remarks that may be provided"
        },
        "issueDate": {
          "type": "string",
          "format": "date",
          "description": "Date when the certificate of employment was issued, in YYYY-MM-DD format"
        },
        "signatoryName": {
          "type": "string",
          "description": "Full name of the signatory"
        },
        "signatoryPosition": {
          "type": "string",
          "description": "Position of the signatory"
        }
      }
    },
    "ArchiveEmploymentCertificateExtraction": {
      "type": "object",
      "required": [
        "fileType"
      ],
      "properties": {
        "fileType": {
          "type": "string"
        },
        "analysis": {
          "$ref": "#/$defs/ArchiveEmploymentCertificateAnalysis"
        }
      }
    },
    "ArchiveExtraction": {
      "oneOf": [
        {
          "$ref": "#/$defs/ArchivePayslipExtraction"
        },
        {
          "$ref": "#/$defs/ArchiveTaxDocumentExtraction"
        },
        {
          "$ref": "#/$defs/ArchiveNbiClearanceDocumentExtraction"
        },
        {
          "$ref": "#/$defs/ArchiveTelcoBillExtraction"
        },
        {
          "$ref": "#/$defs/ArchiveElectricityBillExtraction"
        },
        {
          "$ref": "#/$defs/ArchiveWaterBillExtraction"
        },
        {
          "$ref": "#/$defs/ArchiveEmploymentCertificateExtraction"
        }
      ]
    },
    "ArchiveNbiClearanceDocumentAnalysis": {
      "title": "NBI clearance Document Analysis",
      "type": "object",
      "properties": {
        "expireDate": {
          "$ref": "#/$defs/RefDate"
        },
        "dateOfBirth": {
          "$ref": "#/$defs/RefDate"
        },
        "firstName": {
          "type": "string",
          "description": "First name"
        },
        "lastName": {
          "type": "string",
          "description": "Last name"
        },
        "middleName": {
          "type": "string",
          "description": "Middle name"
        },
        "nbiIdNumber": {
          "type": "string",
          "description": "NBI Clearance Document Number"
        },
        "address": {
          "type": "string",
          "description": "Address"
        },
        "maritalStatus": {
          "$ref": "#/$defs/RefMaritalStatus"
        },
        "gender": {
          "$ref": "#/$defs/RefGender"
        },
        "citizenship": {
          "type": "string",
          "description": "Citizenship"
        },
        "remark": {
          "type": "string",
          "description": "Remarks included in the document"
        }
      }
    },
    "ArchiveNbiClearanceDocumentExtraction": {
      "type": "object",
      "required": [
        "fileType"
      ],
      "properties": {
        "fileType": {
          "type": "string"
        },
        "analysis": {
          "$ref": "#/$defs/ArchiveNbiClearanceDocumentAnalysis"
        }
      }
    },
    "ArchivePayslipAnalysis": {
      "title": "Payslip Analysis",
      "type": "object",
      "properties": {
        "startDate": {
          "$ref": "#/$defs/RefDate"
        },
        "endDate": {
          "$ref": "#/$defs/RefDate"
        },
        "payDate": {
          "$ref": "#/$defs/RefDate"
        },
        "currency": {
          "$ref": "#/$defs/RefCurrency"
        },
        "grossAmount": {
          "type": "number",
          "description": "Gross amount"
        },
        "netAmount": {
          "type": "number",
          "description": "Net amount"
        },
        "employerName": {
          "type": "string",
          "description": "Employer name"
        },
        "employeeName": {
          "type": "string",
          "description": "Employee name"
        },
        "ssNumber": {
          "type": "string",
          "description": "Employee's Social Security (SS) Number"
        },
        "philHealthNumber": {
          "type": "string",
          "description": "Employee's National Health Identification Number"
        },
        "taxNumber": {
          "type": "string",
          "description": "Employee's Tax Identification Number"
        },
        "pagIbigNumber": {
          "type": "string",
          "description": "Employee's National housing provident fund MID Number"
        }
      }
    },
    "ArchivePayslipExtraction": {
      "type": "object",
      "required": [
        "fileType"
      ],
      "properties": {
        "fileType": {
          "type": "string"
        },
        "analysis": {
          "$ref": "#/$defs/ArchivePayslipAnalysis"
        }
      }
    },
    "ArchiveTaxDocumentAnalysis": {
      "title": "Tax Document Analysis",
      "type": "object",
      "properties": {
        "startDate": {
          "$ref": "#/$defs/RefDate"
        },
        "endDate": {
          "$ref": "#/$defs/RefDate"
        },
        "grossAmount": {
          "type": "number",
          "description": "Gross amount"
        },
        "baseAmount": {
          "type": "number",
          "description": "Base amount"
        },
        "employerName": {
          "type": "string"
        },
        "employeeName": {
          "type": "string",
          "description": "Employee name"
        },
        "taxNumber": {
          "type": "string",
          "description": "Employee's Tax Identification Number"
        }
      }
    },
    "ArchiveTaxDocumentExtraction": {
      "type": "object",
      "required": [
        "fileType"
      ],
      "properties": {
        "fileType": {
          "type": "string"
        },
        "analysis": {
          "$ref": "#/$defs/ArchiveTaxDocumentAnalysis"
        }
      }
    },
    "ArchiveTelcoBillAnalysis": {
      "type": "object",
      "properties": {
        "fullName": {
          "type": "string",
          "description": "Full name"
        },
        "firstName": {
          "type": "string",
          "description": "First name"
        },
        "lastName": {
          "type": "string",
          "description": "Last name"
        },
        "middleName": {
          "type": "string",
          "description": "Middle name"
        },
        "accountNumber": {
          "type": "string",
          "description": "Account number"
        },
        "address": {
          "type": "string",
          "description": "Address"
        },
        "startDate": {
          "type": "string",
          "format": "date",
          "description": "Period start date, in YYYY-MM-DD format"
        },
        "endDate": {
          "type": "string",
          "format": "date",
          "description": "Period end date, in YYYY-MM-DD format"
        },
        "statementDate": {
          "type": "string",
          "format": "date",
          "description": "Statement date, in YYYY-MM-DD format"
        },
        "statementNumber": {
          "type": "string",
          "description": "Statement number"
        },
        "dueDate": {
          "type": "string",
          "format": "date",
          "description": "Due date, in YYYY-MM-DD format"
        },
        "paymentDate": {
          "type": "string",
          "format": "date",
          "description": "Payment date, in YYYY-MM-DD format"
        },
        "dueAmount": {
          "type": "number",
          "description": "Due amount"
        },
        "vatAmount": {
          "type": "number",
          "description": "Vat amount"
        },
        "adjustmentAmount": {
          "type": "number",
          "description": "Adjustment amount"
        },
        "currentBillAmount": {
          "type": "number",
          "description": "Current bill amount"
        },
        "balanceAmount": {
          "type": "number",
          "description": "Balance amount"
        },
        "previousDueAmount": {
          "type": "number",
          "description": "Previous due amount"
        },
        "currency": {
          "$ref": "#/$defs/RefCurrency"
        },
        "emailAddress": {
          "type": "string",
          "description": "Email address"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Phone number"
        },
        "supplier": {
          "type": "string",
          "description": "Supplier name"
        }
      }
    },
    "ArchiveTelcoBillExtraction": {
      "type": "object",
      "required": [
        "fileType"
      ],
      "properties": {
        "fileType": {
          "type": "string"
        },
        "analysis": {
          "$ref": "#/$defs/ArchiveTelcoBillAnalysis"
        }
      }
    },
    "ArchiveValidation": {
      "type": "object",
      "required": [
        "fileType"
      ],
      "properties": {
        "fileType": {
          "type": "string",
          "description": "Archive file type"
        },
        "metadata": {
          "$ref": "#/$defs/ArchiveValidationResult"
        },
        "computation": {
          "$ref": "#/$defs/ArchiveValidationResult"
        },
        "identity": {
          "$ref": "#/$defs/ArchiveValidationResult"
        },
        "location": {
          "$ref": "#/$defs/ArchiveValidationResult"
        }
      }
    },
    "ArchiveValidationResult": {
      "type": "object",
      "required": [
        "resultCode"
      ],
      "properties": {
        "resultCode": {
          "type": "string",
          "enum": [
            "PASSED",
            "FAILED",
            "NO_DATA"
          ]
        },
        "score": {
          "type": "number",
          "description": "Validation score. 0-100."
        },
        "resultMessage": {
          "type": "string",
          "description": "Validation result message."
        }
      }
    },
    "ArchiveWaterBillAnalysis": {
      "type": "object",
      "properties": {
        "fullName": {
          "type": "string",
          "description": "Full name"
        },
        "firstName": {
          "type": "string",
          "description": "First name"
        },
        "lastName": {
          "type": "string",
          "description": "Last name"
        },
        "middleName": {
          "type": "string",
          "description": "Middle name"
        },
        "accountNumber": {
          "type": "string",
          "description": "Account number"
        },
        "address": {
          "type": "string",
          "description": "Address"
        },
        "startDate": {
          "type": "string",
          "format": "date",
          "description": "Period start date, in YYYY-MM-DD format"
        },
        "endDate": {
          "type": "string",
          "format": "date",
          "description": "Period end date, in YYYY-MM-DD format"
        },
        "statementDate": {
          "type": "string",
          "format": "date",
          "description": "Statement date, in YYYY-MM-DD format"
        },
        "dueDate": {
          "type": "string",
          "format": "date",
          "description": "Due date, in YYYY-MM-DD format"
        },
        "paymentDate": {
          "type": "string",
          "format": "date",
          "description": "Payment date, in YYYY-MM-DD format"
        },
        "dueAmount": {
          "type": "number",
          "description": "Due amount"
        },
        "vatAmount": {
          "type": "number",
          "description": "Vat amount"
        },
        "currentBillAmount": {
          "type": "number",
          "description": "Current bill amount"
        },
        "balanceAmount": {
          "type": "number",
          "description": "Balance amount"
        },
        "previousDueAmount": {
          "type": "number",
          "description": "Previous due amount"
        },
        "currency": {
          "$ref": "#/$defs/RefCurrency"
        },
        "emailAddress": {
          "type": "string",
          "description": "Email address"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Phone number"
        },
        "statementNumber": {
          "type": "string",
          "description": "Statement number"
        },
        "currentPeriodUsage": {
          "type": "number",
          "description": "Current period usage"
        },
        "previousReading": {
          "type": "number",
          "description": "Previous period usage"
        },
        "presentReading": {
          "type": "number",
          "description": "Present period usage"
        },
        "supplier": {
          "type": "string",
          "description": "Supplier name"
        }
      }
    },
    "ArchiveWaterBillExtraction": {
      "type": "object",
      "required": [
        "fileType"
      ],
      "properties": {
        "fileType": {
          "type": "string"
        },
        "analysis": {
          "$ref": "#/$defs/ArchiveWaterBillAnalysis"
        }
      }
    },
    "FileTypeId": {
      "title": "FileTypeId",
      "type": "string",
      "description": "Upload file type. You can get all types from `/fileTypes` api"
    },
    "ObjectMetadataRefCode": {
      "type": "string",
      "title": "ObjectMetadataRefCode",
      "description": "Request status code",
      "enum": [
        "OK",
        "CREATED",
        "INVALID_CREDENTIALS",
        "INVALID_PARAMETERS",
        "INVALID_TOKEN",
        "UNAUTHORIZED_ACCESS",
        "MISSING_RESOURCE",
        "REQUEST_LIMIT_EXCEEDED",
        "SERVER_ERROR",
        "UNSUPPORTED_METHOD",
        "SERVER_UNAVAILABLE",
        "TIME_LIMIT_EXCEEDED"
      ],
      "x-internal": false
    },
    "ObjectMetadataRefMessage": {
      "type": "string",
      "title": "ObjectMetadataRefMessage",
      "description": "Message response to the request",
      "x-internal": false
    },
    "ObjectMetadataRefRequestID": {
      "type": "string",
      "title": "ObjectMetadataRefRequestID",
      "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.",
      "x-internal": false
    },
    "RawFile": {
      "title": "RawFile",
      "type": "object",
      "description": "Scanned or photographed document or form uploaded by the user to share hard copy employment and income information. File size limit is 15 MB.",
      "x-internal": false,
      "x-tags": [
        "Uploads"
      ],
      "properties": {
        "id": {
          "$ref": "#/$defs/RefObjectID"
        },
        "createdAt": {
          "$ref": "#/$defs/RefDateTime"
        },
        "name": {
          "type": "string",
          "description": "File name"
        },
        "subType": {
          "type": [
            "string",
            "null"
          ],
          "description": "Type of document uploaded"
        },
        "size": {
          "type": "integer",
          "description": "File size in kilobytes"
        },
        "format": {
          "type": "string",
          "enum": [
            "PDF",
            "PNG",
            "JPG",
            "JPEG"
          ],
          "description": "File type (only JPEG, PNG, PDF, or JPG formats are supported)"
        },
        "url": {
          "type": "string",
          "description": "URL to access the file. URL will expire after 60 days"
        }
      },
      "required": [
        "id",
        "createdAt",
        "name",
        "subType",
        "size",
        "format",
        "url"
      ]
    },
    "RefCurrency": {
      "type": "string",
      "title": "Currency ISO Codes",
      "description": "Currency in 3 character alpha ISO 4217",
      "enum": [
        "AFN",
        "DZD",
        "ARS",
        "AMD",
        "AWG",
        "AUD",
        "AZN",
        "BSD",
        "BHD",
        "THB",
        "PAB",
        "BBD",
        "BYN",
        "BZD",
        "BMD",
        "VES",
        "BOB",
        "BRL",
        "BND",
        "BGN",
        "BIF",
        "CAD",
        "CVE",
        "KYD",
        "GHS",
        "XOF",
        "XAF",
        "XPF",
        "CLP",
        "COP",
        "KMF",
        "CDF",
        "BAM",
        "NIO",
        "CRC",
        "HRK",
        "CZK",
        "GMD",
        "DKK",
        "MKD",
        "DJF",
        "STD",
        "DOP",
        "VND",
        "XCD",
        "EGP",
        "SVC",
        "ETB",
        "EUR",
        "FKP",
        "FJD",
        "HUF",
        "GIP",
        "HTG",
        "PYG",
        "GNF",
        "GYD",
        "HKD",
        "UAH",
        "ISK",
        "INR",
        "IRR",
        "IQD",
        "JMD",
        "JOD",
        "KES",
        "PGK",
        "LAK",
        "EEK",
        "KWD",
        "MWK",
        "AOA",
        "MMK",
        "GEL",
        "LVL",
        "LBP",
        "ALL",
        "HNL",
        "SLL",
        "LRD",
        "LYD",
        "SZL",
        "LTL",
        "LSL",
        "MGA",
        "MYR",
        "TMT",
        "MUR",
        "MZN",
        "MXN",
        "MDL",
        "MAD",
        "NGN",
        "ERN",
        "NAD",
        "NPR",
        "ANG",
        "ILS",
        "RON",
        "TWD",
        "NZD",
        "BTN",
        "KPW",
        "NOK",
        "PEN",
        "MRO",
        "TOP",
        "PKR",
        "MOP",
        "UYU",
        "PHP",
        "GBP",
        "BWP",
        "QAR",
        "GTQ",
        "ZAR",
        "OMR",
        "KHR",
        "MVR",
        "IDR",
        "RUB",
        "RWF",
        "SHP",
        "SAR",
        "RSD",
        "SCR",
        "SGD",
        "SBD",
        "KGS",
        "SOS",
        "TJS",
        "LKR",
        "SDG",
        "SRD",
        "SEK",
        "CHF",
        "SYP",
        "BDT",
        "WST",
        "TZS",
        "KZT",
        "TTD",
        "MNT",
        "TND",
        "TRY",
        "AED",
        "UGX",
        "CLF",
        "USD",
        "UZS",
        "VUV",
        "KRW",
        "YER",
        "JPY",
        "CNY",
        "ZMW",
        "ZWL",
        "PLN"
      ]
    },
    "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"
    },
    "RefMaritalStatus": {
      "type": "string",
      "title": "RefMaritalStatus",
      "enum": [
        "Divorced",
        "Married",
        "Separated",
        "Single",
        "Widowed",
        "Lifetime Partner",
        null
      ],
      "description": "Marital status"
    },
    "RefObjectID": {
      "type": "string",
      "title": "Object ID",
      "description": "Unique ID of this object"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/getsmileapi-archive-create-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.