import {z} from 'zod' export type StringNoEdgeSpaces = string; export type CountryCodeForRequest = string; export type SubdivisionCodeForRequest = string; export type GetApiCoreKycArgs = {detailed?: (Array<'profile' | 'address' | 'email' | 'phone' | 'identity' | 'proofOfAddress' | 'customerDueDiligence' | 'enhancedDueDiligence' | 'cryptoRiskAssessment' | 'selfCategorizationStatement' | 'taxDetails' | 'screening' | 'risk'>) | undefined, 'Accept-Language'?: string | 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 GetApiCoreKycOptions = {baseUrl?: string | undefined, OAuth2?: string | undefined, fetch?: typeof fetch | undefined}; export const kycProcessStatus = z.enum(["ok", "failed", "running", "pending", "exempt"]); export const kycProcessDependencies = z.array(z.enum(["profile", "email", "phone", "identity", "proof-of-address", "customer-due-diligence", "enhanced-due-diligence", "crypto-risk-assessment", "self-categorization-statement", "tax-details"])); export const processVerificationRule = z.object({presence: z.enum(["required", "optional", "disallowed"]), editable: z.boolean()}); export const kycProcessHintForm = z.object({type: z.literal("form"), formId: z.string().optional(), schema: z.record(z.string(), z.unknown()), uiSchema: z.record(z.string(), z.unknown())}); export const kycProfile = z.object({code: z.string(), status: kycProcessStatus, verification: z.object({model: z.enum(["none", "partner-verified", "uphold-verified"]), method: z.enum(["automatic", "manual"]), triggers: z.array(z.enum(["profile", "identity"])).optional(), dependencies: kycProcessDependencies, rules: z.object({fullName: processVerificationRule.optional(), birthdate: processVerificationRule.optional(), birthplace: z.object({presence: z.enum(["required", "optional", "disallowed"]), editable: z.boolean(), rules: z.object({country: processVerificationRule.optional(), town: processVerificationRule.optional()}).optional()}).optional(), citizenshipCountry: processVerificationRule.optional(), primaryCitizenship: processVerificationRule.optional(), otherCitizenships: processVerificationRule.optional(), address: z.object({presence: z.enum(["required", "optional", "disallowed"]), editable: z.boolean(), rules: z.object({subdivision: processVerificationRule.optional(), city: processVerificationRule.optional(), line1: processVerificationRule.optional(), line2: processVerificationRule.optional(), postalCode: processVerificationRule.optional()}).optional()}).optional()}).optional()}).optional(), input: z.object({fullName: z.string().optional(), birthdate: z.string().optional(), birthplace: z.object({country: z.string(), town: z.string()}).optional(), primaryCitizenship: z.string().optional(), citizenshipCountry: z.string().optional(), otherCitizenships: z.array(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()}).optional(), details: z.record(z.string(), z.unknown()).optional()}).optional(), hint: kycProcessHintForm.optional()}); export const kycProcessVerification = z.object({model: z.enum(["none", "partner-verified", "uphold-verified"]), method: z.enum(["automatic", "manual"]), triggers: z.array(z.enum(["profile", "identity"])).optional(), dependencies: kycProcessDependencies}); export const kycAddress = z.object({code: z.string(), status: kycProcessStatus, verification: kycProcessVerification.optional(), input: z.object({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()}); export const kycEmail = z.object({code: z.string(), status: kycProcessStatus, verification: kycProcessVerification.optional(), input: z.object({email: z.string()}).optional(), output: z.object({verifiedAt: z.string()}).optional()}); export const kycPhone = z.object({code: z.string(), status: kycProcessStatus, verification: kycProcessVerification.optional(), input: z.object({phone: z.string(), country: z.string()}).optional(), output: z.object({verifiedAt: z.string()}).optional()}); export const kycIdentityNone = z.object({code: z.string(), status: kycProcessStatus, type: z.literal("none").optional(), verification: z.object({model: z.enum(["none", "partner-verified", "uphold-verified"]), method: z.enum(["automatic", "manual"]), triggers: z.array(z.enum(["profile", "identity"])).optional(), dependencies: kycProcessDependencies, submittable: z.boolean()}).optional()}); export const kycIdentityDocumentSubmission = z.object({code: z.string(), status: kycProcessStatus, type: z.literal("document-submission"), verification: z.object({model: z.enum(["none", "partner-verified", "uphold-verified"]), method: z.enum(["automatic", "manual"]), triggers: z.array(z.enum(["profile", "identity"])).optional(), dependencies: kycProcessDependencies, submittable: z.boolean()}).optional(), input: z.object({media: z.array(z.object({context: z.enum(["photo-document-front", "photo-document-back", "photo-selfie", "photo-selfie-and-document-front", "video"]), fileId: z.string()}))}).optional(), output: z.object({provider: z.string(), providerDetails: z.object({reasons: z.array(z.string()).optional()}).optional(), reason: z.enum(["data-mismatch", "duplicate", "underage", "provider-verification-rejected"]).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()}), 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()}), verifiedAt: z.string()}).optional()}); export const kycIdentityElectronicVerification = z.object({code: z.string(), status: kycProcessStatus, type: z.literal("electronic-verification"), verification: z.object({model: z.enum(["none", "partner-verified", "uphold-verified"]), method: z.enum(["automatic", "manual"]), triggers: z.array(z.enum(["profile", "identity"])).optional(), dependencies: kycProcessDependencies, submittable: z.boolean()}).optional(), input: z.object({data: z.object({givenName: z.string(), familyName: z.string().optional(), birthdate: z.string(), citizenshipCountry: 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(), output: z.object({provider: z.string(), reason: z.enum(["data-mismatch", "duplicate", "missing-declared-information", "underage"]).optional(), verifiedAt: z.string()}).optional()}); export const kycIdentity = z.discriminatedUnion("type", [kycIdentityNone, kycIdentityDocumentSubmission, kycIdentityElectronicVerification]); export const kycProofOfAddressNone = z.object({code: z.string(), status: kycProcessStatus, type: z.literal("none").optional(), verification: z.object({model: z.enum(["none", "partner-verified", "uphold-verified"]), method: z.enum(["automatic", "manual"]), triggers: z.array(z.enum(["profile", "identity"])).optional(), dependencies: kycProcessDependencies, submittable: z.boolean()}).optional()}); export const kycProofOfAddressDocumentSubmission = z.object({code: z.string(), status: kycProcessStatus, type: z.literal("document-submission"), verification: z.object({model: z.enum(["none", "partner-verified", "uphold-verified"]), method: z.enum(["automatic", "manual"]), triggers: z.array(z.enum(["profile", "identity"])).optional(), dependencies: kycProcessDependencies, submittable: z.boolean()}).optional(), input: z.object({media: z.array(z.object({context: z.literal("address-proof"), fileId: z.string()}))}).optional(), output: z.object({provider: z.string(), providerDetails: z.object({reasons: z.array(z.string()).optional()}).optional(), reason: z.enum(["address-mismatch", "name-mismatch", "provider-verification-rejected"]).optional(), person: z.object({givenName: z.string().optional(), familyName: 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()}).optional(), verifiedAt: z.string()}).optional()}); export const kycProofOfAddressElectronicVerification = z.object({code: z.string(), status: kycProcessStatus, type: z.literal("electronic-verification"), verification: z.object({model: z.enum(["none", "partner-verified", "uphold-verified"]), method: z.enum(["automatic", "manual"]), triggers: z.array(z.enum(["profile", "identity"])).optional(), dependencies: kycProcessDependencies, submittable: z.boolean()}).optional(), input: z.object({data: 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()})})}).optional(), output: z.object({provider: z.string(), reason: z.enum(["address-mismatch", "name-mismatch"]).optional(), verifiedAt: z.string()}).optional()}); export const kycProofOfAddressFromIdentity = z.object({code: z.string(), status: kycProcessStatus, type: z.literal("from-identity"), verification: z.object({model: z.enum(["none", "partner-verified", "uphold-verified"]), method: z.enum(["automatic", "manual"]), triggers: z.array(z.enum(["profile", "identity"])).optional(), dependencies: kycProcessDependencies, submittable: z.boolean()}).optional(), output: z.object({provider: z.string(), reason: z.enum(["address-mismatch", "name-mismatch"]).optional(), person: z.object({givenName: z.string().optional(), familyName: 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()}).optional(), verifiedAt: z.string()}).optional()}); export const kycProofOfAddress = z.discriminatedUnion("type", [kycProofOfAddressNone, kycProofOfAddressDocumentSubmission, kycProofOfAddressElectronicVerification, kycProofOfAddressFromIdentity]); export const kycProcessInputForm = z.object({formId: z.string().optional(), answers: z.record(z.string(), z.unknown())}); export const kycCustomerDueDiligence = z.object({code: z.string(), status: kycProcessStatus, verification: kycProcessVerification.optional(), input: kycProcessInputForm.optional(), output: z.object({score: z.enum(["low", "medium", "high"]).optional(), expiresAt: z.string().optional(), verifiedAt: z.string().optional()}).optional(), hint: kycProcessHintForm.optional()}); export const kycEnhancedDueDiligence = z.object({code: z.string(), status: kycProcessStatus, verification: kycProcessVerification.optional(), input: z.object({media: z.array(z.object({context: z.literal("source-of-funds-proof"), fileId: z.string()})).optional()}).optional(), output: z.object({verifiedAt: z.string()}).optional()}); export const kycCryptoRiskAssessment = z.object({code: z.string(), status: kycProcessStatus, verification: kycProcessVerification.optional(), input: kycProcessInputForm.optional(), output: z.object({result: z.enum(["approved", "rejected"]), attempts: z.object({used: z.number().int(), maximum: z.number().int(), retryAt: z.string().optional()}), offboard: z.object({completedAt: z.string().optional(), endsAt: z.string()}).optional(), verifiedAt: z.string().optional()}).optional(), hint: kycProcessHintForm.optional()}); export const kycSelfCategorizationStatement = z.object({code: z.string(), status: kycProcessStatus, verification: kycProcessVerification.optional(), input: kycProcessInputForm.optional(), output: z.object({result: z.enum(["approved", "rejected"]), attempts: z.object({used: z.number().int(), maximum: z.number().int()}).optional(), offboard: z.object({completedAt: z.string().optional(), endsAt: z.string()}).optional(), expiresAt: z.string().optional(), verifiedAt: z.string().optional()}).optional(), hint: kycProcessHintForm.optional()}); export const kycTaxDetails = z.object({code: z.string(), status: kycProcessStatus, verification: kycProcessVerification.optional(), input: z.record(z.string(), z.unknown()).optional(), output: z.object({result: z.enum(["approved", "rejected"]), verifiedAt: z.string()}).optional(), hint: kycProcessHintForm.optional()}); export const kycScreening = z.object({code: z.string(), status: kycProcessStatus, verification: kycProcessVerification.optional(), output: z.object({result: z.enum(["approved", "rejected"])}).optional()}); export const kycRisk = z.object({code: z.string(), status: kycProcessStatus, verification: kycProcessVerification.optional(), output: z.object({result: z.enum(["approved", "rejected"]).optional()}).optional()}); export const kycOverview = z.object({summary: z.object({status: z.enum(["blocked", "ok", "pending", "restricted"]), reason: z.string()}), processes: z.object({profile: kycProfile, address: kycAddress, email: kycEmail, phone: kycPhone, identity: kycIdentity, proofOfAddress: kycProofOfAddress, customerDueDiligence: kycCustomerDueDiligence, enhancedDueDiligence: kycEnhancedDueDiligence, cryptoRiskAssessment: kycCryptoRiskAssessment, selfCategorizationStatement: kycSelfCategorizationStatement, taxDetails: kycTaxDetails, screening: kycScreening, risk: kycRisk})}); 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/kyc */ export const getApiCoreKyc = async (args: GetApiCoreKycArgs, options?: GetApiCoreKycOptions) => { 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['Accept-Language'] != null) headers.set("Accept-Language", String(args['Accept-Language'])) 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/kyc${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(kycOverview, await res.json()) };