Skip to content

Display IdP setup help

Request

Path
companyIdstringrequired

The unique company identifier.

Query
userTypestring(UserType)

User type.

Enum:"agent""borrower""service"
appDomainTypestring(AppDomainType)

App Domain Type.

Enum:"borrower""agent""help""admin"
GET
/companies/{companyId}/auth/saml/help
curl -i -X GET \
  'https://sandboxapi.peach.finance/api/companies/{companyId}/auth/saml/help?userType=agent&appDomainType=borrower'

Responses

Success

Bodytext/html
string(newStatus)
Response
string