import {z} from 'zod' export type CreateApiUsersUserIdChecksArgs = {body: {type: string, check_confirmed_at: string, data_download_link: string, document_type: 'PASSPORT' | 'ID_CARD' | 'RESIDENCE_PERMIT' | 'DRIVING_LICENSE' | 'TWO_PLUS_TWO_VERIFICATION_PROOF', document_expiration_date?: string | undefined, nationality?: string | undefined, provider: string, method: 'VIDEO_ID' | 'IN_PERSON_ID' | 'ELECTRONIC_ID' | 'LIVENESS_PHOTO_ID' | 'QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX' | 'TWO_PLUS_TWO_VERIFICATION' | 'ID_COLLECTION', confirmed_address?: ({address_line1: string, address_line2?: string | undefined, postcode: string, country: 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', state?: string | undefined, city: string}) | undefined, kyc_update?: boolean | undefined} | {type: string, check_confirmed_at: string, issuance_date: string, data_download_link: string, document_type: 'UTILITY_BILL' | 'TELEPHONE_BILL' | 'INTERNET_BILL' | 'BANK_STATEMENT' | 'REGISTRATION_CERT' | 'RESIDENCE_PERMIT' | 'ID_CARD', confirmed_address: {address_line1: string, address_line2?: string | undefined, postcode: string, country: 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', state?: string | undefined, city: string}} | {type: string, check_confirmed_at: string, instrument_suitability: {suitability: boolean}} | {type: string, check_confirmed_at: string, role_id: string, document_type: 'BIRTH_CERTIFICATE' | 'SOLE_CUSTODY_PROOF', data_download_link: string} | {type: string, check_confirmed_at: string, user_occupation: 'EMPLOYEE' | 'HOMEMAKER' | 'PENSIONER' | 'PUBLIC_OFFICIAL' | 'UNEMPLOYED' | 'SELF_EMPLOYED_FREELANCER' | 'STUDENT' | 'TRAINEE' | 'OTHER', user_industry: 'AGRICULTURE_FORESTRY_AND_FISHING' | 'MANUFACTURING' | 'UTILITIES_AND_ENERGY' | 'WHOLESALE_TRADE' | 'RETAIL_TRADE' | 'TRANSPORTATION_AND_LOGISTICS_RAIL_AND_STORAGE' | 'INFORMATION_TECHNOLOGY_AND_MEDIA_PRINT_PUBLISHING' | 'ADMIN_AND_SUPPORT_SERVICES_CLEANING_AND_FACILITIES' | 'EDUCATION_HIGHER_EDUCATION' | 'ENTERTAINMENT_ARTS_AND_RECREATION_NATURE_AND_ZOOS' | 'EXTRATERRITORIAL_AND_HOUSEHOLD_ACTIVITIES' | 'MANUFACTURING_PHARMACEUTICALS' | 'CONSTRUCTION' | 'RETAIL_TRADE_SPECIALITY' | 'WHOLESALE_TRADE_INDUSTRIAL' | 'TRANSPORTATION_AND_LOGISTICS' | 'ACCOMMODATION_AND_HOSPITALITY' | 'INFORMATION_TECHNOLOGY_AND_MEDIA' | 'REAL_ESTATE' | 'PROFESSIONAL_AND_TECHNICAL_SERVICES' | 'ADMIN_AND_SUPPORT_SERVICES' | 'PUBLIC_ADMINISTRATION' | 'EDUCATION' | 'HEALTHCARE' | 'ENTERTAINMENT_ARTS_AND_RECREATION' | 'PERSONAL_AND_OTHER_SERVICES' | 'MINING_AND_QUARRYING' | 'MANUFACTURING_WEAPONS_AND_HAZARDOUS' | 'MANUFACTURING_PRECIOUS_METALS_AND_JEWELLERY' | 'RETAIL_TRADE_SPECIFIC_SECTORS' | 'WHOLESALE_TRADE_PETROLEUM_AND_CHEMICALS' | 'WHOLESALE_TRADE_LUXURY_AND_COLLECTIBLES' | 'INFORMATION_TECHNOLOGY_AND_MEDIA_TELECOMMUNICATIONS' | 'TRANSPORTATION_AND_LOGISTICS_CRUISE_LINES' | 'ACCOMMODATION_AND_HOSPITALITY_TIMESHARING' | 'FOOD_AND_BEVERAGE_SERVICES' | 'INFORMATION_TECHNOLOGY_AND_MEDIA_ONLINE_GAMING' | 'FINANCIAL_SERVICES' | 'REAL_ESTATE_AGENCY_AND_BROKERAGE' | 'PROFESSIONAL_AND_TECHNICAL_SERVICES_LEGAL_AND_FIDUCIARY' | 'PROFESSIONAL_AND_TECHNICAL_SERVICES_UNREGULATED' | 'ADMIN_AND_SUPPORT_SERVICES_SPECIFIC_SECTORS' | 'ADMIN_AND_SUPPORT_SERVICES_SECURITY_AND_INVESTIGATION' | 'PUBLIC_ADMINISTRATION_JUDICIAL' | 'HEALTHCARE_COUNSELLING_AND_SOCIAL_SERVICES' | 'ENTERTAINMENT_ARTS_AND_RECREATION_SPECIFIC_SECTORS' | 'PERSONAL_AND_OTHER_SERVICES_NONPROFIT_AND_MEMBERSHIP_ORGANISATIONS' | 'PERSONAL_AND_OTHER_SERVICES_ADULT_AND_WELLNESS' | 'OTHER', yearly_gross_income: {currency: 'EUR' | 'GBP', lower_bound: number, upper_bound?: number | undefined}, income_sources: Array<'EMPLOYMENT_INCOME' | 'CAPITAL_GAINS_SAVINGS_AND_INVESTMENTS' | 'INHERITANCE' | 'SELF_EMPLOYMENT' | 'REAL_ESTATE_SALE_RENTAL' | 'DONATIONS' | 'BUSINESS_ENTERPRISE_REVENUE' | 'GOVERNMENT_OR_SOCIAL_BENEFITS' | 'PENSION_RETIREMENT_FUNDS' | 'SOLE_TRADER' | 'OTHER' | 'NONE'>} | {type: string, check_confirmed_at: string, data_download_link?: string | undefined, person_type: 'US_PERSON' | 'NON_RESIDENT_ALIEN', documentation_type: 'KYC' | 'W8-BEN' | 'W9' | 'UNDOCUMENTED', valid_from: string, valid_to?: (string | null) | undefined}}; export type CreateApiUsersUserIdChecksOptions = {baseUrl?: string | undefined, oauthClientCredentials?: string | undefined, fetch?: typeof fetch | undefined}; export const createApiUsersUserIdChecksResponse = z.object({id: z.string()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Create a new check for a user * * POST /users/{user_id}/checks */ export const createApiUsersUserIdChecks = async (args: CreateApiUsersUserIdChecksArgs, options?: CreateApiUsersUserIdChecksOptions) => { const {baseUrl = "https://sandbox.upvest.co", fetch: fetchFn = fetch, oauthClientCredentials} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (oauthClientCredentials !== undefined) headers.set('authorization', `Bearer ${oauthClientCredentials}`) const url = `${baseUrl.replace(/\/+$/, '')}/users/${encodeURIComponent(String(args.user_id))}/checks${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(createApiUsersUserIdChecksResponse, await res.json()) };