---
title: "List Archives"
method: GET
path: "/archives"
tags: ["Archives"]
---

# List Archives

`GET /archives`

List the user's archives.

## Query parameters

- `size` integer
- `cursor` string
- `userId` string
- `fileType` string — Upload file type. You can get all types from `/fileTypes` api
- `startDate` string, date
- `endDate` string, date

## Response `200`

OK

- ArchiveListResponse
  - `code` 'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED' — Request status code
  - `message` string — Message response to the request
  - `requestId` string — Unique ID that is added to the body of every response for easy traceability of the request in our logs.
  - `data` object
    - `nextCursor` string — The next cursor value that can be used in the following query.
    - `items` Archive[]
      - `id` string, required — Unique ID of this object
      - `createdAt` string, date-time, required — Date and time
      - `providerId` string, required — ID of the data provider, 'user-provided' if files are provided by the user, or 'tenant-provided' if files are provided via API
      - `userId` string, required — User ID associated with this archive
      - `type` string, required — Upload file type. You can get all types from `/fileTypes` api
      - `state` object, required
        - `status` 'STARTED' | 'ANALYZED' | 'UNSUPPORTED' | 'ERROR' | 'REVOKED', required — Archive status
        - `errorCode` 'MISSING_MANDATARY_FIELD' | 'MISSING_MANDATORY_FIELD' | 'INVALID_FIELD_FORMAT' | 'SYSTEM_ERROR' | 'null', nullable — Error code
        - `errorMessage` string, nullable — Error message
        - `updatedAt` string, date-time, required — Date and time
      - `rawFiles` RawFile[], required — Collection of files
        - `id` string, required — Unique ID of this object
        - `createdAt` string, date-time, required — Date and time
        - `name` string, required — File name
        - `subType` string, nullable, required — Type of document uploaded
        - `size` integer, required — File size in kilobytes
        - `format` 'PDF' | 'PNG' | 'JPG' | 'JPEG', required — File type (only JPEG, PNG, PDF, or JPG formats are supported)
        - `url` string, required — URL to access the file. URL will expire after 60 days
      - `classification` ArchiveClassification
        - `fileType` 'PAYSLIP' | 'TAX_DOCUMENT' | 'EMPLOYMENT_CERTIFICATE' | 'BANK_STATEMENT' | 'COMPANY_ID' | 'CLEARANCE_NBI' | 'GOVERNMENT_ID' | 'TELCO_BILL' | 'ELECTRICITY_BILL' | 'WATER_BILL' | 'OTHERS', required
      - `analysis` ArchiveAnalysis
        - `startDate` string, date — Start date of the employee's employment with the company, in YYYY-MM-DD format
        - `endDate` string, date — End date of the employee's employment with the company, if found, in YYYY-MM-DD format
        - `payDate` string, date — The date, yyyy-MM-dd
        - `currency` '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' — Currency in 3 character alpha ISO 4217
        - `grossAmount` number — Gross amount
        - `netAmount` number — Net amount
        - `employerName` string — Name of the company or business employing the individual
        - `employeeName` string — Employee name
        - `ssNumber` string — Employee's Social Security (SS) Number
        - `philHealthNumber` string — Employee's National Health Identification Number
        - `taxNumber` string — Employee's Tax Identification Number
        - `pagIbigNumber` string — Employee's National housing provident fund MID Number
        - `baseAmount` number — Base amount
        - `expireDate` string, date — The date, yyyy-MM-dd
        - `dateOfBirth` string, date — The date, yyyy-MM-dd
        - `firstName` string — First name
        - `lastName` string — Last name
        - `middleName` string — Middle name
        - `nbiIdNumber` string — NBI Clearance Document Number
        - `address` string — Address
        - `maritalStatus` string — Marital status
        - `gender` string — Gender
        - `citizenship` string — Citizenship
        - `remark` string — Remarks included in the document
        - `fullName` string — Name of the employee the CoE is for
        - `accountNumber` string — Account number
        - `statementDate` string, date — Statement date, in YYYY-MM-DD format
        - `statementNumber` string — Statement number
        - `dueDate` string, date — Due date, in YYYY-MM-DD format
        - `paymentDate` string, date — Payment date, in YYYY-MM-DD format
        - `dueAmount` number — Due amount
        - `vatAmount` number — Vat amount
        - `adjustmentAmount` number — Adjustment amount
        - `currentBillAmount` number — Current bill amount
        - `balanceAmount` number — Balance amount
        - `previousDueAmount` number — Previous due amount
        - `emailAddress` string — Email address
        - `phoneNumber` string — Phone number
        - `supplier` string — Supplier name
        - `currentPeriodUsage` number — Current period usage
        - `previousReading` number — Previous period usage
        - `presentReading` number — Present period usage
        - `employeeIdNumber` string — Any ID number of the employee found in the document (optional) - may be employee ID, may be any government ID
        - `employeeIdType` string — Type of ID if found; required if employeeIdNumber is found
        - `position` string — Position of the employee if found
        - `department` string — Department of the employee if found
        - `employmentStatus` string — Employment status of the employee if found
        - `salaryAmount` number — Salary amount
        - `salaryTerm` string — Salary term
        - `purpose` string — Purpose of the certificate of employment
        - `remarks` string — Any additional remarks that may be provided
        - `issueDate` string, date — Date when the certificate of employment was issued, in YYYY-MM-DD format
        - `signatoryName` string — Full name of the signatory
        - `signatoryPosition` string — Position of the signatory
      - `extraction` union
        - ArchivePayslipExtraction
          - `fileType` string, required
          - `analysis` ArchivePayslipAnalysis
            - `startDate` string, date — The date, yyyy-MM-dd
            - `endDate` string, date — The date, yyyy-MM-dd
            - `payDate` string, date — The date, yyyy-MM-dd
            - `currency` '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' — Currency in 3 character alpha ISO 4217
            - `grossAmount` number — Gross amount
            - `netAmount` number — Net amount
            - `employerName` string — Employer name
            - `employeeName` string — Employee name
            - `ssNumber` string — Employee's Social Security (SS) Number
            - `philHealthNumber` string — Employee's National Health Identification Number
            - `taxNumber` string — Employee's Tax Identification Number
            - `pagIbigNumber` string — Employee's National housing provident fund MID Number
        - ArchiveTaxDocumentExtraction
          - `fileType` string, required
          - `analysis` ArchiveTaxDocumentAnalysis
            - `startDate` string, date — The date, yyyy-MM-dd
            - `endDate` string, date — The date, yyyy-MM-dd
            - `grossAmount` number — Gross amount
            - `baseAmount` number — Base amount
            - `employerName` string
            - `employeeName` string — Employee name
            - `taxNumber` string — Employee's Tax Identification Number
        - ArchiveNbiClearanceDocumentExtraction
          - `fileType` string, required
          - `analysis` ArchiveNbiClearanceDocumentAnalysis
            - `expireDate` string, date — The date, yyyy-MM-dd
            - `dateOfBirth` string, date — The date, yyyy-MM-dd
            - `firstName` string — First name
            - `lastName` string — Last name
            - `middleName` string — Middle name
            - `nbiIdNumber` string — NBI Clearance Document Number
            - `address` string — Address
            - `maritalStatus` string — Marital status
            - `gender` string — Gender
            - `citizenship` string — Citizenship
            - `remark` string — Remarks included in the document
        - ArchiveTelcoBillExtraction
          - `fileType` string, required
          - `analysis` ArchiveTelcoBillAnalysis
            - `fullName` string — Full name
            - `firstName` string — First name
            - `lastName` string — Last name
            - `middleName` string — Middle name
            - `accountNumber` string — Account number
            - `address` string — Address
            - `startDate` string, date — Period start date, in YYYY-MM-DD format
            - `endDate` string, date — Period end date, in YYYY-MM-DD format
            - `statementDate` string, date — Statement date, in YYYY-MM-DD format
            - `statementNumber` string — Statement number
            - `dueDate` string, date — Due date, in YYYY-MM-DD format
            - `paymentDate` string, date — Payment date, in YYYY-MM-DD format
            - `dueAmount` number — Due amount
            - `vatAmount` number — Vat amount
            - `adjustmentAmount` number — Adjustment amount
            - `currentBillAmount` number — Current bill amount
            - `balanceAmount` number — Balance amount
            - `previousDueAmount` number — Previous due amount
            - `currency` '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' — Currency in 3 character alpha ISO 4217
            - `emailAddress` string — Email address
            - `phoneNumber` string — Phone number
            - `supplier` string — Supplier name
        - ArchiveElectricityBillExtraction
          - `fileType` string, required
          - `analysis` ArchiveElectricityBillAnalysis
            - `fullName` string — Full name
            - `firstName` string — First name
            - `lastName` string — Last name
            - `middleName` string — Middle name
            - `accountNumber` string — Account number
            - `address` string — Address
            - `startDate` string, date — Period start date, in YYYY-MM-DD format
            - `endDate` string, date — Period end date, in YYYY-MM-DD format
            - `statementDate` string, date — Statement date, in YYYY-MM-DD format
            - `dueDate` string, date — Due date, in YYYY-MM-DD format
            - `paymentDate` string, date — Payment date, in YYYY-MM-DD format
            - `dueAmount` number — Due amount
            - `vatAmount` number — Vat amount
            - `currentBillAmount` number — Current bill amount
            - `balanceAmount` number — Balance amount
            - `previousDueAmount` number — Previous due amount
            - `currency` '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' — Currency in 3 character alpha ISO 4217
            - `emailAddress` string — Email address
            - `phoneNumber` string — Phone number
            - `statementNumber` string — Statement number
            - `currentPeriodUsage` number — Current period usage
            - `previousReading` number — Previous period usage
            - `presentReading` number — Present period usage
            - `supplier` string — Supplier name
        - ArchiveWaterBillExtraction
          - `fileType` string, required
          - `analysis` ArchiveWaterBillAnalysis
            - `fullName` string — Full name
            - `firstName` string — First name
            - `lastName` string — Last name
            - `middleName` string — Middle name
            - `accountNumber` string — Account number
            - `address` string — Address
            - `startDate` string, date — Period start date, in YYYY-MM-DD format
            - `endDate` string, date — Period end date, in YYYY-MM-DD format
            - `statementDate` string, date — Statement date, in YYYY-MM-DD format
            - `dueDate` string, date — Due date, in YYYY-MM-DD format
            - `paymentDate` string, date — Payment date, in YYYY-MM-DD format
            - `dueAmount` number — Due amount
            - `vatAmount` number — Vat amount
            - `currentBillAmount` number — Current bill amount
            - `balanceAmount` number — Balance amount
            - `previousDueAmount` number — Previous due amount
            - `currency` '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' — Currency in 3 character alpha ISO 4217
            - `emailAddress` string — Email address
            - `phoneNumber` string — Phone number
            - `statementNumber` string — Statement number
            - `currentPeriodUsage` number — Current period usage
            - `previousReading` number — Previous period usage
            - `presentReading` number — Present period usage
            - `supplier` string — Supplier name
        - ArchiveEmploymentCertificateExtraction
          - `fileType` string, required
          - `analysis` ArchiveEmploymentCertificateAnalysis
            - `employerName` string — Name of the company or business employing the individual
            - `fullName` string — Name of the employee the CoE is for
            - `firstName` string — First name
            - `middleName` string — Middle name
            - `lastName` string — Last name
            - `employeeIdNumber` string — Any ID number of the employee found in the document (optional) - may be employee ID, may be any government ID
            - `employeeIdType` string — Type of ID if found; required if employeeIdNumber is found
            - `position` string — Position of the employee if found
            - `department` string — Department of the employee if found
            - `employmentStatus` string — Employment status of the employee if found
            - `startDate` string, date — Start date of the employee's employment with the company, in YYYY-MM-DD format
            - `endDate` string, date — End date of the employee's employment with the company, if found, in YYYY-MM-DD format
            - `salaryAmount` number — Salary amount
            - `salaryTerm` string — Salary term
            - `currency` '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' — Currency in 3 character alpha ISO 4217
            - `purpose` string — Purpose of the certificate of employment
            - `remarks` string — Any additional remarks that may be provided
            - `issueDate` string, date — Date when the certificate of employment was issued, in YYYY-MM-DD format
            - `signatoryName` string — Full name of the signatory
            - `signatoryPosition` string — Position of the signatory
      - `validation` ArchiveValidation
        - `fileType` string, required — Archive file type
        - `metadata` ArchiveValidationResult
          - `resultCode` 'PASSED' | 'FAILED' | 'NO_DATA', required
          - `score` number — Validation score. 0-100.
          - `resultMessage` string — Validation result message.
        - `computation` ArchiveValidationResult
          - `resultCode` 'PASSED' | 'FAILED' | 'NO_DATA', required
          - `score` number — Validation score. 0-100.
          - `resultMessage` string — Validation result message.
        - `identity` ArchiveValidationResult
          - `resultCode` 'PASSED' | 'FAILED' | 'NO_DATA', required
          - `score` number — Validation score. 0-100.
          - `resultMessage` string — Validation result message.
        - `location` ArchiveValidationResult
          - `resultCode` 'PASSED' | 'FAILED' | 'NO_DATA', required
          - `score` number — Validation score. 0-100.
          - `resultMessage` string — Validation result message.

