import {z} from 'zod' export type IdvUserJourneyId = string; export type ApplicantId = string; export type IdvVerificationStatuses = 'approved' | 'capture_in_progress' | 'checks_in_progress' | 'created' | 'declined' | 'inconclusive' | 'pending' | 'refused' | 'retry_required'; export type IdvResponseCodeCode = number; export type IdvResponseCodeSummary = string; export type IdvResponseCode = {code: IdvResponseCodeCode, summary: IdvResponseCodeSummary}; export type IdvResponseCodes = Array; export type IdvRiskLabel = 'multiple_faces_detected' | 'mcc_not_confident' | 'risky_document_format'; export type IdvRiskLabels = Array; export type IdvCountryCode = unknown; export type IdvGender = 'M' | 'F'; export type IdvIdentity = {full_name: string, first_names?: string | undefined, last_name?: string | undefined, last_name_at_birth?: string | undefined, birth_date: string, birth_place?: string | undefined, nationality?: IdvCountryCode | undefined, gender?: IdvGender | undefined}; export type IdvDiatfCertificationData = {gpg45_profile?: ('M1A' | 'M1C' | 'H1A') | undefined, level_of_confidence?: ('medium' | 'high') | undefined, right_to_work?: string | undefined}; export type IdvCertification = {type?: 'diatf' | undefined, data?: IdvDiatfCertificationData | undefined}; export type IdvCertifications = Array; export type IdvPhonePrefix = string; export type IdvDomesticPhoneNumber = string; export type IdvPhoneNumber = {country_code: IdvPhonePrefix, number: IdvDomesticPhoneNumber}; export type IdvAddress = {address_line1?: string | undefined, address_line2?: string | undefined, city?: string | undefined, state?: string | undefined, zip?: string | undefined, country?: string | undefined}; export type IdvIdentityDeclaredData = {name: string, birth_date?: string | undefined, phone_number?: IdvPhoneNumber | undefined, email?: (string | null) | undefined, address?: IdvAddress | undefined}; export type IdvDocumentTypes = 'Driving licence' | 'ID' | 'Other' | 'Passport' | 'Residence Permit' | 'Travel Document' | 'Visa'; export type IdvPreSignedUrl = string; export type IdvDocument = {full_name: string, first_names?: string | undefined, last_name?: string | undefined, last_name_at_birth?: string | undefined, birth_date: string, birth_place?: string | undefined, nationality?: IdvCountryCode | undefined, gender?: IdvGender | undefined, personal_number?: string | undefined, tax_identification_number?: string | undefined, document_type: IdvDocumentTypes, document_issuing_country: IdvCountryCode, document_number?: string | undefined, document_expiry_date?: string | undefined, document_issue_date?: string | undefined, document_issue_place?: string | undefined, document_mrz?: string | undefined, address?: string | undefined, permit_obtaining_date?: string | undefined, permit_expiry_date?: string | undefined, permit_type_detailed?: string | undefined, permit_type_remarks?: string | undefined, front_image_signed_url: IdvPreSignedUrl, back_image_signed_url?: IdvPreSignedUrl | undefined, signature_image_signed_url?: IdvPreSignedUrl | undefined}; export type IdvDocumentList = Array; export type IdvFace = {image_signed_url: IdvPreSignedUrl}; export type IdvHalLink = {href: string}; export type IdvIdentityVerificationHelperLinks = {self: IdvHalLink, verification_url: IdvHalLink}; export type IdvIdentityVerificationId = string; export type IdvIdentityVerificationHelper = {created_on: string, modified_on: string, user_journey_id?: IdvUserJourneyId | undefined, applicant_id?: ApplicantId | undefined, status: IdvVerificationStatuses, response_codes: IdvResponseCodes, risk_labels: IdvRiskLabels, verified_identity?: IdvIdentity | undefined, certifications?: IdvCertifications | undefined, verification_policy_version?: string | undefined, declared_data: IdvIdentityDeclaredData, documents?: IdvDocumentList | undefined, face?: IdvFace | undefined, redirect_url: string, _links: IdvIdentityVerificationHelperLinks, id: IdvIdentityVerificationId}; export type CreateApiCreateAndOpenIdvArgs = {body: IdvIdentityVerificationHelper}; export type CreateApiCreateAndOpenIdvOptions = {baseUrl: string, OAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const idvUserJourneyId = z.string(); export const applicantId = z.string(); export const idvVerificationStatuses = z.enum(["approved", "capture_in_progress", "checks_in_progress", "created", "declined", "inconclusive", "pending", "refused", "retry_required"]); export const idvResponseCodeCode = z.number().int().gte(10000).lte(69999); export const idvResponseCodeSummary = z.string(); export const idvResponseCode = z.object({code: idvResponseCodeCode, summary: idvResponseCodeSummary}); export const idvResponseCodes = z.array(idvResponseCode); export const idvRiskLabel = z.enum(["multiple_faces_detected", "mcc_not_confident", "risky_document_format"]); export const idvRiskLabels = z.array(idvRiskLabel); export const idvCountryCode = z.string(); export const idvGender = z.enum(["M", "F"]); export const idvIdentity = z.object({full_name: z.string().min(2).max(510), 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(), birth_place: z.string().min(1).max(255).optional(), nationality: idvCountryCode.optional(), gender: idvGender.optional()}); export const idvDiatfCertificationData = z.object({gpg45_profile: z.enum(["M1A", "M1C", "H1A"]).optional(), level_of_confidence: z.enum(["medium", "high"]).optional(), right_to_work: z.string().optional()}); export const idvCertification = z.object({type: z.literal("diatf").optional(), data: idvDiatfCertificationData.optional()}); export const idvCertifications = z.array(idvCertification); export const idvPhonePrefix = z.string(); export const idvDomesticPhoneNumber = z.string(); export const idvPhoneNumber = z.object({country_code: idvPhonePrefix, number: idvDomesticPhoneNumber}); export const idvAddress = z.object({address_line1: z.string().max(250).optional(), address_line2: z.string().max(250).optional(), city: z.string().max(50).optional(), state: z.string().max(50).optional(), zip: z.string().max(50).optional(), country: z.string().max(2).optional()}); export const idvIdentityDeclaredData = z.object({name: z.string().min(2).max(255), birth_date: z.string().optional(), phone_number: idvPhoneNumber.optional(), email: z.string().nullable().optional(), address: idvAddress.optional()}); export const idvDocumentTypes = z.enum(["Driving licence", "ID", "Other", "Passport", "Residence Permit", "Travel Document", "Visa"]); export const idvPreSignedUrl = z.string(); export const idvDocument = z.object({full_name: z.string().min(2).max(510), 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(), birth_place: z.string().min(1).max(255).optional(), nationality: idvCountryCode.optional(), gender: idvGender.optional(), personal_number: z.string().max(255).optional(), tax_identification_number: z.string().max(255).optional(), document_type: idvDocumentTypes, document_issuing_country: idvCountryCode, 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(), address: z.string().max(1000).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(), front_image_signed_url: idvPreSignedUrl, back_image_signed_url: idvPreSignedUrl.optional(), signature_image_signed_url: idvPreSignedUrl.optional()}); export const idvDocumentList = z.array(idvDocument); export const idvFace = z.object({image_signed_url: idvPreSignedUrl}); export const idvHalLink = z.object({href: z.string()}); export const idvIdentityVerificationHelperLinks = z.object({self: idvHalLink, verification_url: idvHalLink}); export const idvIdentityVerificationId = z.string(); export const idvIdentityVerificationHelper = z.object({created_on: z.string(), modified_on: z.string(), user_journey_id: idvUserJourneyId.optional(), applicant_id: applicantId.optional(), status: idvVerificationStatuses, response_codes: idvResponseCodes, risk_labels: idvRiskLabels, verified_identity: idvIdentity.optional(), certifications: idvCertifications.optional(), verification_policy_version: z.string().optional(), declared_data: idvIdentityDeclaredData, documents: idvDocumentList.optional(), face: idvFace.optional(), redirect_url: z.string(), _links: idvIdentityVerificationHelperLinks, id: idvIdentityVerificationId}); 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 an identity verification and attempt * * POST /create-and-open-idv * * Also accepts auth: ApiSecretKey */ export const createApiCreateAndOpenIdv = async (args: CreateApiCreateAndOpenIdvArgs, options: CreateApiCreateAndOpenIdvOptions) => { const {baseUrl, fetch: fetchFn = fetch, OAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (OAuth !== undefined) headers.set('authorization', `Bearer ${OAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/create-and-open-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(idvIdentityVerificationHelper, await res.json()) };