import {z} from 'zod' export type Address = {addressLine1: string, addressLine2?: string | undefined, city: string, stateProvinceRegion: string, postalCode: string, country: string}; export type SofEuKycQuestionnaire = {actingAsIntermediary?: boolean | undefined, employmentStatus?: ('employed' | 'homemaker' | 'retired' | 'self_employed' | 'student' | 'unemployed') | undefined, expectedMonthlyPayments?: ('0_4999' | '5000_9999' | '10000_49999' | '50000_plus') | undefined, mostRecentOccupation?: string | undefined, primaryPurpose?: ('charitable_donations' | 'ecommerce_retail_payments' | 'investment_purposes' | 'operating_a_company' | 'payments_to_friends_or_family_abroad' | 'personal_or_living_expenses' | 'protect_wealth' | 'purchase_goods_and_services' | 'receive_payment_for_freelancing' | 'receive_salary' | 'other') | undefined, primaryPurposeOther?: string | undefined, sourceOfFunds?: ('company_funds' | 'ecommerce_reseller' | 'gambling_proceeds' | 'gifts' | 'government_benefits' | 'inheritance' | 'investments_loans' | 'pension_retirement' | 'salary' | 'sale_of_assets_real_estate' | 'savings' | 'someone_elses_funds') | undefined}; export type IndividualKycUpdate = {firstName?: string | undefined, firstNameLocal?: string | undefined, middleName?: string | undefined, middleNameLocal?: string | undefined, lastName?: string | undefined, lastNameLocal?: string | undefined, nationality?: string | undefined, email?: string | undefined, phone?: string | undefined, address?: Address | undefined, dateOfBirth?: string | undefined, countryOfBirth?: string | undefined, stateOfBirth?: string | undefined, placeOfBirth?: string | undefined, gender?: ('M' | 'F') | undefined, country?: string | undefined, taxIdentificationNumber?: string | undefined, taxResidenceCountry?: string | undefined, ipAddress?: string | undefined, govIdType?: ('PASSPORT' | 'ID_CARD' | 'DRIVERS') | undefined, govIdFrontUrl?: string | undefined, govIdBackUrl?: string | undefined, govIdCountry?: string | undefined, govIdNumber?: string | undefined, govIdIssuanceDate?: string | undefined, govIdExpirationDate?: string | undefined, govIdIssuanceAuthority?: string | undefined, govIdHandHoldUrl?: string | undefined, proofOfAddressType?: ('UTILITY_BILL' | 'BANK_STATEMENT' | 'RENTAL_AGREEMENT' | 'TAX_DOCUMENT') | undefined, proofOfAddressUrl?: string | undefined, sofEuQuestionnaire?: SofEuKycQuestionnaire | undefined, idType?: ('PASSPORT' | 'ID_CARD' | 'DRIVERS' | 'NIN') | undefined, idNumber?: string | undefined, additionalIdType?: string | undefined, additionalIdNumber?: string | undefined, purpose?: Array | undefined, productServiceCategory?: string | undefined, supplementaryInfo?: string | undefined, supplementaryUrl?: string | undefined}; export type SofEuKybQuestionnaire = {estimatedAnnualRevenueUsd?: ('0_99999' | '100000_999999' | '1000000_9999999' | '10000000_49999999' | '50000000_249999999' | '250000000_plus') | undefined, expectedMonthlyPaymentsUsd?: string | undefined, operatesInProhibitedCountries?: boolean | undefined, primaryPurpose?: ('charitable_donations' | 'ecommerce_retail_payments' | 'investment_purposes' | 'other' | 'payments_to_friends_or_family_abroad' | 'payroll' | 'personal_or_living_expenses' | 'protect_wealth' | 'purchase_goods_and_services' | 'receive_payments_for_goods_and_services' | 'tax_optimization' | 'third_party_money_transmission' | 'treasury_management') | undefined, primaryPurposeOther?: string | undefined, highRiskActivities?: (Array<'none_of_the_above' | 'adult_entertainment' | 'gambling' | 'hold_client_funds' | 'investment_services' | 'lending_banking' | 'marijuana_or_related_services' | 'money_services' | 'operate_foreign_exchange_virtual_currencies_brokerage_otc' | 'safe_deposit_box_rentals' | 'third_party_payment_processing' | 'weapons_firearms_and_explosives'>) | undefined, sourceOfFunds?: ('business_loans' | 'grants' | 'inter_company_funds' | 'investment_proceeds' | 'legal_settlement' | 'owners_capital' | 'pension_retirement' | 'sale_of_assets' | 'sales_of_goods_and_services' | 'tax_refund' | 'third_party_funds' | 'treasury_reserves') | undefined, sourceOfFundsDescription?: string | undefined, transmitsCustomerFunds?: boolean | undefined, transmitsCustomerFundsDescription?: string | undefined, customerFundsDescription?: string | undefined, conductsMoneyServices?: boolean | undefined}; export type UltimateBeneficialOwner = {role?: ('OWNER_OR_OPERATOR' | 'PARTNER' | 'UBO' | 'DIRECTOR_CONTROL_PERSON_OR_LEGAL_REP' | 'AGENT_OR_AUTHORISED_PERSON') | undefined, roles?: (Array<'UBO' | 'DIRECTOR' | 'REPRESENTATIVE' | 'SHAREHOLDER'>) | undefined, businessTitle?: string | undefined, firstName?: string | undefined, firstNameLocal?: string | undefined, middleName?: string | undefined, middleNameLocal?: string | undefined, lastName?: string | undefined, lastNameLocal?: string | undefined, nationality?: string | undefined, email?: string | undefined, phone?: string | undefined, address?: Address | undefined, dateOfBirth?: string | undefined, countryOfBirth?: string | undefined, stateOfBirth?: string | undefined, placeOfBirth?: string | undefined, gender?: ('M' | 'F') | undefined, taxIdentificationNumber?: string | undefined, taxResidenceCountry?: string | undefined, govIdType?: ('PASSPORT' | 'ID_CARD' | 'DRIVERS') | undefined, govIdCountry?: string | undefined, govIdNumber?: string | undefined, govIdFrontUrl?: string | undefined, govIdBackUrl?: string | undefined, govIdIssuanceDate?: string | undefined, govIdExpirationDate?: string | undefined, govIdIssuanceAuthority?: string | undefined, proofOfAddressType?: ('UTILITY_BILL' | 'BANK_STATEMENT' | 'RENTAL_AGREEMENT' | 'TAX_DOCUMENT') | undefined, proofOfAddressUrl?: string | undefined, authLetterUrl?: string | undefined, shareProportion?: number | undefined, hasOwnership?: boolean | undefined, hasControl?: boolean | undefined, isSigner?: boolean | undefined, relationshipEstablishedAt?: string | undefined, supplementaryInfo?: string | undefined, supplementaryUrl?: string | undefined}; export type BusinessKycUpdate = {businessName?: string | undefined, businessNameLocal?: string | undefined, alternativeNames?: Array | undefined, businessDescription?: string | undefined, businessIndustry?: string | undefined, businessType?: ('cooperative' | 's_corporation' | 'b_corporation' | 'c_corporation' | 'close_corporation' | 'nonprofit_corporation' | 'general_partnership' | 'limited_partnership' | 'limited_liability_company' | 'other' | 'sole_proprietorship' | 'trust') | undefined, email?: string | undefined, phone?: string | undefined, taxIdentificationNumberType?: ('EIN' | 'SSN' | 'VAT' | 'TIN' | 'UTR') | undefined, taxIdentificationNumber?: string | undefined, registrationNumber?: string | undefined, leiNumber?: string | undefined, formationDate?: string | undefined, incorporationDate?: string | undefined, incorporationCountry?: string | undefined, incorporationState?: string | undefined, website?: string | undefined, address?: Address | undefined, registeredAddress?: Address | undefined, postalAddress?: Address | undefined, ipAddress?: string | undefined, sourceOfFunds?: string | undefined, transmitsCustomerFunds?: boolean | undefined, complianceScreeningExplanation?: string | undefined, daoStatus?: boolean | undefined, proofOfAddressType?: ('UTILITY_BILL' | 'BANK_STATEMENT' | 'RENTAL_AGREEMENT' | 'TAX_DOCUMENT') | undefined, proofOfAddressUrl?: string | undefined, formationDocUrl?: string | undefined, proofOfOwnershipUrl?: string | undefined, certificateOfRegistrationDocType?: ('ACRA' | 'GST' | 'MSME' | 'CERTIFICATE_OF_REGISTRATION') | undefined, certificateOfRegistrationDocUrl?: string | undefined, certificateNumber?: string | undefined, businessRegistrationDocUrl?: string | undefined, licenseExpirationDate?: string | undefined, certificateOfIncorporationDocUrl?: string | undefined, incorporationNumber?: string | undefined, controlScheme?: string | undefined, shareStructureUrl?: string | undefined, constitutionOrAnnualReportUrl?: string | undefined, articlesOfAssociationUrl?: string | undefined, uboDeclarationUrl?: string | undefined, partnershipMinsOfMeetingUrl?: string | undefined, partnershipDeedUrl?: string | undefined, certificateOfIncumbencyUrl?: string | undefined, organizationStructureUrl?: string | undefined, sourceOfFundsUrl?: string | undefined, flowOfFundsUrl?: string | undefined, purpose?: (Array<'PAY_SUPPLIERS' | 'PAY_SERVICE_PROVIDERS' | 'GOODS_MERCHANDISE_COMMODITIES' | 'FREELANCERS_CONTRACTORS_PAYROLL' | 'FINANCIAL_SERVICES_LOANS_INVESTMENTS' | 'TAX_REGULATORY_FEES' | 'LEGAL_SERVICES' | 'OPERATIONAL_EXPENSES' | 'SUBSCRIPTIONS' | 'TRAVEL_RELATED_EXPENSES' | 'INSURANCE' | 'ADVERTISING_MARKETING_EXPENSES' | 'EQUIPMENT_MACHINERY' | 'TECHNOLOGY_SERVICES' | 'EDUCATION_RELATED_EXPENSES' | 'TREASURY_PAYMENTS' | 'FX_SERVICES' | 'OTHER' | 'ONLINE_MARKETPLACE_TRADING' | 'OFFLINE_TRADING'>) | undefined, productServiceCategory?: string | undefined, tradeName?: string | undefined, exportCountry?: string | undefined, tradeType?: string | undefined, supplementaryInfo?: string | undefined, supplementaryUrl?: string | undefined, sofEuQuestionnaire?: SofEuKybQuestionnaire | undefined, ultimateBeneficialOwners?: Array | undefined}; export type CreateApiV2UsersUserIdKycArgs = {userId: string, body: IndividualKycUpdate | BusinessKycUpdate}; export type CreateApiV2UsersUserIdKycOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const address = z.object({addressLine1: z.string(), addressLine2: z.string().optional(), city: z.string(), stateProvinceRegion: z.string(), postalCode: z.string(), country: z.string()}); export const sofEuKycQuestionnaire = z.object({actingAsIntermediary: z.boolean().optional(), employmentStatus: z.enum(["employed", "homemaker", "retired", "self_employed", "student", "unemployed"]).optional(), expectedMonthlyPayments: z.enum(["0_4999", "5000_9999", "10000_49999", "50000_plus"]).optional(), mostRecentOccupation: z.string().optional(), primaryPurpose: z.enum(["charitable_donations", "ecommerce_retail_payments", "investment_purposes", "operating_a_company", "payments_to_friends_or_family_abroad", "personal_or_living_expenses", "protect_wealth", "purchase_goods_and_services", "receive_payment_for_freelancing", "receive_salary", "other"]).optional(), primaryPurposeOther: z.string().optional(), sourceOfFunds: z.enum(["company_funds", "ecommerce_reseller", "gambling_proceeds", "gifts", "government_benefits", "inheritance", "investments_loans", "pension_retirement", "salary", "sale_of_assets_real_estate", "savings", "someone_elses_funds"]).optional()}); export const documentObject = z.object({type: z.string().optional(), subType: z.string().optional(), issuedCountry: z.string().optional(), issuedDate: z.string().optional(), expiryDate: z.string().optional(), number: z.string().optional(), description: z.string().optional(), url: z.string().optional(), fileId: z.string().optional(), uboId: z.string().optional()}); export const kycIndividualObject = z.object({userId: z.string().optional(), kycInfo: z.object({type: z.literal("individual").optional(), firstName: z.string().optional(), firstNameLocal: z.string().optional(), middleName: z.string().optional(), middleNameLocal: z.string().optional(), lastName: z.string().optional(), lastNameLocal: z.string().optional(), nationality: z.string().optional(), email: z.string().optional(), phone: z.string().optional(), address: address.optional(), dateOfBirth: z.string().optional(), countryOfBirth: z.string().optional(), stateOfBirth: z.string().optional(), placeOfBirth: z.string().optional(), gender: z.string().optional(), country: z.string().optional(), taxIdentificationNumber: z.string().optional(), taxResidenceCountry: z.string().optional(), govIdType: z.string().optional(), govIdFrontUrl: z.string().optional(), govIdBackUrl: z.string().optional(), govIdCountry: z.string().optional(), govIdNumber: z.string().optional(), govIdIssuanceDate: z.string().optional(), govIdExpirationDate: z.string().optional(), govIdIssuanceAuthority: z.string().optional(), govIdHandHoldUrl: z.string().optional(), proofOfAddressType: z.string().optional(), proofOfAddressUrl: z.string().optional(), sofEuQuestionnaire: sofEuKycQuestionnaire.optional(), ipAddress: z.string().optional(), idType: z.string().optional(), idNumber: z.string().optional(), additionalIdType: z.string().optional(), additionalIdNumber: z.string().optional(), purpose: z.string().optional(), productServiceCategory: z.string().optional(), supplementaryInfo: z.string().optional(), supplementaryUrl: z.string().optional(), documents: z.array(documentObject).optional()}).optional()}); export const ultimateBeneficialOwner = z.object({role: z.enum(["OWNER_OR_OPERATOR", "PARTNER", "UBO", "DIRECTOR_CONTROL_PERSON_OR_LEGAL_REP", "AGENT_OR_AUTHORISED_PERSON"]).optional(), roles: z.array(z.enum(["UBO", "DIRECTOR", "REPRESENTATIVE", "SHAREHOLDER"])).optional(), businessTitle: z.string().optional(), firstName: z.string().optional(), firstNameLocal: z.string().optional(), middleName: z.string().optional(), middleNameLocal: z.string().optional(), lastName: z.string().optional(), lastNameLocal: z.string().optional(), nationality: z.string().optional(), email: z.string().optional(), phone: z.string().optional(), address: address.optional(), dateOfBirth: z.string().optional(), countryOfBirth: z.string().optional(), stateOfBirth: z.string().optional(), placeOfBirth: z.string().optional(), gender: z.enum(["M", "F"]).optional(), taxIdentificationNumber: z.string().optional(), taxResidenceCountry: z.string().optional(), govIdType: z.enum(["PASSPORT", "ID_CARD", "DRIVERS"]).optional(), govIdCountry: z.string().optional(), govIdNumber: z.string().optional(), govIdFrontUrl: z.string().optional(), govIdBackUrl: z.string().optional(), govIdIssuanceDate: z.string().optional(), govIdExpirationDate: z.string().optional(), govIdIssuanceAuthority: z.string().optional(), proofOfAddressType: z.enum(["UTILITY_BILL", "BANK_STATEMENT", "RENTAL_AGREEMENT", "TAX_DOCUMENT"]).optional(), proofOfAddressUrl: z.string().optional(), authLetterUrl: z.string().optional(), shareProportion: z.number().optional(), hasOwnership: z.boolean().optional(), hasControl: z.boolean().optional(), isSigner: z.boolean().optional(), relationshipEstablishedAt: z.string().optional(), supplementaryInfo: z.string().optional(), supplementaryUrl: z.string().optional()}); export const uboObject = ultimateBeneficialOwner; export const sofEuKybQuestionnaire = z.object({estimatedAnnualRevenueUsd: z.enum(["0_99999", "100000_999999", "1000000_9999999", "10000000_49999999", "50000000_249999999", "250000000_plus"]).optional(), expectedMonthlyPaymentsUsd: z.string().optional(), operatesInProhibitedCountries: z.boolean().optional(), primaryPurpose: z.enum(["charitable_donations", "ecommerce_retail_payments", "investment_purposes", "other", "payments_to_friends_or_family_abroad", "payroll", "personal_or_living_expenses", "protect_wealth", "purchase_goods_and_services", "receive_payments_for_goods_and_services", "tax_optimization", "third_party_money_transmission", "treasury_management"]).optional(), primaryPurposeOther: z.string().optional(), highRiskActivities: z.array(z.enum(["none_of_the_above", "adult_entertainment", "gambling", "hold_client_funds", "investment_services", "lending_banking", "marijuana_or_related_services", "money_services", "operate_foreign_exchange_virtual_currencies_brokerage_otc", "safe_deposit_box_rentals", "third_party_payment_processing", "weapons_firearms_and_explosives"])).optional(), sourceOfFunds: z.enum(["business_loans", "grants", "inter_company_funds", "investment_proceeds", "legal_settlement", "owners_capital", "pension_retirement", "sale_of_assets", "sales_of_goods_and_services", "tax_refund", "third_party_funds", "treasury_reserves"]).optional(), sourceOfFundsDescription: z.string().optional(), transmitsCustomerFunds: z.boolean().optional(), transmitsCustomerFundsDescription: z.string().optional(), customerFundsDescription: z.string().optional(), conductsMoneyServices: z.boolean().optional()}); export const kycBusinessObject = z.object({userId: z.string().optional(), kycInfo: z.object({type: z.literal("business").optional(), businessName: z.string().optional(), businessNameLocal: z.string().optional(), alternativeNames: z.array(z.string()).optional(), businessDescription: z.string().optional(), email: z.string().optional(), phone: z.string().optional(), sourceOfFunds: z.string().optional(), businessType: z.string().optional(), businessIndustry: z.string().optional(), website: z.string().optional(), address: address.optional(), registeredAddress: address.optional(), postalAddress: address.optional(), taxIdentificationNumberType: z.string().optional(), taxIdentificationNumber: z.string().optional(), leiNumber: z.string().optional(), daoStatus: z.boolean().optional(), transmitsCustomerFunds: z.boolean().optional(), formationDate: z.string().optional(), ipAddress: z.string().optional(), formationDocUrl: z.string().optional(), proofOfOwnershipUrl: z.string().optional(), complianceScreeningExplanation: z.string().optional(), ultimateBeneficialOwners: z.array(uboObject).optional(), proofOfAddressType: z.string().optional(), proofOfAddressUrl: z.string().optional(), certificateOfRegistrationDocType: z.string().optional(), certificateOfRegistrationDocUrl: z.string().optional(), certificateNumber: z.string().optional(), businessRegistrationDocUrl: z.string().optional(), registrationNumber: z.string().optional(), licenseExpirationDate: z.string().optional(), certificateOfIncorporationDocUrl: z.string().optional(), incorporationNumber: z.string().optional(), incorporationDate: z.string().optional(), incorporationCountry: z.string().optional(), incorporationState: z.string().optional(), controlScheme: z.string().optional(), shareStructureUrl: z.string().optional(), constitutionOrAnnualReportUrl: z.string().optional(), articlesOfAssociationUrl: z.string().optional(), uboDeclarationUrl: z.string().optional(), partnershipMinsOfMeetingUrl: z.string().optional(), partnershipDeedUrl: z.string().optional(), certificateOfIncumbencyUrl: z.string().optional(), sourceOfFundsUrl: z.string().optional(), organizationStructureUrl: z.string().optional(), flowOfFundsUrl: z.string().optional(), purpose: z.string().optional(), productServiceCategory: z.string().optional(), tradeName: z.string().optional(), exportCountry: z.string().optional(), tradeType: z.string().optional(), sofEuQuestionnaire: sofEuKybQuestionnaire.optional(), supplementaryInfo: z.string().optional(), supplementaryUrl: z.string().optional(), documents: z.array(documentObject).optional()}).optional()}); export const createApiV2UsersUserIdKycResponse = z.union([kycIndividualObject, kycBusinessObject]); 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 }; /** * Update KYC information * * POST /v2/users/{userId}/kyc */ export const createApiV2UsersUserIdKyc = async (args: CreateApiV2UsersUserIdKycArgs, options?: CreateApiV2UsersUserIdKycOptions) => { const {baseUrl = "https://production.hifibridge.com", fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v2/users/${encodeURIComponent(String(args.userId))}/kyc${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(createApiV2UsersUserIdKycResponse, await res.json()) };