/** * @example * { * phone: "+11234567890", * level: "advanced", * options: { * risk: true, * enhanced_contact_info: { * context: "This is my friend from JZ. He has done a lot in the crypto space." * } * } * } * * @example * { * phone: "+11234567890", * level: "advanced", * options: { * risk: true, * enhanced_contact_info: { * context: "This is my friend from JZ. He has done a lot in the crypto space." * } * } * } */ export interface RetrievePhoneNumberDetailsParams { /** Phone number you want to analyze in E.164 format. */ phone: string; /** * Choose how much detail you want in your results: * - `basic`: Receive essential info like carrier, location, and format. * - `advanced`: Receive a deeper analysis including fraud risk, detailed location, and enhanced contact info. */ level: RetrievePhoneNumberDetailsParams.Level; /** Customize your lookup with additional options. */ options?: RetrievePhoneNumberDetailsParams.Options; } export declare namespace RetrievePhoneNumberDetailsParams { /** * Choose how much detail you want in your results: * - `basic`: Receive essential info like carrier, location, and format. * - `advanced`: Receive a deeper analysis including fraud risk, detailed location, and enhanced contact info. */ const Level: { readonly Basic: "basic"; readonly Advanced: "advanced"; }; type Level = (typeof Level)[keyof typeof Level]; /** * Customize your lookup with additional options. */ interface Options { /** * Allows you to force a fresh lookup from primary sources instead of cached data.
* * Fresh lookups will take longer to complete than cached lookups. */ force?: boolean; /** Include a fraud risk and security analysis. */ risk?: boolean; /** Additional information to tailor lookup. */ enhanced_contact_info?: Options.EnhancedContactInfo; } namespace Options { /** * Additional information to tailor lookup. */ interface EnhancedContactInfo { /** Business context. */ context?: string; } } }