Document Get Response

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/getsmileapi/json-schema/getsmileapi-document-get-response-schema.json",
  "title": "Document Get Response",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/getsmileapi-documents-api-openapi.yml#/components/schemas/DocumentGetResponse",
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/$defs/ObjectMetadataRefCode"
    },
    "message": {
      "$ref": "#/$defs/ObjectMetadataRefMessage"
    },
    "requestId": {
      "$ref": "#/$defs/ObjectMetadataRefRequestID"
    },
    "data": {
      "$ref": "#/$defs/Document"
    }
  },
  "$defs": {
    "Document": {
      "title": "Document",
      "type": "object",
      "x-internal": false,
      "description": "The stored document-related information of the user from an employment data provider.",
      "x-tags": [
        "Documents"
      ],
      "allOf": [
        {
          "$ref": "#/$defs/DocumentPayload"
        },
        {
          "properties": {
            "metadata": {
              "$ref": "#/$defs/ObjectReferenceMetadata"
            }
          }
        }
      ],
      "required": [
        "id",
        "name",
        "metadata"
      ]
    },
    "DocumentPayload": {
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "$ref": "#/$defs/RefObjectID"
        },
        "name": {
          "type": "string",
          "description": "Document name"
        },
        "docId": {
          "type": [
            "string",
            "null"
          ],
          "description": "Document number"
        },
        "status": {
          "type": [
            "string",
            "null"
          ],
          "description": "Document status，only for NBI verification, It's VALID if the NBI verification status is valid."
        },
        "documentType": {
          "type": "string",
          "description": "Document Type",
          "enum": [
            "IDENTIFICATION",
            "PAYSLIP",
            "CLEARANCE",
            "CERTIFICATE"
          ]
        },
        "issueDate": {
          "type": [
            "string",
            "null"
          ],
          "description": "Issue date",
          "format": "date"
        },
        "expiryDate": {
          "type": [
            "string",
            "null"
          ],
          "description": "Expiry date",
          "format": "date"
        },
        "fileUrl": {
          "type": [
            "string",
            "null"
          ],
          "description": "Publicly available URL reference for the document"
        },
        "remarks": {
          "type": [
            "string",
            "null"
          ],
          "description": "Remarks section"
        }
      }
    },
    "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
    },
    "ObjectReferenceMetadata": {
      "title": "Reference Metadata",
      "type": "object",
      "description": "Metadata related to account-specific data",
      "properties": {
        "itemCreatedAt": {
          "$ref": "#/$defs/RefDateTime"
        },
        "createdAt": {
          "$ref": "#/$defs/RefDateTime"
        },
        "accountId": {
          "type": "string",
          "deprecated": true,
          "description": "The accountId of this object"
        },
        "sourceId": {
          "type": "string",
          "description": "The ACCOUNT or ARCHIVE ID associated with this object"
        },
        "sourceType": {
          "$ref": "#/$defs/RefSourceType"
        },
        "userId": {
          "type": "string",
          "description": "The user ID associated with this object"
        },
        "providerId": {
          "type": "string",
          "description": "The provider ID associated with this object"
        }
      },
      "required": [
        "createdAt",
        "itemCreatedAt",
        "sourceId",
        "sourceType",
        "userId",
        "providerId"
      ]
    },
    "RefDateTime": {
      "type": "string",
      "title": "Date and Time string",
      "format": "date-time",
      "description": "Date and time"
    },
    "RefObjectID": {
      "type": "string",
      "title": "Object ID",
      "description": "Unique ID of this object"
    },
    "RefSourceType": {
      "type": [
        "string",
        "null"
      ],
      "title": "Ref-Source-Type",
      "enum": [
        "ACCOUNT",
        "UPLOAD",
        "ARCHIVE",
        "SOCIAL_SECURITY"
      ],
      "description": "Source Type"
    }
  }
}