import {z} from 'zod' export type StringNoEdgeSpaces = string; export type CountryCodeForRequest = string; export type SubdivisionCodeForRequest = string; export type VeriffIngestionProcess = 'profile' | 'address' | 'identity' | 'proof-of-address'; export type VeriffSessionForRequest = {processes?: Array | undefined, sessionId: string, integrationName: string}; export type CreateApiKycConnectorVeriffIngestionsArgs = {'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, body: {processes?: Array | undefined, sessions: Array}}; export type CreateApiKycConnectorVeriffIngestionsOptions = {baseUrl?: string | undefined, OAuth2?: string | undefined, fetch?: typeof fetch | undefined}; export const veriffIngestionProcess = z.enum(["profile", "address", "identity", "proof-of-address"]); export const veriffSession = z.object({processes: z.array(veriffIngestionProcess), sessionId: z.string(), integrationName: z.string()}); export const ingestionResultProcessStatus = z.enum(["processing", "completed", "failed"]); export const ingestionResultProfileData = z.object({fullName: z.string().optional(), birthdate: z.string().optional(), birthplace: z.object({town: z.string().optional(), country: z.string().optional()}).optional(), primaryCitizenship: z.string().optional()}); export const veriffIngestionResultProcessError = z.object({code: z.enum(["unknown_error", "workflow_error", "provider_data_readiness_timeout_exceeded", "provider_data_not_available", "provider_data_invalid", "provider_data_recheck_failed", "provider_file_download_failed", "dependent_process_failed", "operation_not_allowed", "veriff_client_error", "veriff_session_not_approved"]).optional(), message: z.string().optional(), hint: z.string().optional(), step: z.enum(["fetch-provider-data", "download-provider-files", "update-kyc-process"]).optional(), details: z.record(z.string(), z.unknown()).optional()}); export const ingestionResultAddressData = 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()}); export const 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()}); export const ingestionResultIdentityData = z.object({document: z.object({type: z.enum(["driving-license", "id-card", "passport", "residence-permit", "unsupported"]).optional(), number: z.string().optional(), country: z.string().optional(), expiresAt: z.string().optional()}).optional(), person: z.object({givenName: z.string().optional(), familyName: z.string().optional(), address: address.optional(), birthdate: z.string().optional(), gender: z.enum(["female", "male"]).optional()}).optional(), verifiedAt: z.string().optional()}); export const ingestionResultProcessFiles = z.array(z.object({id: z.string().optional(), category: z.enum(["document", "image", "video"]).optional(), context: z.string().optional(), contentType: z.string().optional(), size: z.number().int().gte(0).optional(), providerDetails: z.record(z.string(), z.unknown()).optional()})); export const ingestionResultProofOfAddressData = z.object({person: z.object({givenName: z.string().optional(), familyName: z.string().optional(), address: address.optional()}).optional(), verifiedAt: z.string().optional()}); export const veriffIngestion = z.object({id: z.string(), userId: z.string(), status: z.enum(["queued", "running", "finished"]), processes: z.array(z.enum(["profile", "address", "identity", "proof-of-address"])), provider: z.string(), parameters: z.object({sessions: z.array(veriffSession)}), result: z.object({profile: z.object({status: ingestionResultProcessStatus, data: ingestionResultProfileData.optional(), error: veriffIngestionResultProcessError.optional()}).optional(), address: z.object({status: ingestionResultProcessStatus, data: ingestionResultAddressData.optional(), error: veriffIngestionResultProcessError.optional()}).optional(), identity: z.object({status: ingestionResultProcessStatus, data: ingestionResultIdentityData.optional(), files: ingestionResultProcessFiles.optional(), error: veriffIngestionResultProcessError.optional()}).optional(), proofOfAddress: z.object({status: ingestionResultProcessStatus, data: ingestionResultProofOfAddressData.optional(), files: ingestionResultProcessFiles.optional(), error: veriffIngestionResultProcessError.optional()}).optional()}).optional(), createdAt: z.string(), updatedAt: z.string(), startedAt: z.string().optional(), finishedAt: z.string().optional()}); export const createApiKycConnectorVeriffIngestionsResponse = z.object({ingestion: veriffIngestion}); 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 }; /** * Create Veriff ingestion * * POST /kyc-connector/veriff/ingestions */ export const createApiKycConnectorVeriffIngestions = async (args: CreateApiKycConnectorVeriffIngestionsArgs, options?: CreateApiKycConnectorVeriffIngestionsOptions) => { const {baseUrl = "https://api.enterprise.sandbox.uphold.com", fetch: fetchFn = fetch, OAuth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") 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(/\/+$/, '')}/kyc-connector/veriff/ingestions${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(createApiKycConnectorVeriffIngestionsResponse, await res.json()) };