## Changes

> 51 revisions in range; 9 could not be searched.

- **2026-07-15** (v1) `3bcbeecafbab` — 10 info
  - removed the non-success response with the status `400`
  - removed the non-success response with the status `401`
  - removed the non-success response with the status `403`
  - removed the non-success response with the status `404`
  - …6 more
- **2026-01-26** (v1) `95906f35876d` — 1 breaking, 1 warning, 2 info
  - added `#/components/schemas/ArchiveEmploymentCertificateExtraction` to the `data/items/items/extraction` response property `oneOf` list for the response status `200`
  - added the new `BANK_STATEMENT` enum value to the `data/items/items/classification/fileType` response property for the response status `200`
  - added `#/components/schemas/ArchiveEmploymentCertificateAnalysis` to the `data/items/items/analysis` response property `allOf` list for the response status `200`
  - added `EMPLOYMENT_CERTIFICATE` discriminator mapping keys to the `data/items/items/extraction` response property for the response status `200`
- **2025-07-21** (v1) `df9e542d163a` — 2 info
  - added the optional property `data/items/items/analysis/allOf[#/components/schemas/ArchiveTelcoBillAnalysis]/statementNumber` to the response with the `200` status
  - added `#/components/schemas/ArchiveElectricityBillAnalysis, #/components/schemas/ArchiveWaterBillAnalysis` to the `data/items/items/analysis` response property `allOf` list for the response status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/smileapi/apis/smile-api/changes/archives/get.md)

---

[API](https://skmtc.dev/smileapi/apis/smile-api.md) · [All operations](https://skmtc.dev/smileapi/apis/smile-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/smileapi/smile-api/revisions/a4930eb49f4d/schema)