import {z} from 'zod' export type UserJourneyId = string; export type ApplicantId = string; export type DeclaredData = {name: string, birth_date?: string | undefined}; export type IdentityVerificationBase = {user_journey_id?: UserJourneyId | undefined, applicant_id?: ApplicantId | undefined, declared_data?: DeclaredData | undefined, webhook_url?: string | undefined}; export type IdentityVerificationInputHelper = IdentityVerificationBase; export type CreateApiV2CreateAndStartIdvArgs = {body: IdentityVerificationInputHelper}; export type CreateApiV2CreateAndStartIdvOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const identityVerificationId = z.string(); export const declaredData = z.object({name: z.string().min(2).max(255), birth_date: z.string().optional()}); export const phonePrefix = z.string(); export const domesticPhoneNumber = z.string(); export const phoneNumber = z.object({country_code: phonePrefix, number: domesticPhoneNumber}); export const halLink = z.object({href: z.string()}); export const identityVerificationHelperLinks = z.object({self: halLink, applicant: halLink, verification_url: halLink}); export const verificationStatuses = z.enum(["created", "pending", "capture_in_progress", "checks_in_progress", "approved", "declined", "retry_required", "refused", "inconclusive"]); export const responseCode = z.number().int().gte(10000).lte(69999); export const responseSummary = z.string(); export const responseCodes = z.object({code: responseCode, summary: responseSummary}); export const verificationIdentity = z.object({first_names: z.string().nullable().optional(), full_name: z.string().nullable().optional(), last_name: z.string().nullable().optional(), last_name_at_birth: z.string().nullable().optional(), birth_date: z.string().nullable().optional(), birth_place: z.string().max(255).nullable().optional(), nationality: z.string().optional(), gender: z.union([z.enum(["M", "F", "NA"]), z.literal(""), z.string()]).nullable().optional()}); export const documentTypes = z.enum(["Driving licence", "ID", "Other", "Passport", "Residence Permit", "Travel Document", "Visa"]); export const countryCodeIso2 = z.string(); export const preSignedUrl = z.string(); export const gender = z.enum(["M", "F"]); export const document = z.object({personal_number: z.string().max(255).optional(), tax_identification_number: z.string().max(255).optional(), document_type: documentTypes.optional(), document_issuing_country: countryCodeIso2.optional(), permit_obtaining_date: z.string().optional(), permit_expiry_date: z.string().optional(), permit_type_detailed: z.string().max(255).optional(), permit_type_remarks: z.string().max(255).optional(), document_number: z.string().max(255).optional(), document_expiry_date: z.string().optional(), document_issue_date: z.string().optional(), document_issue_place: z.string().max(255).optional(), document_mrz: z.string().optional(), front_image_signed_url: preSignedUrl.optional(), back_image_signed_url: preSignedUrl.optional(), signature_image_signed_url: preSignedUrl.optional(), full_name: z.string().min(2).max(510).optional(), first_names: z.string().min(1).max(255).optional(), last_name: z.string().min(1).max(255).optional(), last_name_at_birth: z.string().min(1).max(255).optional(), birth_date: z.string().optional(), birth_place: z.string().min(1).max(255).optional(), nationality: countryCodeIso2.optional(), gender: gender.optional(), address: z.string().max(1000).optional()}); export const verificationFace = z.object({image_signed_url: z.string().nullable().optional()}); export const riskLabel = z.enum(["multiple_faces_detected", "mcc_not_confident", "risky_document_format", "no_uk_footprint"]); export const riskLabels = z.array(riskLabel); export const userJourneyId = z.string(); export const applicantId = z.string(); export const identityVerificationOutputHelper = z.object({id: identityVerificationId, declared_data: declaredData, redirect_url: z.string(), phone_number: phoneNumber.optional(), _links: identityVerificationHelperLinks, created_on: z.string(), modified_on: z.string(), status: verificationStatuses, response_codes: z.array(responseCodes), verified_identity: verificationIdentity.optional(), documents: z.array(document).optional(), face: verificationFace.optional(), verification_policy_version: z.string().optional(), certifications: z.array(z.object({type: z.literal("diatf").optional(), data: z.object({gpg45_profile: z.enum(["M1A", "M1C", "H1A"]).optional(), level_of_confidence: z.enum(["medium", "high"]).optional(), right_to_work: z.string().nullable().optional()}).optional()})), risk_labels: riskLabels, user_journey_id: userJourneyId, applicant_id: applicantId, webhook_url: z.string()}); 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 and start an identity verification * * POST /v2/create-and-start-idv */ export const createApiV2CreateAndStartIdv = async (args: CreateApiV2CreateAndStartIdvArgs, options?: CreateApiV2CreateAndStartIdvOptions) => { const {baseUrl = "https://api.ubble.ai", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") const url = `${baseUrl.replace(/\/+$/, '')}/v2/create-and-start-idv${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(identityVerificationOutputHelper, await res.json()) };