import {z} from 'zod' export type RailsEnum = 'USD' | 'SOUTH_AMERICA_STANDARD' | 'AFRICA_GENERAL' | 'AFRICA_NIGERIA' | 'GLOBAL_NETWORK'; export type GetApiV2UsersUserIdKycStatusArgs = {userId: string, rails?: RailsEnum | undefined}; export type GetApiV2UsersUserIdKycStatusOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const kycStatusEnum = z.enum(["INACTIVE", "CREATED", "PENDING", "INCOMPLETE", "RFI_PENDING", "ACTIVE", "REJECTED", "CONTACT_SUPPORT"]); export const reviewResultObject = z.object({reviewAnswer: z.enum(["APPROVED", "DECLINED"]).optional(), reviewRejectType: z.enum(["FINAL", "RETRY"]).optional(), rejectReasons: z.array(z.string()).optional(), comment: z.string().optional()}); export const verificationStatusObject = z.object({reviewResult: reviewResultObject.optional()}); export const documentVerificationStatusObject = z.object({reviewResult: reviewResultObject.optional(), details: z.array(z.object({id: z.string().optional(), type: z.string().optional(), subType: z.string().optional(), reviewResult: reviewResultObject.optional()})).optional()}); export const reviewDetailsIndividualObject = z.object({personalInfo: verificationStatusObject.optional(), identity: documentVerificationStatusObject.optional(), proofOfAddress: documentVerificationStatusObject.optional(), questionnaire: verificationStatusObject.optional()}); export const usdRailIndividualKycStatusObject = z.object({status: kycStatusEnum, message: z.string(), reviewResult: reviewResultObject, details: reviewDetailsIndividualObject}); export const reviewDetailsBusinessObject = z.object({companyInfo: verificationStatusObject.optional(), companyDocuments: documentVerificationStatusObject.optional(), questionnaire: verificationStatusObject.optional(), ultimateBeneficialOwners: z.object({reviewResult: reviewResultObject.optional(), details: z.array(z.object({id: z.string().optional(), status: kycStatusEnum, message: z.string(), reviewResult: reviewResultObject, details: reviewDetailsIndividualObject})).optional()}).optional()}); export const usdRailBusinessKycStatusObject = z.object({status: kycStatusEnum, message: z.string(), reviewResult: reviewResultObject, details: reviewDetailsBusinessObject}); export const kycRailStatusObject = z.object({status: z.string().optional(), warnings: z.array(z.unknown()).optional(), message: z.string().optional()}); export const southAmericaRailKycStatusObject = z.object({status: kycStatusEnum.optional(), warnings: z.array(z.unknown()).optional(), message: z.string().optional(), limit: z.object({daily: z.number().optional(), monthly: z.number().optional(), perTransaction: z.number().optional()}).optional(), onRamp: z.object({brl: z.object({pix: kycRailStatusObject.optional()}).optional()}).optional(), offRamp: z.object({brl: z.object({pix: kycRailStatusObject.optional()}).optional(), mxn: z.object({spei: kycRailStatusObject.optional()}).optional(), cop: z.object({achCop: kycRailStatusObject.optional()}).optional(), ars: z.object({transfers: kycRailStatusObject.optional()}).optional()}).optional()}); export const africaGeneralRailKycStatusObject = z.object({status: kycStatusEnum, warnings: z.array(z.unknown()), message: z.string(), onRamp: z.object({kes: z.object({momo: kycRailStatusObject.optional()}).optional(), ghs: z.object({momo: kycRailStatusObject.optional()}).optional(), tzs: z.object({bank: kycRailStatusObject.optional()}).optional(), ugx: z.object({bank: kycRailStatusObject.optional()}).optional(), bwp: z.object({bank: kycRailStatusObject.optional()}).optional(), xaf: z.object({bank: kycRailStatusObject.optional(), momo: kycRailStatusObject.optional()}).optional(), mwk: z.object({bank: kycRailStatusObject.optional(), momo: kycRailStatusObject.optional()}).optional(), rwf: z.object({bank: kycRailStatusObject.optional()}).optional(), zmw: z.object({bank: kycRailStatusObject.optional(), momo: kycRailStatusObject.optional()}).optional(), xof: z.object({momo: kycRailStatusObject.optional()}).optional()}), offRamp: z.object({kes: z.object({bank: kycRailStatusObject.optional(), momo: kycRailStatusObject.optional()}).optional(), zar: z.object({bank: kycRailStatusObject.optional()}).optional(), ghs: z.object({momo: kycRailStatusObject.optional()}).optional(), tzs: z.object({momo: kycRailStatusObject.optional()}).optional(), ugx: z.object({momo: kycRailStatusObject.optional()}).optional(), bwp: z.object({momo: kycRailStatusObject.optional()}).optional(), xaf: z.object({momo: kycRailStatusObject.optional()}).optional(), mwk: z.object({momo: kycRailStatusObject.optional()}).optional(), rwf: z.object({momo: kycRailStatusObject.optional()}).optional(), zmw: z.object({momo: kycRailStatusObject.optional()}).optional(), xof: z.object({momo: kycRailStatusObject.optional()}).optional()})}); export const africaNigeriaRailKycStatusObject = z.object({status: kycStatusEnum, warnings: z.array(z.unknown()), message: z.string(), onRamp: z.object({ngn: z.object({bank: kycRailStatusObject.optional()}).optional()}), offRamp: z.object({ngn: z.object({bank: kycRailStatusObject.optional()}).optional()})}); export const globalNetworkRailKycStatusObject = z.object({status: kycStatusEnum, warnings: z.array(z.unknown()), message: z.string(), onRamp: z.object({}), offRamp: z.object({brl: z.object({pix: kycRailStatusObject.optional()}).optional(), hkd: z.object({wire: kycRailStatusObject.optional()}).optional(), mxn: z.object({spei: kycRailStatusObject.optional()}).optional(), ngn: z.object({bank: kycRailStatusObject.optional()}).optional()})}); export const getApiV2UsersUserIdKycStatusResponse = z.union([usdRailIndividualKycStatusObject, usdRailBusinessKycStatusObject, southAmericaRailKycStatusObject, africaGeneralRailKycStatusObject, africaNigeriaRailKycStatusObject, globalNetworkRailKycStatusObject]); 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 status * * GET /v2/users/{userId}/kyc/status */ export const getApiV2UsersUserIdKycStatus = async (args: GetApiV2UsersUserIdKycStatusArgs, options?: GetApiV2UsersUserIdKycStatusOptions) => { 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/status${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(getApiV2UsersUserIdKycStatusResponse, await res.json()) };