---
title: "View Account Payload"
method: GET
path: "/accounts/{id}/payload"
tags: ["Accounts"]
---

# View Account Payload

`GET /accounts/{id}/payload`

View a user's particular account payload.

## Response `200`

OK

- AccountPayloadGetResponse
  - `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` AccountPayload
    - `metadata` ObjectReferenceMetadata2, required — Metadata related to account-payload data
      - `sourceId` string, required — The ACCOUNT or ARCHIVE ID associated with this object
      - `sourceType` 'ACCOUNT' | 'UPLOAD' | 'ARCHIVE' | 'SOCIAL_SECURITY', nullable, required — Source Type
      - `userId` string, required — The user ID associated with this object
      - `providerId` string, required — The provider ID associated with this object
    - `identity` IdentityPayload
      - `id` string, required — Unique ID of this object
      - `fullName` string, required — Full name
      - `firstName` string, nullable — First name
      - `middleName` string, nullable — Middle name
      - `lastName` string, nullable — Last name
      - `suffix` string, nullable — Suffix
      - `gender` string — Gender
      - `dob` string, date, nullable — Date of birth
      - `maritalStatus` string — Marital status
      - `countryResidence` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RS' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'CS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'XT' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'null', nullable — 2 character alpha ISO-3166 codes
      - `citizenship` 'Citizen' | 'Resident Alien' | 'Non-resident Alien' | 'Undocumented' | 'Others', nullable — Citizenship
      - `photoUrl` string, nullable — URL to photo or avatar
      - `referenceId` string, nullable — Reference profile ID from the data provider
      - `profileUrl` string, nullable — Public profile URL
      - `latestEmployerName` string — The lastest employer name at now, it will be removed in the future.
      - `emails` object[], required — A collection of email addresses
        - `address` string, email, nullable, required — Email address
        - `type` 'Primary' | 'Secondary' | 'Work' | 'Personal' | 'null', nullable, required — Primary contact, with secondary marked as either 'Work' or 'Personal'
      - `phones` object[], required — A collection of phone numbers
        - `number` string, nullable, required — Phone numbers in international E.164 format
        - `type` 'Mobile' | 'Fixed' | 'Unspecified' | 'null', nullable, required — Phone type
      - `socialProfiles` object[], required — A collection of social media URLs
        - `socialUrl` string, nullable, required — URL to social media page
        - `type` 'Twitter' | 'Facebook' | 'LinkedIn' | 'Others', nullable, required — Social media type
      - `addresses` RefAddress[], required
        - `fullAddress` string, nullable — Full address
        - `line1` string, nullable — Line 1 of street address
        - `line2` string, nullable — Line 2 of street address
        - `city` string, nullable — City
        - `region` string, nullable — Geographic region such as state or province
        - `zip` string, nullable — Post code
        - `country` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RS' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'CS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'XT' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'null', nullable — 2 character alpha ISO-3166 codes
        - `latitude` string, nullable — Latitude coordinates
        - `longitude` string, nullable — Longitude coordinates
        - `type` 'Primary' | 'Secondary' | 'null', nullable, required — Whether address is primary or secondary
        - `tags` string[] — Address tags, such as primary or secondary, home or work, etc.
    - `rating` RatingPayload
      - `id` string, required — Unique ID of this object
      - `currentRating` number, nullable — Current rating
      - `maxRating` number, nullable — Maximum possible rating
      - `calculatedPercentage` number, nullable — Current rating expressed as percentage, calculated by currentRating/maxRating x 100
      - `reviewsReceived` number, nullable — Number of reviews the employee received, which is the basis for the current rating
      - `likesReceived` number, nullable — Recommendations or kudos received
      - `jobsCompleted` number, nullable — Jobs actually completed in the employment platform
    - `documents` DocumentPayload[]
      - `id` string, required — Unique ID of this object
      - `name` string, required — Document name
      - `docId` string, nullable — Document number
      - `status` string, nullable — Document status，only for NBI verification, It's VALID if the NBI verification status is valid.
      - `documentType` 'IDENTIFICATION' | 'PAYSLIP' | 'CLEARANCE' | 'CERTIFICATE' — Document Type
      - `issueDate` string, date, nullable — Issue date
      - `expiryDate` string, date, nullable — Expiry date
      - `fileUrl` string, nullable — Publicly available URL reference for the document
      - `remarks` string, nullable — Remarks section
    - `incomes` IncomePayload[]
      - `id` string, required — Unique ID of this object
      - `workItem` string, nullable — Work performed (specially in the case of contract or freelance jobs)
      - `employer` string, nullable — Employer name
      - `startDate` string, date, required — Start date
      - `endDate` string, date, nullable — End date
      - `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', required — Currency in 3 character alpha ISO 4217
      - `frequency` 'Hourly' | 'Daily' | 'Weekly' | 'Semimonthly' | 'Monthly' | 'Bimonthly' | 'Quarterly' | 'Annually' | 'Variable' | 'Unspecified' | 'null', nullable — Pay period
      - `baseAmount` number, nullable — Base amount
      - `grossAmount` number, nullable — Gross amount
      - `netAmount` number, nullable — Net amount
    - `transactions` TransactionPayload[]
      - `id` string, required — Unique ID of this object
      - `date` string, date, required — Date of transaction
      - `description` string, nullable — Description of the transaction
      - `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', required — Currency in 3 character alpha ISO 4217
      - `amount` number, required — Transaction amount
      - `referenceId` string, nullable — Reference transaction ID from data provider
    - `employments` EmploymentPayload[]
      - `id` string, required — Unique ID of this object
      - `name` string, nullable — Work performed
      - `description` string, nullable — Description of work performed
      - `jobTitle` string, nullable — Job title
      - `department` string, nullable — Department or organization in place of employment
      - `employeeNumber` string, nullable — Employee number in the employment data provider
      - `employerNumber` string, nullable — Employer number in the employment data provider
      - `employer` string, nullable — Employer name
      - `status` string, nullable — Status of employment
      - `startDate` string, date, required — Start date
      - `endDate` string, date, nullable — End date
      - `reportedDate` string, date, nullable — Reported date
    - `contributions` ContributionPayload[]
      - `id` string, required — Unique ID of this object
      - `date` string, date, required — Date of the contribution
      - `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', required — Currency in 3 character alpha ISO 4217
      - `amount` number, required — Amount of the contribution
      - `referenceId` string — Reference contribution ID from the data provider
    - `liabilities` LiabilityPayload[]
      - `id` string, required — Unique ID of this object
      - `type` string, required — the loan type
      - `referenceId` string — the loan referenceId
      - `startDate` string, date, required — the loan start date
      - `endDate` string, date — the loan end date
      - `firstAmortizationDate` string, date — the loan first amortization date
      - `amortizationFrequency` 'Hourly' | 'Daily' | 'Weekly' | 'Semimonthly' | 'Monthly' | 'Bimonthly' | 'Quarterly' | 'Annually' | 'Variable' | 'Unspecified' | 'null', nullable, required — Pay period
      - `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', required — Currency in 3 character alpha ISO 4217
      - `loanAmount` number, required — loan amount
      - `amortizationAmount` number — loan amortization amount
      - `outstandingBalance` number — loan outstanding balance
      - `nextPaymentAmount` number — loan next payment amount
      - `overduePaymentAmount` number — loan total overdue amount
    - `eincomes` EincomePayload[]
      - `id` string, required — Unique ID of this object
      - `month` string, required — the month
      - `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', required — Currency in 3 character alpha ISO 4217
      - `baseAmount` number, nullable, required — income amount, has been renamed to amount, baseAmount will be removed in the future
      - `amount` number, nullable, required — income amount
    - `links` LinkPayload[]
      - `id` string, required — Link request ID
      - `startDate` string, date-time — Date and time
      - `endDate` string, date-time, required — Date and time
      - `records` object[] — Link records
        - `count` integer, required — The number of times the user has linked at least one account with other participating organizations
        - `linkedAt` RefDateTime[] — The latest link time of each application
    - `insight` InsightPayload
      - `id` string, required
      - `cutoffTime` string, date-time, required — Date and time
      - `features` ObjectFeature, required
        - `incomes_count` integer — The quantity of the estimated incomes
        - `incomes_first_income_month_range` integer — Calculate the interval from the first income record time to the current time by month
        - `incomes_missing_month_max` integer — From all estimated incomes, calculate the number of months between the last payment month and the next payment month, and then take the maximum value
        - `incomes_missing_month_count` integer — From all estimated incomes, calculate the months diff between current income month and the before income month, and count if the diff > 1
        - `incomes_amount_sum` number — From all estimated incomes, calculate the total of the amount
        - `incomes_amount_average` number — From all estimated incomes, calculate the average amount of the total amount
        - `incomes_amount_min` number — From all estimated incomes, get the minimum amount
        - `incomes_amount_max` number — From all estimated incomes, get the maximum amount
        - `incomes_amount_median` number — From all estimated incomes, get the median amount
        - `incomes_amount_std` number — From all estimated incomes, get the median amount
        - `incomes_last3_months_amount_sum` number — From all estimated incomes in last 3 months, calculate the total of the amount
        - `incomes_last3_months_amount_average` number — From all estimated incomes in last 3 months, calculate the average amount of the total amount
        - `incomes_last3_months_amount_min` number — From all estimated incomes in last 3 months, get the minimum amount
        - `incomes_last3_months_amount_max` number — From all estimated incomes in last 3 months, get the maximum amount
        - `incomes_last3_months_amount_median` number — From all estimated incomes in last 3 months, get the median amount
        - `incomes_last3_months_amount_std` number — From all estimated incomes in last 3 months, get the standard deviation of the amount
        - `incomes_last6_months_amount_sum` number — From all estimated incomes in last 6 months, calculate the total of the amount
        - `incomes_last6_months_amount_average` number — From all estimated incomes in last 6 months, calculate the average amount of the total amount
        - `incomes_last6_months_amount_min` number — From all estimated incomes in last 6 months, get the minimum amount
        - `incomes_last6_months_amount_max` number — From all estimated incomes in last 6 months, get the maximum amount
        - `incomes_last6_months_amount_median` number — From all estimated incomes in last 6 months, get the median amount
        - `incomes_last6_months_amount_std` number — From all estimated incomes in last 6 months, get the standard deviation of the amount
        - `incomes_last9_months_amount_sum` number — From all estimated incomes in last 9 months, calculate the total of the amount
        - `incomes_last9_months_amount_average` number — From all estimated incomes in last 9 months, calculate the average amount of the total amount
        - `incomes_last9_months_amount_min` number — From all estimated incomes in last 9 months, get the minimum amount
        - `incomes_last9_months_amount_max` number — From all estimated incomes in last 9 months, get the maximum amount
        - `incomes_last9_months_amount_median` number — From all estimated incomes in last 9 months, get the median amount
        - `incomes_last9_months_amount_std` number — From all estimated incomes in last 9 months, get the standard deviation of the amount
        - `incomes_last12_months_amount_sum` number — From all estimated incomes in last 12 months, calculate the total of the amount
        - `incomes_last12_months_amount_average` number — From all estimated incomes in last 12 months, calculate the average amount of the total amount
        - `incomes_last12_months_amount_min` number — From all estimated incomes in last 12 months, get the minimum amount
        - `incomes_last12_months_amount_max` number — From all estimated incomes in last 12 months, get the maximum amount
        - `incomes_last12_months_amount_median` number — From all estimated incomes in last 12 months, get the median amount
        - `incomes_last12_months_amount_std` number — From all estimated incomes in last 12 months, get the standard deviation of the amount
        - `incomes_last18_months_amount_sum` number — From all estimated incomes in last 18 months, calculate the total of the amount
        - `incomes_last18_months_amount_average` number — From all estimated incomes in last 18 months, calculate the average amount of the total amount
        - `incomes_last18_months_amount_min` number — From all estimated incomes in last 18 months, get the minimum amount
        - `incomes_last18_months_amount_max` number — From all estimated incomes in last 18 months, get the maximum amount
        - `incomes_last18_months_amount_median` number — From all estimated incomes in last 18 months, get the median amount
        - `incomes_last18_months_amount_std` number — From all estimated incomes in last 18 months, get the standard deviation of the amount
        - `incomes_last18_months_max_amount_count` number — From all estimated incomes in last 18 months, find the maximum amount, and count the number of monthly income equal to the maximum amount
        - `incomes_starting_amount` number — the estimated income from when the user has started earning income
        - `incomes_current_amount` number — the amount from the latetest one record
        - `incomes_latest_growth` number — For the latetest one record, calculate the growth of income from the same month last year
        - `liabilities_loan_count` integer — For the latetest one record, calculate the count of records
        - `liabilities_loan_amount_min` number — From all liabilities, calculate the minimum of the amount
        - `liabilities_loan_amount_max` number — From all liabilities, calculate the maximum of the amount
        - `liabilities_loan_amount_total` number — From all liabilities, calculate the total of the amount
        - `liabilities_loan_amount_average` number — From all liabilities, calculate the average of the amount
        - `liabilities_loan_amount_std` number — From all liabilities, calculate the standard deviation of the amount
        - `liabilities_finished_loan_count` number — From all liabilities that outstandingBalance <= 0, calculate the count of the records
        - `liabilities_outstanding_loan_count` integer — From all liabilities that outstandingBalance > 0, calculate the count of the records
        - `liabilities_outstanding_amount_max` number — From all liabilities that outstandingBalance > 0, calculate the count of the records
        - `liabilities_outstanding_amount_total` number — From all liabilities that outstandingBalance > 0, calculate the total of the amount
        - `liabilities_outstanding_amount_average` number — From all liabilities that outstandingBalance > 0, calculate the average of the amount
        - `liabilities_overdue_loan_count` integer — From all liabilities that overduePaymentAmount > 0, calculate the count of the records
        - `liabilities_overdue_amount_total` number — From all liabilities that overduePaymentAmount > 0, calculate the total of the amount
        - `liabilities_overdue_amount_average` number — From all liabilities that overduePaymentAmount > 0, calculate the average of the amount
        - `liabilities_ongoing_amortization_amount_sum` number — Sum of all amortization amounts for ongoing/current liabilities (not yet fully paid off)
        - `liabilities_ongoing_amortization_amount_min` number — Smallest of all amortization amounts for ongoing/current liabilities (not yet fully paid off)
        - `liabilities_ongoing_amortization_amount_max` number — Largest of all amortization amounts for ongoing/current liabilities (not yet fully paid off)
        - `liabilities_ongoing_amortization_amount_average` number — Average of all amortization amounts for ongoing/current liabilities (not yet fully paid off)
        - `liabilities_ongoing_amortization_amount_median` number — Median of all amortization amounts for ongoing/current liabilities (not yet fully paid off)
        - `liabilities_ongoing_amortization_amount_std` number — Standard deviation of all amortization amounts for ongoing/current liabilities (not yet fully paid off)
        - `liabilities_payment_count` number — Quantity of liability payments made (across all liability records)
        - `liabilities_payment_amount_max` number — Largest amount of payments made for liabilities (across all liability records).
        - `liabilities_payment_amount_min` number — Smallest amount of payments made for liabilities (across all liability records).
        - `liabilities_payment_amount_median` number — Median amount of payments made for liabilities (across all liability records).
        - `liabilities_payment_amount_average` number — Average amount of payments made for liabilities (across all liability records).
        - `liabilities_payment_amount_sum` number — Total amount of payments made for liabilities (across all liability records).
        - `liabilities_payment_amount_std` number — Standard deviation of payments made for liabilities (across all liability records).
        - `employments_current_status` string — The user's current employment status, may be one of: EMPLOYED, GIG (for gig economy workers), or UNEMPLOYED
        - `employments_employer_count` integer — Quantity of unique employers
        - `employments_current_tenure` integer — Quantity of months at current employer
        - `identity_age` integer — Age of the user based on date of birth
        - `link_days_since_first` integer — Number of days since the first account connection, if MAW is enabled.
        - `link_days_since_last` integer — Number of days since the last account connection, if MAW is enabled.
        - `link_day3_count` integer — Number of tenants this account has connected to in the last 3 days, if MAW is enabled.
        - `link_day7_count` integer — Number of tenants this account has connected to in the last 7 days, if MAW is enabled.
        - `link_day30_count` integer — Number of tenants this account has connected to in the last 30 days, if MAW is enabled.
        - `link_day90_count` integer — Number of tenants this account has connected to in the last 90 days, if MAW is enabled.
        - `link_day180_count` integer — Number of tenants this account has connected to in the last 180 days, if MAW is enabled.
        - `link_day365_count` integer — Number of tenants this account has connected to in the last 365 days, if MAW is enabled.
        - `link_day730_count` integer — Number of tenants this account has connected to in the last 730 days, if MAW is enabled.

---

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