How the Admin Portal works

The Admin Portal is the Peach web application where your company's administrators manage company-wide configuration: who works for you, what they can do, which communications borrowers receive, and how your loan products are set up. Borrower and loan servicing happens in the Agent Portal. Two Admin Portal views read borrower records, both for previewing communication templates. A template's preview screen (the Preview button on the template's details) lets you pick one of your company's borrowers and, optionally, one of their loans and one of their cases. A loan or case becomes required when the template uses loan or case data. A Statement field appears only for statement templates, after you pick a real loan. In the new layout, the template drawer on the Templates screen previews the template automatically with the first borrower returned for your company. It has no borrower picker.

This page explains how the Admin Portal is organized and how access to it works. To perform a task on a specific screen, open that screen's page from What lives where.

• How access is gated, and why a permission alone may not be enough
• How you sign in, and why sign-in screens differ between companies
• How the two layouts differ, and what switching does
• Where each area lives, and which page documents it

The Admin Portal works on one company at a time.

The sidebar you see is not fixed. It depends on which layout your browser is set to and which role you hold. In the new layout, two entries also depend on Peach. Promo Program Types appears only where Peach has turned it on. Where Peach has turned on the redesigned Loan Types screen, Loan types appears only if you hold loan.type:list. Whether a screen then lets you in depends on your permissions. Two colleagues at the same company can therefore see different sidebars, and one person can see a different sidebar in a different browser.

• Admin Portal access — the admin.portal:read permission. Without it, every screen in the portal shows a no-access message.

• Role — a named set of permissions, such as admin or peach-support. In the new layout, your role decides whether the Admin section of the sidebar renders at all. You can hold admin.portal:read through any role. Only the admin and peach-support roles unlock the new layout's sidebar.

• Permission — a single capability, such as company.keys:list, that a screen checks before letting you view or change something.
• Legacy layout — the default layout: a flat sidebar and a header bar across the top.

• New layout — the opt-in redesign that the layout card calls New admin portal! Its sidebar groups all portal entries in one section headed Admin, and holds the controls the legacy header holds. It has no header bar.

• Feature flag — a switch Peach controls that turns a screen on or off for a company.

Being able to open the Admin Portal doesn't mean you can use every part of it. Access is checked at several levels, each on its own:

• The portal itself requires admin.portal:read. Without it, the portal shows a no-access message on every screen, in both layouts.

• The Admin section of the new-layout sidebar requires the admin role or the peach-support role. Either role is enough. With admin.portal:read but neither role, the new layout's sidebar has no portal entries. It still shows the Legacy admin portal card, the footer links, and your initials menu.

• The legacy sidebar has no role check. Anyone with admin.portal:read sees all of its entries.

• API Keys additionally requires company.keys:list. The sidebar entry is shown whether or not you hold it, and without it the screen shows a no-access message.

Your company has its own Admin Portal address, and Peach uses it to identify your company and its sign-in method when the portal loads. For how portal addresses are provided, see Portals and environments.

Peach configures one sign-in method for your company's employees. The sign-in screen shows the form for that method when it is password, one-time code, or single sign-on. If the configured method is Google sign-in, the sign-in screen shows no sign-in form. Your company's Admin Portal and Agent Portal use the same method.

The portal has a sign-in screen for each of these methods:

• Password — you enter your identity and your Password, then select Continue.

• One-time code — you enter your identity and select Continue, then enter the verification code Peach sends you. The code takes the place of a password.

• Single sign-on — you select Login, and the portal sends you to your company's own sign-in service (its identity provider), and you sign in there.

The identity field's label depends on your company's configuration: Email (the default), Phone Number, or Username on the password screen, and Email or Phone number on the one-time-code screen.

Each method uses one credential. None asks for a second one afterward.

If your company uses one-time codes sent by email, employees can't choose to get the code by text or voice instead.

After repeated failed attempts, Peach temporarily blocks sign-in for the identity you entered, even with the correct password or code. It then shows This account has been locked due to too many failed attempts. Please try again later. The block lifts on its own after a waiting period. A successful sign-in resets the count.

Known limitation: if your account has been deactivated, sign-in fails with the same message as a wrong password. The message alone won't tell you which one it is.

If your session expired within the last 12 hours, the sign-in screen shows Session Timed Out when you return. After a longer gap, it shows the sign-in screen with no alert.

Everyone starts in the legacy layout, and every user can opt in to the new layout per browser. A card at the bottom of the legacy sidebar reads New admin portal! with Try it now. In the new layout it reads Legacy admin portal with Go back.

The choice is stored in your browser, not your account. It does not follow you to another browser or machine, and clearing site data returns you to the legacy layout. Switching changes no data. After the switch, the portal reloads and opens the Teams screen, so you lose your place.

This diagram shows how your layout, your role, two Peach-controlled flags, and one permission decide what the sidebar shows.

The new layout adds eight screens that do not exist in the legacy layout: Company configuration, Investors, Settlement Instruments, Loan Tape Types, Loan Tapes, Credit bureau agencies, Collection agencies, and Promo Program Types. In the legacy layout, typing their address sends you to Teams.

The two layouts also place the portal's controls differently:

Neither layout lists index rates in the sidebar; each opens them from a different menu, with different access checks. See Set and manage index rates.

This table maps each area of the portal to the page that documents it. Labels are shown as each layout renders them.

If a communication template shows Editing disabled and Edit is unavailable, Peach has temporarily turned off editing. You can still view the template.

You can't change an existing loan type's configuration in the Admin Portal. Where Peach has turned on the redesigned Loan Types screen, you can export, import and, where cloning is on, clone loan types, given the permissions. See View, export, and import loan types.

Rowan Okafor (rowan.okafor@example.com) holds admin.portal:read and the admin role at one company, which signs employees in with an email and password. Rowan enters Email and Password and selects Continue. Rowan lands in the legacy layout on the Teams screen, with nine sidebar entries from Teams to Loan Labels. The header has no company switcher, because Rowan has access to only one company.

Rowan selects Try it now. The portal reloads on the Teams screen in the new layout, with an Admin section grouped under Workforce, Customer messaging, and Capital Markets. The next day, on a second laptop, Rowan is back in the legacy layout, because the choice was saved only in the first laptop's browser.

Rowan's colleague Sam Idowu (sam.idowu@example.com) holds admin.portal:read but neither role. Sam selects Try it now and gets a sidebar with no portal entries. It shows only the company logo, the layout card, the footer links, and the initials menu. It also shows Switch companies if Sam has access to more than one company. Sam then selects Go back and has all nine entries again.

The new layout checks roles and the legacy layout does not. An employee who gets Admin Portal access through some other role, not the admin or peach-support role, loses the sidebar's portal entries on switching. The Go back card is always there to undo it.

• Portals and environments — The three Peach portals and how their addresses are provided.
• Configure roles and permissions — Assign the admin role and the permissions each screen checks.
• Navigate the CRM — Where borrower and loan servicing happens, in the Agent Portal.