import {z} from 'zod' export type GetApiResultsArgs = {limit?: number | undefined, cursor?: string | undefined, summary?: boolean | undefined, q?: string | undefined, status?: ('potential_match' | 'no_match') | undefined, review?: ('open' | 'confirmed' | 'dismissed' | 'unreviewed') | undefined, origin?: ('manual' | 'api' | 'batch' | 'monitor' | 'unknown') | undefined}; export type GetApiResultsOptions = {baseUrl: string, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const sourceProvenance = z.object({sourceId: z.string(), recordId: z.string(), field: z.string(), rawValue: z.string().optional()}); export const sourceRecord = z.object({id: z.string(), sourceId: z.string(), authority: z.string(), list: z.string(), sourceUrl: z.string(), entityType: z.enum(["person", "organization", "vessel", "aircraft", "other"]), names: z.array(z.object({value: z.string(), kind: z.enum(["primary", "alias"]), quality: z.enum(["strong", "weak", "unknown"]).optional(), script: z.string().optional(), provenance: sourceProvenance.optional()})), identifiers: z.array(z.object({type: z.string(), value: z.string(), issuer: z.string().optional(), provenance: sourceProvenance.optional()})), birthDates: z.array(z.object({value: z.string(), precision: z.enum(["day", "month", "year", "range", "unknown"]), original: z.string()})), addresses: z.array(z.object({text: z.string().optional(), country: z.string().optional(), provenance: sourceProvenance.optional()})), nationalities: z.array(z.string()), designations: z.array(z.object({category: z.enum(["financial_sanctions", "export_control", "debarment", "other"]), programs: z.array(z.string()), legalReferences: z.array(z.string()), wording: z.string().optional(), effectiveDate: z.string().optional()})), dataThrough: z.string().optional(), screeningPeriods: z.array(z.object({from: z.string().optional(), through: z.string().optional()})).optional(), publicContext: z.array(z.object({label: z.string().max(100), value: z.string().max(2000)})).optional(), extensions: z.record(z.string(), z.unknown())}); export const matchAssessment = z.object({name: z.object({similarity: z.number().int().gte(0).lte(100), method: z.string(), aliasKind: z.enum(["primary", "alias"]), aliasQuality: z.enum(["strong", "weak", "unknown"])}).nullable(), identifiers: z.object({status: z.enum(["agreement", "conflict", "not_supplied", "unavailable", "not_comparable"]), matched: z.number().int().gte(0).lte(9007199254740991), issuerAgreements: z.number().int().gte(0).lte(9007199254740991), issuerUnknown: z.number().int().gte(0).lte(9007199254740991), conflicts: z.number().int().gte(0).lte(9007199254740991)}), birthDate: z.object({status: z.enum(["agreement", "conflict", "not_supplied", "unavailable", "not_comparable"]), precision: z.enum(["year", "month", "day"]).optional()}), country: z.object({status: z.enum(["agreement", "conflict", "not_supplied", "unavailable", "not_comparable"])}), entityType: z.object({status: z.enum(["agreement", "conflict", "not_supplied", "unavailable", "not_comparable"])}), reviewTier: z.enum(["identifier", "corroborated", "conflicting", "name_only"]), alertBasis: z.enum(["identifier", "name", "name_and_birth_date", "partial_name"]), hasConflicts: z.boolean(), sameNameCandidates: z.number().int().gte(0).lte(9007199254740991)}); export const sourceNotice = z.object({text: z.string(), sourceUrl: z.string(), termsUrl: z.string(), licenseUrl: z.string().optional(), databaseDownloadUrl: z.string().optional()}); export const coverage = z.object({sourceId: z.string(), version: z.string(), retrievedAt: z.string(), publishedAt: z.union([z.string(), z.string()]).optional(), fresh: z.boolean(), sourceNotice: sourceNotice.optional()}); export const screeningPolicySnapshot = z.object({name: z.string().min(2).max(120), purpose: z.string().min(3).max(1000), jurisdictions: z.array(z.string().min(2).max(100)), matching: z.object({profile: z.enum(["standard", "focused"]), partialNames: z.enum(["review", "exclude"]).optional()}).optional(), requiredSources: z.record(z.string(), z.array(z.string().min(1).max(80))), optionalSources: z.record(z.string(), z.array(z.string().min(1).max(80))), exclusions: z.array(z.string().min(3).max(500)), externalChecks: z.array(z.string().min(3).max(200)), externalCheckGuidance: z.array(z.object({label: z.string().min(3).max(200), instructions: z.string().min(3).max(2000), evidenceExample: z.string().min(3).max(1000).optional()})).optional(), review: z.object({requireSecondReview: z.boolean().optional(), secondReviewFor: z.array(z.enum(["same_identity", "allow", "restrict", "escalate"])).optional(), approverRoles: z.array(z.enum(["owner", "admin", "analyst"])).optional()}), monitoringIntervalHours: z.union([z.literal(6), z.literal(24), z.literal(168)]), retentionTrigger: z.enum(["review_completed", "relationship_ended", "business_event"]), id: z.string(), version: z.number().int().gte(0), environment: z.enum(["sandbox", "production"]), createdAt: z.string()}); export const appliedMatchingPolicy = z.object({version: z.string(), profile: z.enum(["standard", "focused"]), nameThreshold: z.number().int().gte(0).lte(100), corroboratedNameThreshold: z.number().int().gte(0).lte(100), retrievalVersion: z.string(), partialNames: z.enum(["review", "exclude"]).optional()}); export const screeningResult = z.object({id: z.string(), environment: z.enum(["sandbox", "production"]), status: z.enum(["potential_match", "no_match"]), createdAt: z.string(), matches: z.array(z.object({record: sourceRecord, score: z.number().gte(0).lte(100), assessment: matchAssessment.optional(), evidence: z.array(z.object({field: z.string(), queryValue: z.string(), sourceValue: z.string(), method: z.string(), contribution: z.number(), explanation: z.string()})), conflicts: z.array(z.string())})), coverage: z.array(coverage), versions: z.object({dataset: z.string(), matchingEngine: z.string(), policy: z.string(), package: z.string().optional()}), disclaimer: z.string(), policySnapshot: screeningPolicySnapshot.optional(), matching: appliedMatchingPolicy.optional(), warnings: z.array(z.object({code: z.literal("limited_name_information"), message: z.string()})).optional()}); export const screeningSummary = z.object({id: z.string(), status: z.enum(["potential_match", "no_match"]), createdAt: z.string(), subjectName: z.string().nullable(), entityType: z.string().nullable(), retention: z.enum(["standard", "minimal"]), expiresAt: z.string().nullable(), origin: z.string(), caseId: z.string().nullable(), reviewDecision: z.enum(["open", "confirmed", "dismissed"]).nullable(), reviewBusinessDisposition: z.enum(["pending", "allow", "restrict", "escalate"]).nullable(), matchCount: z.number().int().gte(0), batchId: z.string().nullable(), monitorId: z.string().nullable()}); export const resultsPage = z.union([z.object({items: z.array(screeningResult), nextCursor: z.string().nullable()}), z.object({items: z.array(screeningSummary), nextCursor: z.string().nullable()})]); export const getApiResultsResponse = z.object({data: resultsPage}); 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 }; /** * List retained results * * GET /results */ export const getApiResults = async (args: GetApiResultsArgs, options: GetApiResultsOptions) => { const {baseUrl, fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.limit != null) query.append("limit", String(args.limit)) if (args.cursor != null) query.append("cursor", String(args.cursor)) if (args.summary != null) query.append("summary", String(args.summary)) if (args.q != null) query.append("q", String(args.q)) if (args.status != null) query.append("status", String(args.status)) if (args.review != null) query.append("review", String(args.review)) if (args.origin != null) query.append("origin", String(args.origin)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/results${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(getApiResultsResponse, await res.json()) };