nipify/dist/index.d.ts

Fetch Polish company details by NIP (VAT number) from official GUS registry

/**
 * Company details interface representing information fetched from GUS registry
 */
export interface CompanyDetails {
    /** Company name */
    companyName?: string;
    /** City where company is registered */
    city?: string;
    /** Postal code */
    postalCode?: string;
    /** Street name */
    street?: string;
    /** Building number */
    addressOne?: string;
    /** Apartment or office number */
    addressTwo?: string;
}
/**
 * Options for the getCompanyDetailsByNip function
 */
export interface GetCompanyOptions {
    /** API key for the GUS registry service */
    apiKey: string;
    /** Custom API URL (optional) */
    apiUrl?: string;
    /** Whether to use test environment instead of production */
    testMode?: boolean;
    /** CORS proxy URL to use when running in browser environments (e.g., 'https://your-cors-proxy.com/') */
    corsProxy?: string;
}
/**
 * Get company details by NIP (Polish VAT identification number)
 * Fetches company information from the Polish GUS registry (Główny Urząd Statystyczny)
 *
 * @param nip - Polish VAT identification number (10 digits)
 * @param options - Configuration options including API key
 * @returns Promise with company details
 * @throws Error if NIP is missing, API key is missing, or if API requests fail
 */
export declare function getCompanyDetailsByNip(nip: string, options: GetCompanyOptions): Promise<{
    company: CompanyDetails;
}>;
//# sourceMappingURL=index.d.ts.map