White labeling

Overview

In case you are interested in customizing the Web Form based on your branding, this section will assist you in making it happen.

We are pleased to offer a dedicated API to customers for styling the Web Form as per the branding needs and the business case.

Remember to use the Admin Client credentials to manage the profiles service.
Use the endpoint to create a profile with a profile ID.
A profile is a style template that will be applied to the Web Forms generated for your end-users.
- You can set up a default profile. Unless otherwise overridden, this profile will be applied to all your Web Forms.
- Create multiple profiles, if needed. You can apply a specific profileId explicitly on each API call. This will override any default profile if any exists.
White labeling is now available to customers who plan to use either standalone Web Forms or embedded Web Forms.

Usage

Think about your branding before triggering the endpoint.

Which color in the large palette represents your brand?
Which colors should the text appear in? There are 2 possible placeholders for 2 colors!
It is important to think about these prior to triggering the endpoint.

Defaults

By default, the finAPI profile will be applied. The below snippet shows the values finAPI will apply in case no profile is defined.

In case you do not define all values (incomplete values), when rendering the Web Form, your profile will be merged with the finAPI default values to generate a complete profile.

JSON

{
  "label": "Mobile application label",
  "default": true,
  "brand": {
    "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAH4SURBVDhPjZNNSxtRFIazcFHBZuMmUFCqILh358Jl6bJ/QJNAm05UlGKwdNHqSgpdtQs33WltKXSh6E9wpfhBoe6sM5M4McFMEp3YmsS351yPDHXujD4wMOfMvQ/v/ZgY7kH9so1Gsy1VNHcK3T8t9K1YGPhm4+zySrrhRAorJOv9YmFh18X8dgX9JK7/jU4aKuRkPSzbqUoHeLdVwWOSntEWhKEV8oRHyybJXOn4vCUpp75o6ZcfELq0JJ7wfs9Pdps5Wn7fio1zTdKAcGTtGMOrBanCGfqRx5ONolQ+AeGx11QJP/2sSQcwTROO40gFfNivqoTli5Z0fLR7WPRaSCyZWDxs49QpIBaLqade+I2PBw21v6d0aDq0QqZMz+T6LyWaez2DWSONrmfTGN6kQ4u4jqFCJ28r2dPnr/CdDvuzDQyuuuiId1PqvIwKohValqVkb2ZzOKe6l+5e/1cbTXqfMjLqW6lUUmNvExCaR0dqQi6Xk871np40/D0bn5hQY4rFe5zyw3gcDzo7pQqHhYlEQiqfgLBMS+HB2WxWOkFS6bQaU6v5V+sG7R5WXFdNeJHJSMdndGxMffM8Tzr/oxUyJ5L0pWFIB0gmk9fJquG/ZaiQ4U1ngUHLT6ZS6t2l9FFEChm+HizipxqR7IY7hQyn0h1AEOAfAearr/m9PjoAAAAASUVORK5CYII=",
    "favicon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAH4SURBVDhPjZNNSxtRFIazcFHBZuMmUFCqILh358Jl6bJ/QJNAm05UlGKwdNHqSgpdtQs33WltKXSh6E9wpfhBoe6sM5M4McFMEp3YmsS351yPDHXujD4wMOfMvQ/v/ZgY7kH9so1Gsy1VNHcK3T8t9K1YGPhm4+zySrrhRAorJOv9YmFh18X8dgX9JK7/jU4aKuRkPSzbqUoHeLdVwWOSntEWhKEV8oRHyybJXOn4vCUpp75o6ZcfELq0JJ7wfs9Pdps5Wn7fio1zTdKAcGTtGMOrBanCGfqRx5ONolQ+AeGx11QJP/2sSQcwTROO40gFfNivqoTli5Z0fLR7WPRaSCyZWDxs49QpIBaLqade+I2PBw21v6d0aDq0QqZMz+T6LyWaez2DWSONrmfTGN6kQ4u4jqFCJ28r2dPnr/CdDvuzDQyuuuiId1PqvIwKohValqVkb2ZzOKe6l+5e/1cbTXqfMjLqW6lUUmNvExCaR0dqQi6Xk871np40/D0bn5hQY4rFe5zyw3gcDzo7pQqHhYlEQiqfgLBMS+HB2WxWOkFS6bQaU6v5V+sG7R5WXFdNeJHJSMdndGxMffM8Tzr/oxUyJ5L0pWFIB0gmk9fJquG/ZaiQ4U1ngUHLT6ZS6t2l9FFEChm+HizipxqR7IY7hQyn0h1AEOAfAearr/m9PjoAAAAASUVORK5CYII=",
    "icon": {
      "info": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgd2lkdGg9IjE4cHgiIGhlaWdodD0iMThweCIgdmlld0JveD0iMCAwIDE4IDE4IiB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPg0KICAgIDxnIGlkPSJpY29uSW5mbyIgc3Ryb2tlPSJub25lIiBzdHJva2Utd2lkdGg9IjEiIGZpbGwtcnVsZT0iZXZlbm9kZCI+DQogICAgICAgIDxnIGlkPSJEZXNrdG9wL1tQSVNdLVNpZGViYXItVmlldyIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoLTEzMTcuMDAwMDAwLCAtNjIwLjAwMDAwMCkiIGZpbGwtcnVsZT0ibm9uemVybyI+DQogICAgICAgICAgICA8ZyBpZD0iaWNfaW5mb18iIHRyYW5zZm9ybT0idHJhbnNsYXRlKDEzMTcuMDAwMDAwLCA2MjAuMDAwMDAwKSI+DQogICAgICAgICAgICAgICAgPHBhdGggZD0iTTksMC4zNDYxNTM4NDYgQzQuMjE4NzUsMC4zNDYxNTM4NDYgMC4zNDYxNTM4NDYsNC4yMTg3NSAwLjM0NjE1Mzg0Niw5IEMwLjM0NjE1Mzg0NiwxMy43ODEyNSA0LjIxODc1LDE3LjY1Mzg0NjIgOSwxNy42NTM4NDYyIEMxMy43ODEyNSwxNy42NTM4NDYyIDE3LjY1Mzg0NjIsMTMuNzgxMjUgMTcuNjUzODQ2Miw5IEMxNy42NTM4NDYyLDQuMjE4NzUgMTMuNzgxMjUsMC4zNDYxNTM4NDYgOSwwLjM0NjE1Mzg0NiBaIE05Ljg2NTM4NDYyLDEzLjMyNjkyMzEgTDguMTM0NjE1MzgsMTMuMzI2OTIzMSBMOC4xMzQ2MTUzOCw4LjEzNDYxNTM4IEw5Ljg2NTM4NDYyLDguMTM0NjE1MzggTDkuODY1Mzg0NjIsMTMuMzI2OTIzMSBaIE05Ljg2NTM4NDYyLDYuNDAzODQ2MTUgTDguMTM0NjE1MzgsNi40MDM4NDYxNSBMOC4xMzQ2MTUzOCw0LjY3MzA3NjkyIEw5Ljg2NTM4NDYyLDQuNjczMDc2OTIgTDkuODY1Mzg0NjIsNi40MDM4NDYxNSBaIiBpZD0iU2hhcGUiPjwvcGF0aD4NCiAgICAgICAgICAgIDwvZz4NCiAgICAgICAgPC9nPg0KICAgIDwvZz4NCjwvc3ZnPg0K",
      "loading": "data:image/gif;base64,R0lGODlhKAAeAPcAAAAAABY3QzqRsTqSsjuTtD2Vtj+VtUCVtEGWtUSYtkKYt0KZuUKavEWbu0eauEucuUueu0+fu0yevUiev0ifwUyhwUyiw02iw1GjwlOiwVGiwFSiv1WhvVeivVqivlikwFmlwl6mwWGnwWSowmKpw1ypx1eox1OnyE6lyFCmyVOoylapylury1+sylytzVutz1yu0V6w02Cw0WKx1GSy1WWy02ewzWevy2qvyWmtxmmsxGutxW2uxW+ux26vyG2xy3CxynGwyHOwyHWxyHezyXq0yn23zXm3z3W1znK1z2u002q21mq22Wy32W632G+523G523K63XS73Xe823m82Hq+3n6+2YK/2IS+1YS904G60H+5z4G6zoS70IW7z4a80Im80Iq+0Yu+0oi+04rA1IvB14zC147C14/A05DB05LD1pTE1ZjF1pnH15vH2J/J2Z/J2pzJ3JbJ3pLI3pHH3I3F24vE3IfD34XD3YLC33/B4X/B4oHC4oPD4YXE4obE44jG5IvH5Y3I45DI5I/J5pHK5pPL55XL55bM5pfM6JnN6JvN5JzP6p7Q557Q6qDR6qHR6qPS66TS7KTT6qbT56nT5aTR5qPP4aTO3qbO3qnP3avQ3q/S37LU4bTV4rbW4rnY47zZ5LrZ5bjZ5rXZ57LZ6qvW66jU7arV7azX7q7X7rDY7rHZ7rLZ7rTa77ba8Lfb7bjc8Lrd8Lve8b3f8r7f777e7bze7Lzc6r/d6L/b5sLd58Le6sXf6cfg6cng6svi6s/j7Mzk7cni7MTi78Lh7cHh8MHg8sLg8sTi88bi88fj8sjj88rk9Mzm9M7m9M7n9NDn9dHm79Pm7dXn7tfo79Xp8tPp9NLp9tTq9tbr9tjr9Njs9trs99vr8dzt9Nzt997u+N/v+ODu8+Lv9OHw9+Hw+eTx+Obx9eby+ejy+Ojz+un0+uv0+ez0+Oz1+u71+e72++/2+/H2+vH4/PL4+/T5+/X6/Pf6/Pj7/Pr8/fv9/v3+/v7+/v///+HA+yH/C05FVFNDQVBFMi4wAwEAAAAh+QQFAwD/ACwAAAAAKAAeAAAI9gD9CRxI0F+/gv0OHkS4sKDAhg8dSkwoEWHFiRAvRlQYsWLGjiAtahxJ0mBIjwMTqjxZ0iRHhiZHfmQZc6PImBBnZmxIUabBng5npkRJMKfHhUh1Dr1ZMF8nL6GWtpQa1N+4DQh4gKJZ9KFQhvlA4Gj3cqXXiVVxCiRlwV3Xo1KVEpxDZefOmiy/LsIT9KtGv8Si0MPJjyrIj0YH6isU6Z5Bfvf2GSa6NGM8VKeaaQtHryfSyX9/Ctxnrpu5ejxD+sX7Nm7rxK1dFn35NvHXzyT9pvb5WS5Qyjanoq0svHhX2mlFG4fpO+Vq2LKH08R90Wx10KwDAgAh+QQFAwD/ACwAAAAAKAAeAAAI/gD/CfzXbyDBf/4KDvTnD6FBgQwfGmw4UaFAixYj9rN48SJFiSAdHuQ4UCHFjCERkhQJUSJHjAZXdiRYUCbLmCs/MmzYsF/ClTZb8oRJ8WNNiR9H2kzacuLMmyedhox48KFJhFSt9tyYEulIlj5LZmSadeNGnV2PCvT0xQuwpi9fVgX7sCE5EAt88IDjkCvIokznLvSXr8UPd0131swK0m/RprhOwJMaEyLapnUVFlyEhyzZmzcLJuU4aRDShCVxWg06EJofeyJRYz4oOypEtUf3SWKFTyU/zYH/Yhw9kJ6sWdrSydtH9fHstA6p8mNn7l2+y0Z7pgweFqXguiW1TS90KhsrWNGYw4L+m/q7SL8X1accHlu+U5/B749337V90qLwfVVTUKyNd5JmNNWVX39zMRaTc+jZZJ94TA2X0YCVLXiWg/G1hN53TAUEACH5BAUDAP8ALAAAAAAoAB4AAAj+AP8J/OdvIMF//QoiNMiw4cB+DiEeHKhw4kKLFwUqlOjQYEV/CRFyTCgxYcWLHCkahJjSYUGFJz12hPlS5MyH/iqOfBjyYM6FEk+2ZPixX8+FNVe6JFjy4cWYTn9GnGi0IVSMRmMaHUpRqsyOPoniLNgSpNKcXnk2DKkQHhwhQt7MY8jxZ9WkTTcatIYhQ5ctDtJATOt0Kth/9lxcwVcwn76MFllaFSqwJKwa95RmhNqSK8x/kRBVHl25s2aNVg2yinTYJdnUYLkpqidycFWgTKmiVvkSZEF+sWhlrr17beqyFvM9c2aOnj7TkKMft4mwHr18/Fp/pisd5eitafVMqszd/fDgqxhbe6bu8aTXnlzhj48unytSoujNX60acmvK3twVh1tTT0nl234rQSfWgiWJJyCBus1n0UcH3XVWaZCdx11QerkX4EABAQAh+QQFAwD/ACwAAAAAKAAeAAAI/gD/CRxI8J+/gQcLDuynUGBCggwhFmQY8eFDhwUTRlz4rx9Fggn9afS3MSRCjA0R9ruYUiLKjgI3clQo8mPKgx5fWnwok6TGmAZnwpQocqjLk0NNmsSI0yjMlUAhMsQ5lWVUmSCtBqXZUiZWoF9jWuz48SJPoVuhbiWLz9MYMJ7yAS1KFunCkCU3hmtxAUkQBB3QOQV5s6XAfE6szGOoLoivizkN24Sq9p+xKPUans04WGpUVZOm6tQoGqZWhTlnuUK9FjLGqpHRdkulz+HYtWtXbrRJ+N++ZM/22SY58alVjweJC72nLVw9ffwWIi9tFy3TmPzu4eMXsftRimVxXCNMntwgXYm6Nb/m+nQ3R++7P35t+v58VOskqatV/lPs09biVXcfa0eJVxFKIiUYk1cHetQTUngNyJ+D1KEXoGEXmuYfca7lxxpWWDVV01LlqXRVUCxRZl1QGwUEACH5BAUDAP8ALAAAAAAoAB4AAAj+AP8J/NdvoMGDCAX6S0iwYEGFCwdGlPhv4kODEwketFixn7+FGQ9e/MgwYb+HF0uKTBlSoUuWGlNWnBlz4EmPLQ3KFPhw4UmfHCeGjFjQ30+eRHkeNelQZFKXQhEahahzI8GWJxmCbFjTZMaQRWmK5Kk0ok+yGBvmBFvRqLRMmaY59DnXrNORIwe+o4KiBIYCQuqJRXiT8OCm+/pUIScwWAQeGkEa9YjW4lCN/6DtiWewGo99eLtSxmyTJE1ZqyZnxdzz7GGbUhcmOyaVa22Jra0OBEeLX0eKGJsq9NjT5EB9zsxlvTmV4tbaPfMKrGcuHujRIEenXI0Udlp//PBn7YtKM+xwklNR2uS+fuzM54Z3XqRsmuRP7JW3fu3++/VM6SNdBhx7NMGnFFruFbeTWAuShlVGRZn2kkQSFpfQVM0V1ZSEZKH3n3HzkWXee6uRJ91H7G0lnU6u6ZbiS0S9KNZT/P0TEAAh+QQFAwD/ACwAAAAAKAAeAAAI/gD/9fv3zx9BgQcTChw4UKHDggYNHmyYsB/FihIrEhyYEeFBfxwfOuwo0iNDiAJJgvSosJ8/kgtZUpQ4s+THgggj2myJsyfBjB1hblS48iXLnz87XnSpMyHQmBdH4oy68yHJkzcLujSZtaTSoUh7vtyK1GVUpjGvdvX3jdQock2NCr05N6E9QTBWXFjQBd9SjEaJSjXIT1Gfbf325XpQROvEqT1PPs3KrVC8hL8GTAt6k+xPhg2jKpuVlCCRX2GzXpwc+uAzaA/RcpVKtaW5Zw1XOgx5NaPnzwT1gZNHNrDN2pOh5qOX7zfO5Km15o7dj5/F2pBlIjXo+aXvpK1XUWJ32tWnb6zGndbV7tEoRbPlo1fEPnb96ujTfT4WqfO9UO48gSXYfCnNFtNU54GUXnkzUdXUVlt9lZJ4LekmlVUWVYggfEe5N1FuM0m4U1QBAQAh+QQFAwD/ACwAAAAAKAAeAAAI/gD/+ftHkGC/gf0KFvQ30F9ChQ8VSlw4kWHBfg8H/sNIUSDEiR4lPoyoUGPEkQcJNiwJsiFJlQZjClwJc2PGiwJfbtxp0GFOnCBF2jwZVGdNmyFhIjR482hSoD1VuuQ5MWFKiRohZsWIcWtCmlF/aswaVKhKnWRrjgR7lKHRoOZs5UpXdSTVu2YV3nvEZMYJCmTykR2806jdiPxSGeLWb18uCUY4LvTpdmPDtDIFmosUT+EwAnkXWvW4EvM/bMtiDuTgpmxXvKq/GuzWbSKYTRHHUs099KPAd+GymvZZkerwhPve4dNtGeldk2GLE9ynj59s3y2dzywM1O1B6ExrWDpkC5PjS+jMyYO8jn1t+fVFWVqemtHq+NDwLZZdul54UNNYlXURgBURt91TzWl1X04k8RfSV1M5dRJhmQ0ooG4pQZfhXVdBdWBVpKXUIVPC+fcTiPEBFRAAIfkEBQMA/wAsAAAAACgAHgAACP4A+/37J3CgQX8GEw7shzBhQ4UFFxosGPHgQ4EI+2mEOBDhxYoFG2ZUeLDkP38PJ1YkaZJlS4EwNWJsGFMkRI8lbXZkyZCgv54of7YkiJHgwpUMU5IUmRKmy5AOWf5UanQn0qVOgypE6TIl1ZVGV448Sdbl1qIkkV6syjIdsWLqltocu9YoV4X5WO2BIgOFGXw8o1ItO3UiLUnh/u3jhWGL1qg7lYqduO4VvbDCChDtiDEizrMnNxIMh42zwA5tEk4mO5lix3Tp2P4bkeYpZLt3dw60B48kj1Cqm1qUyBZqv3z7lnbUWbVnYLuhNQ4ePDF3zpc9Q25EuZrj8rLKiU8TBRte/G3wI39KV7lwbeecMKc6D+xat/mJurvLJi81bf/2/nn23EGr0XSSdbkJaFJr4KnW4HpoOQgZVF4peN5/bDHXnlBPoeVUg/BxlVFAACH5BAUDAP8ALAAAAAAoAB4AAAj+AP39+yew38CBBg0ePOhPYT+FBxMSRDhxoMCJDx8utGjQn8eI//oVDElx5MOLG1FqDLly48KODRFqhOiSJkaWEy96jEmy4UeXFkFSpGjToUqeQUUO/VnxZseIECVGJZmT6NCaNkOijChw5NabC7uGBSr0ZdamDCu2REqWqMKvVE2iTfoyJDtnzNptdJjS5ci6CfXRMtTnCYw5+mpulQr05NBmrswZLLYCS9G2Y8n6i7fsHsNhDKoxbXjWLMGTOtmZyynwA5ySmC9K/Si73jybI9bA7ViaKtB9+TbKQ/ApLs6mEHWmJdmPH81qIuxRbZn86vKtYq9KHNrbt+agFlFZkt7bt7H3zARVXvZL9in79NhjykYOV2z26cvBe5cLPqPKsjVhZtVxsQHV1XbvwVYXet5Vh1ZGSlml3koxJScffm25t+BpBJomVFQfOZRVQbvR9RRTAM7lT0AAIfkEBQMA/wAsAAAAACgAHgAACP4A+/0b2M9fwYH+/iUcyLCfQIYEHyZcCLHiP4EF/WnE+NCiQYUdJwpcqFFhwo4VR5IsafEiQo8lKUYc2XKiTIUEGX48GbHlRYoLD8o8CBKhwZs4EaJsWHRiRZZJiepcivMkRZRIcTrMKTOoR5c+U37FqBNsS6omIfJcGjIsQZ5VydJM+1bhu2zQ4l2U+BIiW6Nqq+ZTJimRniaW9j3k+/WqS6gJ+WFbFs/fvmIv5Nz8aNat34H0uukjiosCupQag1ItmdFvPXp++VXw9JJs0oY0nbocqU8f1H8bMtXMynVxSn4VyRHwhRpuX59Yt+7d0WFfUpatA1M1/rzfF29qMWOSfB7+LPTPRcF23P5StUWyK/1+NC69a07c7x0yfi6Sqef4jLX1VHo6/RaUVWAd5R9q1/1230wPkrfeWGYNJV9g6EmkW25PpTbVZmXd5phUTNnnIGCMAQUTSvs1BBRx6xEHVkAAIfkEBQMA/wAsAAAAACgAHgAACP4A/f0b6K+fwIH9BipU6E9gwob/IC5ceHCiwIMPI2KsSJAgx4gTLS5M2PEfSYUnTZZEGbJlw4ItVbYkKREkwYcVU8JkmVPlR4Q2J/YbuhKhwaIjSRI1yPEgRpk+bT4NypNhTKpAs7KcmRKk05JdR6oM+zDhybA1RQr1Knbs0X/82HHjZk+jVp46x16998zVKUJ7YEksqNTk27xX94Xjdu+fvls0SoU8+VOs2ZL42r39V2kFPrUI02bduVCfPpn+3lEQRhEr0YZhIx7tx68rPga9rmK1O9ks0YW+CqADGTs21NlOYfpT12FIZYOXKZIu2dPkAw/wqG++StNlUGqfm1eGvFiR9G+j3c92/B39InGnKQuTTouz8tqg9u++Hj1ZrEP2W1G3UlNo6YaadFbJlNFsAYp0XkyFjbfeUBtB1ZZaxnVFmVbdZRWdgSBWl2BbleWUEVJqBQQAIfkEBQMA/wAsAAAAACgAHgAACP4A/wkc+K+fQH8EDSrs5w+hwYQPExacKDAiQ4n//PV7aLFgRIoDOVYciDBhyYcODxIk2HAkyJcrKWqMSZNmSpIKVZIMyfAiyJIlQ7K8GdFhx4ooUQp1ydJnRow6P+o8WXOl0qAsrQJdCrXqVoRYCwLF2lJqTqtcbapsOTGeOHP5VlI1uNUl2JgP83VLFutRImY0N860KjJsRX7v1ukTaCwKMaRigx7dqTLiPnxYKS3ZV/WpVLl4+a0sl+IbTKFsM35UCLRnxHYUqk3+XNMn2NQFRzWYh3PmRcOVnwpX+m9chC9QT1LdKZKpwzAIRtSTODcw8MBeNi3Ge9drTrYMw1MGbYjyq9CzqlGLJQyaONSeTDsPDh9y8ET38DOyHSy5ttnrp+mEkX2ejbeWcFkdZJ9T+h20UVe/UUZggCNdR+CFBqqXlHwv0UYSgGh5GFWHHT0UEAAh+QQFAwD/ACwAAAAAKAAeAAAI/gD79ftH0N8/gwQTJkSIMOHAhQofRixIsF9DihgPQvTn76HFigMZCryo0KHGgR//eVQpUCBEjRVLdlTYkGTGkiVTVjRoUybPnThVOqw5ceZIjgslIvx4kahElSSfBrUptSfLh0tf4sR682LImDCFTlzp0ipNmRafMtXo1ajagv3qrVu37+1BnVJRBoW5j502Zq1OZZP4ledSi0j3Js1Xbx9BZYCgcQUbtufShv3qKjRVhV9OnFm/xlQqtGG5GOXCig3rkvVPlIaFqkuxzaBomIRl3lUN1t8oC/bOZjWZ0ytFj+MylBnqU6pYhkkdauKiIEfwyWerfg6qb8SOTau1W4YXWjgq2Ly2WzsMyXQm7o63Fw6HujVjR+iKld4urHfv/f5YaadeQSSZV994ZxEHUW4Thaeee+Zh1dRzvImHkXaK8YaZc6XtNNN8oFGYYX7H/aTge7sRuNFAAQEAIfkEBQMA/wAsAAAAACgAHgAACP4A/wnsN/AfwX4H//kzKLChwocCFzJ8uLCiRIIFMTokKNGhQ4kLOYbE6M8fQo8NK3rsmFKhRZQfWXpM2PDkxokHNUI8KbMgzI81dbaEWTLmTKAQJ5rESBKpUoY9GTJ9KPSoy5UGEdIcenNiSqY9TRasyPGq1Ig/sUYVqtUkSI0X/eWLF29fx34dWYaMSDYtQnzquCWTFW5vUb1oP+qc+o+fPn7/9kVjxE0lRZtd2bI8qTEWIchOfeJNWnbzRYHnopwb2BRlUaw6ZS5sF+Nb2sSkfyakiWuFPa9QEWtNTNJmR3Im6gxdLDaqT4/60rjp0gDH76hxaxI9KzAfEQ87Nlvt/Cl2pUaaIA9j5bueKm60Jc+HbX2bftWspPdqh39XrcLzafV0320goTVgSqd9ZeBQp8W3XGz/YbafVVuRd+B+FxYlVHl4lTWQTLslddtGEHL1nFej4XRiTQEBACH5BAUDAP8ALAAAAAAoAB4AAAj+AP35+zeQ4L+DAg3+6zew4MGHEBFGnKgwocOHDvst1EgRIUeCGRNG1Phx4UWGHUceLNnvo0N/KDGulFmwIcyJCT+2XLiR58OdKzXmVNizo1CVDGNSfHnzJsuVF2/OpIkzJUGUJCPaJOpTa0upJGsC7XoUI0mXV61ObAkUplKEFj1K9dlvH756+yBeVJsVaEmB/O6t09bsnMSfU9MG5SpzIb+W/MCpEld05l6DSa3G1Zgs0tSShy9fPgyRnZ91PJ2qHVkTMcR3TygTBb1Ur1a4B23RuMdx7NjGt4UOrGuSnAs5WU2iLcjxZNR++hIAadNlQhJ8Kl1nHX2Y464iIYRdeMpb1nXiuRKHK0zOt6vPvW8ZJ6bNs7x85mvfkxZ5Pv7UhsD99xtZVal12U7sQWTfST+phx5IP7EFoIKKQZWeeQ/SlViAKWVEGmbN4dQcfavNlOBtTaWG0YTwCRQQACH5BAUDAP8ALAAAAAAoAB4AAAj+AP8JHCjQH8GBBgf2I7hw4T+HCh9CPEhR4MSDFw/6a/gQIcR+DhMSFFmwY8d+JEv+I+lvI8aVChcadFlRosGLF1uubDlzpEidCDUytKgyYk+RIEtyDAozocyCOZmalFqxYdKSTkNSBJkS4UyuML0yBUq0qVOPFh1OvMrzJ8mMHXti3bgP38uhJ3/uDEtTIT9867qliwm1bNi9NQtu5MnumLinWqeOXAnxrUqD2FTx44s38dWaKAXGS8Ru50fChjtb3MgxXh9zFLtu7dzXZC0p+fiGhpnzbFyCaD7B3FbDktyviSX7XulmAAkySCxc0acW5dK9smMPnCYGSBZeOFdXx+0qm+VhySaPn58sUXth3hNro8d4U2x21UGTso2d0e3v5BEBOJVOyPF2nlWpuZSQb2rtRGBslsn21H+67XbTbnDhBReGZF2HWHYZYhWZZwoxuFVlAgUEACH5BAUDAP8ALAAAAAAoAB4AAAj+AP8JHNiP4MCDA/0dVKjwX0OE/h4K7FcQ4b+C/gpWZBjRIsF+DB16dChRIcWRIhMerDjRY8aTIFkKzHgxZcuEDSWCFCnTYk+EP1FSNGnQ4UmLEVlKXCmTKEaPGmu+hHkx6kKSHZEuXbj15kyaQI9OrEhxJ0qVJIeK7Tqy4dqxYgnu23e1ZkyjYJuOXZqRH7516/hdzIr3YVykiC/iiyYuK9iQLCMXlaqx7D9zs+iOrWvXYFKUbu9JYneVsOmVJFdyNErv0Dqgk6nanO0PWJqQ/2oB0ifVqNG7cGcKbxmMgJp8F4k1gdUZLcThEFmCUgABSAsVjfjRNG32rE+T7jZjqbn0jaFl6DU5Q/W6njDssyDZJtzoG6fP9C23P70ZFONTsqnVF9ZHsO3H02xXWcWeTurBtlp8+Lk0XFc9aZRTenpNNJWCnznXnWT7XaiSgcIRhV9kZIGVWIAn3rTUf/JVJVBAACH5BAUDAP8ALAAAAAAoAB4AAAj+AP/96yfwn7+CBwsqXMiw4UGCCxMWhPjwoMSJBCFCNDhxYb+LAyM27DhS4keFGy1yvOjvZMKUGzumFEgQZEiGMQXanMiyJcec/kzS1InyJUKbFmPOTGowqMSgJENuzCg16s2cVhFqrAk1I9SVWR8OZfhVKNWbZJFe9PqR30iwcIXqNKp13716NWlS7BgU61uF/vaZW8cX5cmBT32KTWjRab93zfQdRStSZz+NKA37y/cqHsKxmUHTrYnmF2B6kt5V5oj4JearAoXocEvTGKN9ZKcu/hr6YDUDX+r941erCjO4Hin/9dmvl4QJNmDQcJWX7F/Qnw3aE3WJFLuQTkFdqsz82nrVj35lMi+ZfvV4vUsNUmVM1ONJpfRr5nQZ1Wl9wPKRRFdYAA41X1gzlVfYdXqhNWCA2WEE2Ef+GXXYZxde+N5ZEv6V132sUUgUSOlRtNdPADLnk4OLCRQQACH5BAUDAP8ALAAAAAAoAB4AAAj+AP/98yfwX7+CCA0mTHhQ4UKB/vo1bEhQYL+KEC1apEiwIkGJCDFm1Dhw4UeHJkGShNhwJMuNLUuGnJkwosiDFQ+qfHiRpE6HLUV6tCiyoM6IMjX+HBgTJc2MTZMWRJrxZMepJDFi7Ck15FaiEG9eDcqTIVOF/r7OHFs0qtGwVZkuBftw5VmEFycy3afP4NGPc3G+rfuQn7x6WIGmbdmUatGa9cDtI0xTIk6bVP/xC+INrj5miCmP5KpxKL8DnfTWi0WvLFaONRMKyRGU2Sp+ObGmbRt1azUFY+b922eMULaVeq9SDnrRF4YLSpZIQXazq97YhO/xqmQrntu3vWVdFv161eZCtzav+0Uas+lOk2kHs2SP169DpFvZC+6pFS9pp/SFBNJ4b/XHEEUlEZiVQoIlmFh938XnU0n/NQbXRJmtVZdQ9ZlUYG5AWVjfSYSp5SFIA/7HlHldSRUQACH5BAUDAP8ALAAAAAAoAB4AAAj+AP8JHOhvoMF/BfsJVGjQn8KCB/8xRCjQ4UGIESH6wxgRYUGIEzMaZDjxY8eKCSkqfHiyIkqOIWNKFDmwH8ePGhlaBJnTJMWOIVVyRKgzo82NBGsSbTnz50GZQ5u2RHoyKtCkKoPabPhUosaGKZ0WVXqRrNWaQZs63Lqwab+0ILtu/Ur0qE+PRO9WnJg2pj59U13ilTpUYRFfB/O94zdSZVuwY1PuIxBq5L5u+d4yLTnS4kEEnnb+u9fs3syVTpPeJCxRiI+D2I65xAgXpdSL1RqYqSewWaRwgpeGbQu1ZsFhJlZMqRIIGtOZwyP2/YevWKlk9DaSfGxyJd/t0mFXGm/4lu3s4Eijen4YHTXxoSY9U0yfvixOrO7BliWfciVVpWkx9Z9Mz/mE2nZxBVjbWjwtpNdtQol1knuaAWWRZtGpBd9HQdGVWlcOGhcSfcFxZZVW/wQEACH5BAUDAP8ALAAAAAAoAB4AAAj+APv9G0iw4D+BBvv5G9gPIUOHDf8tLCjQX0OBDg8aZEgx40aJBDNCVDhw4seTIEuCjLjR40aTKUuSfChyoUuMMW02hGkzoUaCEz2OlNiTpcqfGSfCfIkyptODCJeGDNoyosufIbESTdoUpFSuXQ9KLWiRolaiZnn+9Mf26NmZZReWPRsUosG5TN0K1BWGLD+XeDlORblQhBbB+/JdlMmY502E/fgZAOX33b62hC9CTrm5nwNPnPeBUyx3ps+QDk1WPPKDH8dw0QQDDTt2oLcLdQbyy+bqnNGEah2THShMBg0/gRxlw9qTbtXAKZnJckZPJVzZcr8urciSpNysCjFNq0atEXJgpS1Vzv0uMmx7oQ8/1v54dXje2Wbj3yULmLBXtxKF5xRVd5VlWm3NRXUSTrOht5lG32HG2Xf7MQgTg1UxB1RqYZ2VIX7/BQQAIfkEBQMA/wAsAAAAACgAHgAACP4A/f37168fwYID/wlM6K9fQ4P+BBpUuJBiwosLIzYcOPEixoQOK3a8iFAhR5MDK5LkaLClypUdVU502HFkwZEeUaaMeDJjToEvCVo8mVIoRJ0fGVbkybDoyow4b+bEmXPqT6AgR25UiBNoS5ApJwbtWbWs2aovRTr1OBPlUYlFv7ol6FMoyLpik4ZVyAnYR55HtVIl+hHYAFA1o9pEOjarkCB7+/HT2JQuWq5CmSqMsMmjP3z8CL8MyXTpxob+QGCKye/dPowIBWdeWPOhGRuvTbILF1pi26pUqaJbUUdeQXPJ0jHNi7ms3JzbokQ59EhVN4dEMy4ti7plR33QklNl82x37WWTJbGb1YqUPF2sDNWzhZ32p96zf7nXB56VuVP45Q02U0nmmbXVfAgSNViCC2InU03uPWQUeY0xpxZ/Cbo3FYB2vZVYgY01RWB5mpkVEAAh+QQFAwD/ACwAAAAAKAAeAAAI/gD/9fvnzx/Bgv8SKlRoEKHAgwMXSiQ4sV8/hAYvRpQY0eBCjxJBMnz4UGTCjBgJDtw4MmTCiycpshzokOTEmwtX4txpsifFnQ912rxp8qfFnwxrlsS5UWjGiiFZFv14cKpNfzCXvmw6E6hAjyxzih0aMyzYmCNFqrP38irVnFPNJtR1AI5XpGjlzuxHDkGYfSUzdjz7tC3HjQXXfNhnsWFThWG5fs06EsiZifw6RjxqkbJXmEfMiPSHj19Ix20bGn7a0F8lF/U25nv3NutmnmHtObnzDms8be1qt4T80mPhh+n+9InEaha4zJO33saJFeTZfd2caZNHHOljzi0vURYtrHms+ZGIoZIdftew2NtWUzNdL5OiyO8uaXZsaRzx0fnk5fTfaCf9hxdNSc13lXXdJaURg/TFBNJg1LkXn1FHTYUVTGEd1J56SgV1U4cBAQAh+QQBAwD/ACwAAAAAKAAeAAAI/gD/+evX71/BfwgTEkzIsKA/hgYbQpzo7yHDhxYPIrQ4saDGhBwvKoSoMeTGkRBNnqQocmXGiDAnChTYbyDChSQ9ytwp8yPNlRJ77lSJEqhMkw89vtx4sObMozmPHqwY8SPSpAJVasRJEmvDkBZt+qQ61qDPiera/HrKc2RGq1GBJYigq2pEolu9Dv0H78GWfD9BKsRotuVFmwkzacAHVrBBpGapPk6JEAsWiXCzZuW4NahFO1duJuTn1PNkt6Jf9rtFIx7HffmaOn4atmjMf/r6CHpX8166e0FJQi0pOB6jRKuQOUtHk/BGm5y7AnXaz5w2cfRmC8foXOTUw5qLTRLdy5L2adHouUId7Pxt252lhSIuzPZ81drwZ86vKNu7edrjOaaTgGfBxF99wRE1XnzBpXZWgZLdNlSEZ4WVVEjqFcgSTlM5J9t8CAUEADs="
    },
    "introText": "Welcome to finAPI Web Form. Please follow the on-page instructions."
  },
  "functionality": {
    "progressBar": "RENDER",
    "bankLoginHint": "EXPANDED",
    "termsAndConditionsText": "BASIC",
    "storeSecrets": "RENDER",
    "bankDetails": "LOCKED",
    "header": "RENDER",
    "language": {
      "selector": "RENDER",
      "locked": "DE"
    },
    "skipConfirmationView": true,
    "renderAccountSelectionView": true,
    "hidePaymentSummary": true
  },
  "aspect": {
    "colorScheme": {
      "brand": "#00ADDF",
      "text": {
        "primary": "#232323",
        "secondary": "#848484"
      }
    },
    "text": {
      "fontFamily": "Calibri,Roboto,\"Segoe UI\",\"Helvetica Neue\""
    },
    "theme": "DEFAULT"
  }
}

