Sachverhalt:
A. Für die wirtschaftlichen Folgen eines Schleudertraumas der Halswirbelsäule, das sie am 4. August 1990 bei einem Auffahrunfall erlitten hatte, erhielt L._ gemäss Verfügung der IV-Stelle des Kantons Zürich vom 24. Mai 1995 rückwirkend ab 1. März 1994 bei einem Invaliditätsgrad von 100 % eine ganze Invalidenrente zugesprochen. Später folgten die Zusatzrente für den Ehegatten und eine Kinderrente. Diese Rentenzusprechungen blieben unangefochten und wurden im Rahmen von Revisionen wiederholt bestätigt. Ab 1. Mai 1996 bezog L._ überdies eine Komplementärrente der Zürich Versicherungs-Gesellschaft, bei welcher sie zum Zeitpunkt der Auffahrkollision gegen Unfälle versichert gewesen war.
Nachdem die Motorfahrzeughaftpflichtversicherung L._ hatte observieren lassen, erstattete sie am 16. März 2000 Strafanzeige wegen Betrugs. Mit Urteil vom 30. März 2006 wurde die Versicherte vom Bezirksgericht des Betruges schuldig gesprochen und zu einer bedingten Gefängnisstrafe von 18 Monaten verurteilt.
Aufgrund der Verurteilung hob die IV-Stelle die ursprünglich zugesprochene ganze Invalidenrente mit Verfügung vom 6. April 2006 wiedererwägungsweise auf und stellte die Ausrichtung der laufenden Rente mit sofortiger Wirkung ein. Mit einer weiteren Verfügung vom 26. April 2006 forderte die IV-Stelle zu Unrecht ausgerichtete Leistungen in der Höhe von Fr. 350'230.- zurück.
Die gegen die beiden Verfügungen erhobenen Einsprachen wies die IV-Stelle mit Entscheid vom 18. August 2006 ab. Mit einer separaten Verfügung (vom 19. September 2006) lehnte die IV-Stelle zudem das Gesuch von L._ um unentgeltliche Verbeiständung im Verwaltungsverfahren ab, weil sie das eingeleitete Einspracheverfahren als aussichtslos qualifizierte.
B. L._ liess gegen den Einspracheentscheid und die Verfügung betreffend Ablehnung der unentgeltlichen Verbeiständung Beschwerde führen. Das Sozialversicherungsgericht des Kantons Zürich vereinigte die beiden Verfahren. Es sistierte den Prozess, bis das Strafurteil mit Ausfällung des Urteils des Bundesgerichts in der Strafsache vom 11. Oktober 2007 rechtskräftig geworden war. Mit Entscheid vom 4. April 2008 wies das Sozialversicherungsgericht die Beschwerden und auch das von der Versicherten gestellte Gesuch um unentgeltliche Prozessführung und Verbeiständung ab.
C. Mit Beschwerde in öffentlich-rechtlichen Angelegenheiten lässt L._ beantragen, der vorinstanzliche Entscheid sei insoweit aufzuheben, als ihr die unentgeltliche Rechtspflege verweigert wurde, und es sei ihr für das vereinigte Beschwerdeverfahren vor dem Sozialversicherungsgericht die unentgeltliche Prozessführung und Verbeiständung zu gewähren. Sodann sei ihr die unentgeltliche Prozessführung und Verbeiständung auch für das Einspracheverfahren zu gewähren. Ferner ersucht sie um die Bewilligung der unentgeltlichen Rechtspflege für das Verfahren vor dem Bundesgericht.
Während die IV-Stelle auf Abweisung der Beschwerde schliesst, verzichtet das Bundesamt für Sozialversicherungen auf eine Vernehmlassung.
Erwägungen:
1. Mit der Beschwerde in öffentlich-rechtlichen Angelegenheiten kann u.a. die Verletzung von Bundesrecht gerügt werden (Art. 95 lit a BGG). Die Feststellung des Sachverhalts kann nur gerügt werden, wenn sie offensichtlich unrichtig ist oder auf einer Rechtsverletzung im Sinne von Art. 95 BGG beruht und wenn die Behebung des Mangels für den Ausgang des Verfahrens entscheidend sein kann (Art. 97 Abs. 1 BGG). Das Bundesgericht legt seinem Urteil den Sachverhalt zu Grunde, den die Vorinstanz festgestellt hat (Art. 105 Abs. 1 BGG). Es kann die Sachverhaltsfeststellung der Vorinstanz von Amtes wegen berichtigen oder ergänzen, wenn sie offensichtlich unrichtig ist oder auf einer Rechtsverletzung im Sinne von Art. 95 BGG beruht (Art. 105 Abs. 2 BGG).
2. Streitig und zu prüfen ist zunächst, ob die Vorinstanz den Anspruch der Versicherten auf unentgeltliche Verbeiständung im Verwaltungsverfahren zu Recht verneint hat.
2.1 Nach dem für das sozialversicherungsrechtliche Verwaltungsverfahren massgebenden Art. 37 Abs. 4 ATSG wird der Gesuch stellenden Person ein unentgeltlicher Rechtsbeistand bewilligt, wo die Verhältnisse es erfordern. Der Gesetzgeber hat die vom Eidgenössischen Versicherungsgericht entwickelte Praxis, wonach im Verwaltungsverfahren an die Voraussetzung der sachlichen Notwendigkeit einer Verbeiständung ein strengerer Massstab anzulegen ist als im kantonalen Gerichtsprozess, übernommen und dadurch zum Ausdruck gebracht, dass im Verwaltungsverfahren der Gesuch stellenden Person ein unentgeltlicher Rechtsbeistand bewilligt wird, wo die Verhältnisse es erfordern (Art. 37 Abs. 4 ATSG), im kantonalen Prozess, wo die Verhältnisse es rechtfertigen (Art. 61 lit. f Satz 2 ATSG; Urteil I 812/05 des Eidgenössischen Versicherungsgerichts vom 24. Januar 2006). Die unentgeltliche Verbeiständung wird praxisgemäss gewährt, wenn der Standpunkt der versicherten Person nicht aussichtslos, diese bedürftig und die anwaltliche Verbeiständung notwendig oder doch geboten ist (BGE 125 V 32 E. 2 S. 34).
2.2 Die Vorinstanz gelangte zum Schluss, die Einsprachen der Versicherten gegen die Verfügungen vom 6. April 2006 betreffend Renteneinstellung und vom 26. April 2006 betreffend Rückforderung seien als aussichtslos zu betrachten, weshalb die unentgeltliche Verbeiständung entfalle. Im Urteil des Bezirksgerichts vom 30. März 2006 sei dargelegt, weshalb die Simulation der Beschwerden als erstellt zu gelten hat. Bei einer sachlichen Betrachtung habe die Beschwerdeführerin zum Schluss gelangen müssen, dass ihr Standpunkt aussichtslos ist.
Die Beschwerdeführerin wendet ein, dass das Bundesgericht im Strafverfahren die unentgeltliche Verbeiständung gewährt habe; dies spreche gegen die Aussichtslosigkeit der von ihr vertretenen Auffassung. Ebenso habe die Zürich Versicherungsgesellschaft im Einspracheentscheid vom 26. Februar 2008 die unentgeltliche Verbeiständung bewilligt.
2.3 Zur Beurteilung der Aussichtslosigkeit ist auf den Zeitpunkt abzustellen, in welchem die Prozesshandlung erfolgt, hier also auf den Zeitpunkt, als die Versicherte ihre Einsprache einreichte (19. Mai 2006). Damals lag erst das Strafurteil des Bezirksgerichts vom 30. März 2006 vor. Zwar trifft es zu, dass damit die wesentlichen Fakten bekannt waren; indessen lag zu diesem Zeitpunkt kein rechtskräftiges Strafurteil vor. Das Bundesgericht wies dann wohl letztinstanzlich mit Urteil vom 11. Oktober 2007 die Beschwerde der Versicherten gegen den Entscheid des Obergerichts des Kantons Zürich vom 10. April 2007, im Wesentlichen lautend auf eine Freiheitsstrafe von zwei Jahren wegen Betrugs, ab, hiess das Gesuch um unentgeltliche Rechtspflege hingegen gut. Nachdem das Bundesgericht im Strafprozess nicht auf Aussichtslosigkeit geschlossen hat, ansonsten es von der Gewährung der unentgeltlichen Rechtspflege abgesehen hätte, ist die nämliche Betrachtungsweise auch für das Verwaltungsverfahren der Invalidenversicherung geboten. Denn wenn die strafrechtliche Abteilung des Bundesgerichts zum Schluss gelangt, der von der Versicherten eingenommene Rechtsstandpunkt sei nicht aussichtslos, und das kantonale Sozialversicherungsgericht rechtsprechungsgemäss (BGE 125 V 237 E. 6a S. 242) auf die strafrechtliche Beurteilung dreier Instanzen abgestellt hat, hätte es auch mit Bezug auf die unentgeltliche Verbeiständung dem bundesgerichtlichen Urteil vom 11. Oktober 2007 folgen und die Beschwerde in diesem Punkt gutheissen müssen.
3. Zu prüfen bleibt der Anspruch der Versicherten auf unentgeltliche Prozessführung und Verbeiständung im kantonalen Beschwerdeverfahren.
3.1 Nach Art. 61 lit. f ATSG muss das Recht, sich verbeiständen zu lassen, gewährleistet sein. Wo die Verhältnisse es rechtfertigen, wird der Beschwerde führenden Person ein unentgeltlicher Rechtsbeistand bewilligt. Die Voraussetzungen für die Bewilligung der unentgeltlichen Prozessführung und Verbeiständung sind praxisgemäss erfüllt, wenn der Prozess nicht aussichtslos, die Partei bedürftig und die anwaltliche Verbeiständung notwendig oder doch geboten ist (BGE 103 V 46 E. II/1b S. 47).
3.2 Die vorstehenden Erwägungen (E. 2.3 hievor) zum Anspruch auf unentgeltliche Verbeiständung im Verwaltungsverfahren gelten erst recht für den Prozess vor dem Sozialversicherungsgericht. Gestützt auf das Urteil der strafrechtlichen Abteilung des Bundesgerichts, die, wie erwähnt, die Aussichtslosigkeit des Rechtsstandpunktes der Versicherten verneint hat, hätte die Vorinstanz, die vollumfänglich auf die Beweiswürdigung und Beurteilung der strafrechtlichen Instanzen abgestellt hat, für das kantonale Verfahren ebenfalls die unentgeltliche Rechtspflege gewähren müssen.
4. Dem Verfahrensausgang entsprechend sind die Gerichtskosten der unterliegenden IV-Stelle aufzuerlegen (Art. 66 Abs. 1 BGG), welche der Beschwerdeführerin überdies eine Parteientschädigung zu bezahlen hat (Art. 68 Abs. 1 und 2 BGG). Das Gesuch um unentgeltliche Rechtspflege ist damit gegenstandslos.
Demnach erkennt das Bundesgericht:
1. In Gutheissung der Beschwerde werden der Entscheid des Sozialversicherungsgerichts des Kantons Zürich vom 4. April 2008, soweit er den Anspruch der Beschwerdeführerin auf unentgeltliche Rechtspflege im Verwaltungsverfahren und im kantonalen Beschwerdeverfahren zum Gegenstand hat, sowie die Verfügung der IV-Stelle des Kantons Zürich vom 19. September 2006 aufgehoben. Es wird festgestellt, dass die Beschwerdeführerin Anspruch auf unentgeltliche Rechtspflege im Verwaltungsverfahren und im kantonalen Beschwerdeverfahren hat. Die Sache wird an das Sozialversicherungsgericht des Kantons Zürich zurückgewiesen, damit es die Entschädigung des unentgeltlichen Rechtsvertreters für die beiden Verfahren festsetze.
2. Die Gerichtskosten von Fr. 500.- werden der IV-Stelle des Kantons Zürich auferlegt.
3. Die IV-Stelle des Kantons Zürich hat die Beschwerdeführerin für das bundesgerichtliche Verfahren mit Fr. 2000.- zu entschädigen.
4. Dieses Urteil wird den Parteien, dem Sozialversicherungsgericht des Kantons Zürich und dem Bundesamt für Sozialversicherungen schriftlich mitgeteilt.
Luzern, 29. August 2008
Im Namen der II. sozialrechtlichen Abteilung
des Schweizerischen Bundesgerichts
Der Präsident: Der Gerichtsschreiber:
Meyer Widmer