import {z} from 'zod' export type RailsEnum = 'USD' | 'SOUTH_AMERICA_STANDARD' | 'AFRICA_GENERAL' | 'AFRICA_NIGERIA' | 'GLOBAL_NETWORK'; export type GetApiV2UsersUserIdKycRequirementsArgs = {userId: string, rails: RailsEnum}; export type GetApiV2UsersUserIdKycRequirementsOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const railsEnum = z.enum(["USD", "SOUTH_AMERICA_STANDARD", "AFRICA_GENERAL", "AFRICA_NIGERIA", "GLOBAL_NETWORK"]); export const addressReqOptObject = z.object({required: z.object({addressLine1: z.string().optional(), city: z.string().optional(), stateProvinceRegion: z.string().optional(), postalCode: z.string().optional(), country: z.string().optional()}).optional(), optional: z.object({addressLine2: z.string().optional()}).optional()}); export const sofEuQaKybReqOptObject = z.object({required: z.object({primaryPurpose: z.string().optional(), sourceOfFunds: z.string().optional(), transmitsCustomerFunds: z.string().optional(), conductsMoneyServices: z.string().optional(), highRiskActivities: z.string().optional(), estimatedAnnualRevenueUsd: z.string().optional(), expectedMonthlyPaymentsUsd: z.string().optional(), customerFundsDescription: z.string().optional()}).optional(), optional: z.object({operatesInProhibitedCountries: z.string().optional(), primaryPurposeOther: z.string().optional(), sourceOfFundsDescription: z.string().optional(), transmitsCustomerFundsDescription: z.string().optional()}).optional()}); export const docGroupRequirementObject = z.object({minCount: z.number().int().optional(), acceptedDocTypes: z.array(z.string()).optional()}); export const uSDRailBusinessDocReqOptObject = z.object({legalPresence: docGroupRequirementObject.optional(), ownershipStructure: docGroupRequirementObject.optional(), companyDetails: docGroupRequirementObject.optional(), controlStructure: docGroupRequirementObject.optional()}); export const uSDRailBusinessKYCReqOptObject = z.object({userId: z.string().optional(), rails: railsEnum.optional(), type: z.literal("business").optional(), required: z.object({businessName: z.string().optional(), businessType: z.string().optional(), businessIndustry: z.string().optional(), registrationNumber: z.string().optional(), registeredAddress: z.string().optional(), address: addressReqOptObject.optional(), website: z.string().optional(), incorporationDate: z.string().optional(), email: z.string().optional(), phone: z.string().optional(), taxIdentificationNumber: z.string().optional(), sofEuQuestionnaire: sofEuQaKybReqOptObject.optional(), ultimateBeneficialOwners: z.array(z.unknown()).optional(), documents: uSDRailBusinessDocReqOptObject.optional()}).optional(), optional: z.object({incorporationCountry: z.string().optional(), incorporationState: z.string().optional()}).optional(), invalid: z.object({message: z.string().optional(), fields: z.object({registrationNumber: z.string().optional()}).optional(), documents: z.object({message: z.string().optional(), groups: z.object({controlStructure: z.object({minCount: z.number().int().optional(), acceptedDocTypes: z.array(z.string()).optional()}).optional()}).optional()}).optional()}).optional()}); export const uSDRailIndividualDocReqOptObject = z.object({identity: docGroupRequirementObject.optional(), proofOfResidence: docGroupRequirementObject.optional()}); export const sofEuQaKycReqOptObject = z.object({required: z.object({actingAsIntermediary: z.string().optional(), employmentStatus: z.string().optional(), expectedMonthlyPayments: z.string().optional(), mostRecentOccupation: z.string().optional(), primaryPurpose: z.string().optional(), sourceOfFunds: z.string().optional()}).optional(), optional: z.object({primaryPurposeOther: z.string().optional()}).optional()}); export const uSDRailIndividualKYCReqOptObject = z.object({userId: z.string().optional(), rails: railsEnum.optional(), type: z.literal("individual").optional(), required: z.object({firstName: z.string().optional(), lastName: z.string().optional(), email: z.string().optional(), phone: z.string().optional(), nationality: z.string().optional(), dateOfBirth: z.string().optional(), address: addressReqOptObject.optional(), taxIdentificationNumber: z.string().optional(), documents: uSDRailIndividualDocReqOptObject.optional()}).optional(), optional: z.object({sofEuQuestionnaire: sofEuQaKycReqOptObject.optional()}).optional(), invalid: z.object({message: z.string().optional(), fields: z.object({phone: z.string().optional(), nationality: z.string().optional(), taxIdentificationNumber: z.string().optional()}).optional(), documents: z.object({message: z.string().optional(), groups: z.object({identity: z.object({minCount: z.number().int().optional(), acceptedDocTypes: z.array(z.string()).optional()}).optional()}).optional()}).optional()}).optional()}); export const getApiV2UsersUserIdKycRequirementsResponse = z.union([uSDRailBusinessKYCReqOptObject, uSDRailIndividualKYCReqOptObject]); 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 }; /** * Retrieve KYC requirements * * GET /v2/users/{userId}/kyc/requirements */ export const getApiV2UsersUserIdKycRequirements = async (args: GetApiV2UsersUserIdKycRequirementsArgs, options?: GetApiV2UsersUserIdKycRequirementsOptions) => { const {baseUrl = "https://production.hifibridge.com", fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.rails != null) query.append("rails", String(args.rails)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v2/users/${encodeURIComponent(String(args.userId))}/kyc/requirements${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(getApiV2UsersUserIdKycRequirementsResponse, await res.json()) };