import {z} from 'zod' export type StringNoEdgeSpaces = string; export type CountryCodeForRequest = string; export type SubdivisionCodeForRequest = string; export type GetApiCoreKybArgs = {detailed?: (Array<'profile' | 'documents' | 'financialInstitution' | 'associatedPersons' | 'attestation'>) | undefined, 'X-On-Behalf-Of'?: string | undefined, 'X-Uphold-User-Ip'?: (string | string) | undefined, 'X-Uphold-User-Agent'?: StringNoEdgeSpaces | undefined, 'X-Uphold-User-Origin'?: StringNoEdgeSpaces | undefined, 'X-Uphold-User-Country'?: CountryCodeForRequest | undefined, 'X-Uphold-User-Subdivision'?: SubdivisionCodeForRequest | undefined, 'X-Uphold-User-City'?: StringNoEdgeSpaces | undefined}; export type GetApiCoreKybOptions = {baseUrl?: string | undefined, OAuth2?: string | undefined, fetch?: typeof fetch | undefined}; export const kybProcessStatus = z.enum(["ok", "failed", "running", "pending", "exempt"]); export const businessLegalEntityType = z.enum(["government-entity", "non-profit", "partnership", "private-limited-company", "public-company", "sole-proprietor"]); export const kybProfileIndustryBase = z.union([z.object({sector: z.literal("financial-institutions-and-money-services"), subSector: z.enum(["money-transmitters", "remittance-services", "vasp-casp", "payment-processors", "fx-providers", "other-regulated-nbfi"]).optional()}), z.object({sector: z.literal("crypto-services-and-products"), subSector: z.enum(["exchanges", "custodial-wallet-providers", "non-custodial-wallet-providers", "miners", "nft-platforms", "defi-projects"]).optional()}), z.object({sector: z.literal("personal-investment-vehicles"), subSector: z.enum(["private-trusts", "roth-ira", "llc-spe-for-holding-assets"]).optional()}), z.object({sector: z.literal("family-offices-and-investment-funds"), subSector: z.enum(["family-offices", "pooled-investment-vehicles", "private-investment-funds"]).optional()}), z.object({sector: z.literal("professional-services"), subSector: z.enum(["law-firms", "accounting-firms", "consultants", "company-formation-or-secretarial-services"]).optional()}), z.object({sector: z.literal("technology-and-software"), subSector: z.enum(["it-services", "saas", "gaming-studios", "cybersecurity", "data-analytics", "ai-firms"]).optional()}), z.object({sector: z.literal("ecommerce-and-retail"), subSector: z.enum(["online-marketplaces", "merchants", "wholesalers", "direct-to-consumer-retailers"]).optional()}), z.object({sector: z.literal("real-estate-and-property-management"), subSector: z.enum(["brokerages", "property-developers", "management-companies", "investment-vehicles"]).optional()}), z.object({sector: z.literal("high-value-goods-and-luxury-dealers"), subSector: z.enum(["jewelry", "art", "precious-metals", "automobiles", "auction-houses"]).optional()})]); export const kybProfileIndustry = z.union([kybProfileIndustryBase, z.object({sector: z.literal("other"), otherSector: z.string().optional()})]); export const kybProfile = z.object({code: z.literal("profile"), status: kybProcessStatus, input: z.object({legalEntityType: businessLegalEntityType, legalEntityName: z.string().optional(), formationDate: z.string().optional(), industry: kybProfileIndustry.optional(), legalIds: z.array(z.object({type: z.enum(["tax-id", "registration-id"]), id: z.string(), country: z.string()})).optional(), registrationAddress: z.object({country: z.string(), subdivision: z.string().optional(), city: z.string().optional(), line1: z.string().optional(), line2: z.string().optional(), postalCode: z.string().optional()}), operatingAddress: z.object({country: z.string().optional(), subdivision: z.string().optional(), city: z.string().optional(), line1: z.string().optional(), line2: z.string().optional(), postalCode: z.string().optional()})}).optional()}); export const kybAssociatedPersonProfile = z.object({code: z.literal("profile"), status: kybProcessStatus, input: z.discriminatedUnion("type", [z.object({fullName: z.string().optional(), role: z.string().optional(), address: z.object({country: z.string().optional(), subdivision: z.string().optional(), city: z.string().optional(), line1: z.string().optional(), line2: z.string().optional(), postalCode: z.string().optional()}).optional(), birthdate: z.string().optional(), birthplace: z.object({town: z.string(), country: z.string()}).optional(), legalIds: z.array(z.object({type: z.literal("tax-id").optional(), country: z.string(), id: z.string()})).optional(), type: z.literal("beneficial-owner"), ownershipPercentage: z.number().gt(0).lte(100).optional()}), z.object({fullName: z.string().optional(), role: z.string().optional(), address: z.object({country: z.string().optional(), subdivision: z.string().optional(), city: z.string().optional(), line1: z.string().optional(), line2: z.string().optional(), postalCode: z.string().optional()}).optional(), birthdate: z.string().optional(), birthplace: z.object({town: z.string(), country: z.string()}).optional(), legalIds: z.array(z.object({type: z.literal("tax-id").optional(), country: z.string(), id: z.string()})).optional(), type: z.literal("authorized-signer")}), z.object({fullName: z.string().optional(), role: z.string().optional(), address: z.object({country: z.string().optional(), subdivision: z.string().optional(), city: z.string().optional(), line1: z.string().optional(), line2: z.string().optional(), postalCode: z.string().optional()}).optional(), birthdate: z.string().optional(), birthplace: z.object({town: z.string(), country: z.string()}).optional(), legalIds: z.array(z.object({type: z.literal("tax-id").optional(), country: z.string(), id: z.string()})).optional(), type: z.literal("beneficial-owner-and-authorized-signer"), ownershipPercentage: z.number().gt(0).lte(100).optional()})]).optional()}); export const kybAssociatedPersonIdentity = z.discriminatedUnion("type", [z.object({code: z.literal("identity"), status: kybProcessStatus, type: z.literal("none")}), z.object({code: z.literal("identity"), status: kybProcessStatus, type: z.literal("document-submission"), input: z.object({media: z.array(z.object({context: z.enum(["document-front", "document-back"]).optional(), fileId: z.string().optional()})).optional()}).optional(), output: z.object({provider: z.string(), reason: z.enum(["data-mismatch", "document-expired", "document-not-readable", "duplicate", "missing-declared-information", "underage", "timeout", "unknown"]).optional(), document: z.object({type: z.enum(["driving-license", "id-card", "passport", "residence-permit", "unsupported"]), number: z.string(), country: z.string(), expiresAt: z.string().optional()}).optional(), person: z.object({givenName: z.string(), familyName: z.string().optional(), birthdate: z.string(), gender: z.enum(["female", "male"]).optional(), address: z.object({country: z.string(), subdivision: z.string().optional(), city: z.string().optional(), line1: z.string().optional(), line2: z.string().optional(), postalCode: z.string().optional()}).optional()}).optional(), verifiedAt: z.string().optional()}).optional()})]); export const kybAssociatedPersonProofOfAddress = z.discriminatedUnion("type", [z.object({code: z.literal("proof-of-address"), status: kybProcessStatus, type: z.literal("none")}), z.object({code: z.literal("proof-of-address"), status: kybProcessStatus, type: z.literal("document-submission"), input: z.object({media: z.array(z.object({context: z.literal("address-proof").optional(), fileId: z.string().optional()})).optional()}).optional(), output: z.object({provider: z.string(), reason: z.enum(["address-mismatch", "name-mismatch"]).optional(), person: z.object({givenName: z.string(), familyName: z.string().optional(), address: z.object({country: z.string(), subdivision: z.string().optional(), city: z.string().optional(), line1: z.string().optional(), line2: z.string().optional(), postalCode: z.string().optional()})}), verifiedAt: z.string()}).optional()})]); export const kybAssociatedPersonProcesses = z.object({profile: kybAssociatedPersonProfile, identity: kybAssociatedPersonIdentity, proofOfAddress: kybAssociatedPersonProofOfAddress}); export const kybAssociatedPerson = z.object({id: z.string(), processes: kybAssociatedPersonProcesses, createdAt: z.string()}); export const kybAssociatedPersons = z.object({code: z.literal("associated-persons"), status: kybProcessStatus, persons: z.array(kybAssociatedPerson).optional()}); export const kybDocuments = z.object({code: z.literal("documents"), status: kybProcessStatus, input: z.object({incorporation: z.object({fileId: z.string()}).optional(), ownership: z.object({fileId: z.string()}).optional(), control: z.object({fileId: z.string()}).optional(), standing: z.object({fileId: z.string()}).optional(), taxIdentity: z.object({fileId: z.string()}).optional()}).optional()}); export const kybDocument = z.object({fileId: z.string()}); export const kybFinancialInstitution = z.object({code: z.literal("financial-institution"), status: kybProcessStatus, input: z.object({regulatorsAndLicenses: z.string().optional(), moneyTransmitterLicenses: z.string().optional(), compliancePolicies: kybDocument.optional(), amlAudit: kybDocument.optional(), mlroDocumentation: kybDocument.optional()}).optional()}); export const kybAttestationCheckStatus = z.enum(["not-started", "skipped", "in-progress", "in-review", "approved", "rejected"]); export const kybAttestation = z.object({code: z.literal("attestation"), status: kybProcessStatus, output: z.object({checks: z.array(z.union([z.object({code: z.literal("business-online-presence"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()}), z.object({code: z.literal("business-classification"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()}), z.object({code: z.literal("business-registry"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()}), z.object({code: z.literal("business-registrations"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()}), z.object({code: z.literal("business-associated-persons"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()}), z.object({code: z.literal("business-adverse-media"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()}), z.object({code: z.literal("business-address-lookup"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()}), z.object({code: z.literal("business-tin-database"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()}), z.object({code: z.literal("business-screening"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()}), z.object({code: z.literal("business-documents"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()}), z.object({code: z.literal("licensing-verification"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()}), z.object({code: z.literal("associated-persons-screening"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()}), z.object({code: z.literal("associated-persons-address-lookup"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()}), z.object({code: z.literal("associated-persons-tin-database"), status: kybAttestationCheckStatus, reason: z.string().optional(), note: z.string().optional()})]))}).optional()}); export const kybOverview = z.object({summary: z.object({status: z.enum(["blocked", "ok", "pending", "restricted"]), reason: z.string()}), processes: z.object({profile: kybProfile, associatedPersons: kybAssociatedPersons, documents: kybDocuments, financialInstitution: kybFinancialInstitution, attestation: kybAttestation})}); 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 overview * * GET /core/kyb */ export const getApiCoreKyb = async (args: GetApiCoreKybArgs, options?: GetApiCoreKybOptions) => { const {baseUrl = "https://api.enterprise.sandbox.uphold.com", fetch: fetchFn = fetch, OAuth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.detailed != null) query.append("detailed", args.detailed.join(',')) if (args['X-On-Behalf-Of'] != null) headers.set("X-On-Behalf-Of", String(args['X-On-Behalf-Of'])) if (args['X-Uphold-User-Ip'] != null) headers.set("X-Uphold-User-Ip", String(args['X-Uphold-User-Ip'])) if (args['X-Uphold-User-Agent'] != null) headers.set("X-Uphold-User-Agent", String(args['X-Uphold-User-Agent'])) if (args['X-Uphold-User-Origin'] != null) headers.set("X-Uphold-User-Origin", String(args['X-Uphold-User-Origin'])) if (args['X-Uphold-User-Country'] != null) headers.set("X-Uphold-User-Country", String(args['X-Uphold-User-Country'])) if (args['X-Uphold-User-Subdivision'] != null) headers.set("X-Uphold-User-Subdivision", String(args['X-Uphold-User-Subdivision'])) if (args['X-Uphold-User-City'] != null) headers.set("X-Uphold-User-City", String(args['X-Uphold-User-City'])) if (OAuth2 !== undefined) headers.set('authorization', `Bearer ${OAuth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/core/kyb${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(kybOverview, await res.json()) };