The default Web Form styling is as below. It is the finAPI profile.

Parameters

Many of the API parameters can be customized. Some of them are highlighted below.

Legend:

Text in RED - Description of what can be customized
Text in BLACK - The API parameter to use for your integration

Special cases

Account selection view

Profile section: functionality.renderAccountSelectionView

You can provide your end users with an option to explicitly choose which account must remain in the imported bank connection. In that case, the web form will include an additional view at the end of every iteration where the end user can see all accounts that have been added during the iteration.

Skip confirmation view

Profile section: functionality.skipConfirmationView

Even though by default the web form will provide the end user at the end of the import or update flow with an overview page where all imported/updates accounts are listed, you might want to implement it differently, in your application or website. In such cases, it might be useful to use the “Skip confirmation view” option that will disable the default confirmation view. Instead, the end user will be directly returned to your application or website. In order to provide the best user experience, we urge you to also use the functionality of “redirect URLs” (for standalone web form integration) or “frontend callbacks” (for embedded web form integration).

In case you would like to use one of the options below, please create a profile with all the parameters you are looking to customize. You can also configure these special parameters with the values allowed in the documentation. Then contact our support (support@finapi.io) with the profile ID, explain your use case, and we will update the profile accordingly.

Hide Payment Summary

Profile section: functionality.hidePaymentSummary

