Peach Finance

Bootstrap

Get bootstrap data

Get pre-auth app metadata and settings.

Fetch metadata and settings for a Peach application. This endpoint is public readable because this information is necessary to properly render the frontend even for users who are not yet logged-in — i.e., the login page needs to have the right company name and color scheme.

Since multiple frontend application are supported by the backend you must specify for which frontend application this bootstrap request is intended. The best way to do this is by specifying domain. e.g., domain=myappdomain.com. (Please note that a "Company App Domain" must already be configured for your environment for this to work. There is no public API for this yet, so contact support.)

You may also specify the companyId and appDomainType instead of the domain, but this is discouraged and mostly intended for development / debugging.

Request
query Parameters
companyId
string >= 1

The unique company identifier.

domain
string

A valid domain associated with a company

appDomainType
string (AppDomainType)

App Domain Type.

Enum: "borrower" "agent" "help" "admin"
Responses
200

Success

get/bootstrap
Response samples
application/json
{
  • "appDomainType": "borrower",
  • "userType": "agent",
  • "ssoLoginUrl": "string",
  • "authType": "basic",
  • "authValueType": "email",
  • "company": {
    }
}
➔ Next to Auth