import {z} from 'zod' export type GetApiUsersUserIdChecksArgs = {list_history?: boolean | undefined, type?: ('KYC' | 'INSTRUMENT_FIT' | 'POR' | 'COMPLIANCE' | 'GUARDIAN' | 'USER_SELF_ASSESSMENT' | 'US_WITHHOLDING_TAX_STATUS') | undefined}; export type GetApiUsersUserIdChecksOptions = {baseUrl?: string | undefined, oauthClientCredentials?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiUsersUserIdChecksResponse = z.object({data: z.array(z.union([z.object({id: z.string(), user_id: z.string(), type: z.string(), check_confirmed_at: z.string(), data_download_link: z.string().max(1000), document_type: z.enum(["PASSPORT", "ID_CARD", "RESIDENCE_PERMIT", "DRIVING_LICENSE", "TWO_PLUS_TWO_VERIFICATION_PROOF"]), document_expiration_date: z.string().optional(), nationality: z.string().optional(), status: z.enum(["IN_PROGRESS", "PASSED", "FAILED"]), provider: z.string().max(100), method: z.enum(["VIDEO_ID", "IN_PERSON_ID", "ELECTRONIC_ID", "LIVENESS_PHOTO_ID", "QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX", "TWO_PLUS_TWO_VERIFICATION", "ID_COLLECTION"]), confirmed_address: z.object({address_line1: z.string().max(100), address_line2: z.string().max(100).optional(), postcode: z.string(), country: z.enum(["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: z.string().max(50).optional(), city: z.string().min(1).max(85)}).optional(), kyc_update: z.boolean().optional()}), z.object({id: z.string(), user_id: z.string(), type: z.string(), check_confirmed_at: z.string(), issuance_date: z.string(), data_download_link: z.string().max(1000), document_type: z.enum(["UTILITY_BILL", "TELEPHONE_BILL", "INTERNET_BILL", "BANK_STATEMENT", "REGISTRATION_CERT", "RESIDENCE_PERMIT", "ID_CARD", "PASSPORT"]), status: z.enum(["IN_PROGRESS", "PASSED", "FAILED"]), confirmed_address: z.object({address_line1: z.string().max(100), address_line2: z.string().max(100).optional(), postcode: z.string(), country: z.enum(["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: z.string().max(50).optional(), city: z.string().min(1).max(85)})}), z.object({id: z.string(), user_id: z.string(), type: z.string(), check_confirmed_at: z.string(), status: z.enum(["IN_PROGRESS", "PASSED", "FAILED"]), instrument_suitability: z.object({suitability: z.boolean()})}), z.object({id: z.string(), user_id: z.string(), type: z.string(), status: z.enum(["IN_PROGRESS", "PASSED", "FAILED"]).optional(), check_confirmed_at: z.string()}), z.object({id: z.string(), user_id: z.string(), type: z.string(), check_confirmed_at: z.string().optional(), role_id: z.string(), document_type: z.enum(["BIRTH_CERTIFICATE", "SOLE_CUSTODY_PROOF"]), data_download_link: z.string().max(1000), status: z.enum(["IN_PROGRESS", "PASSED", "FAILED"])}), z.object({id: z.string(), user_id: z.string(), type: z.string(), check_confirmed_at: z.string(), data_download_link: z.string().max(1000).optional(), person_type: z.enum(["US_PERSON", "NON_RESIDENT_ALIEN"]), documentation_type: z.enum(["KYC", "W8-BEN", "W9", "UNDOCUMENTED"]), valid_from: z.string(), valid_to: z.string().nullable().optional(), status: z.enum(["IN_PROGRESS", "PASSED", "FAILED"])})]))}); 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 }; /** * Get checks for a user * * GET /users/{user_id}/checks */ export const getApiUsersUserIdChecks = async (args: GetApiUsersUserIdChecksArgs, options?: GetApiUsersUserIdChecksOptions) => { const {baseUrl = "https://sandbox.upvest.co", fetch: fetchFn = fetch, oauthClientCredentials} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.list_history != null) query.append("list_history", String(args.list_history)) if (args.type != null) query.append("type", String(args.type)) 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: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiUsersUserIdChecksResponse, await res.json()) };