This white labeling option has been created keeping in mind those specific customers whose business case involves initiating money transfers on behalf of other businesses or individuals. For example, payroll processing customers. In this case, customers have the option to initiate payments, but the web form will intentionally not display the counterparty data in the payment summary. Thus, the end-user initiating the payment will not be able to see sensitive information like someone else’s salary on the Web Form.

Implicit Approval

Profile section: functionality.storeSecrets

Think well over your use case before using the setting storeSecrets = IMPLICIT_APPROVAL. Consult with our support team in case you want more details. IMPLICIT_APPROVAL implies that the end user will not see the checkboxes for "Save PIN" and "Save TAN Procedure" on the web form. But we will store provided credentials and preferred TAN procedure anyway. In order to keep it clear and fully transparent to the end users, the Terms and Conditions text on the web form when this parameter is used will be a special (and explanatory) one.

This white labeling option is useful and relevant only to use cases that need access to accounts once (for ex., import accounts and immediately followed by payment initiation once). It optimizes the workflow for such use cases. But this option is not relevant for use cases like the full AIS service. In the case of customers using the full AIS service, this API parameter leads to a bad user experience for end-users.

“Terms and Conditions” text

Profile section: functionality.termsAndConditionsText

In case there is a need for more explicit “Terms and Conditions” text - where it’s explicitly mentioned that both “Account Information Services” and “Payment Initiation Services” will be used within the connection via finAPI - you can find useful this profile configuration option.