Profet Platform Integration API (1.6.1)

Profet platform is comprised of 3 applications:

• Valuation: to create appraisals or alternate valuations using MLS & public record data and pre-built market insights and valuation models.

• Review: to review completed appraisals for quality using rules, computer vision, natural language, floor plan analysis, and neighborhood and market insights.

• Workflow: to manage order management processes and get insights into the performance metrics at vendor or organizational level.

Profet is an open platform where any of the above applications can be integrated with other 3rd party applications to help deliver a best-of-breed capabilities for customers. The more the competition among software providers the better it is for appraisers, AMCs, and lenders to achieve modernization goals in the best possible way that fits their organizations.

This guide provides the necessary API information and single signon options available in Profet to enable such an open integration.

The platform provides 2 environments - Sandbox and Production. The base URLs for the two environments are:

Sandbox environment: https://api.staging.profet.ai

Prod environment: https://api.profet.ai

The full url for the APIs must be formed as follows:

<server_base_url>/<api-end-point>

Example:
    https://api.profet.ai/valuation/initiateOrder

Security is enforced using a static customer API token which may be passed via a header attribute in each API call. The name of the header attribute must be "x-api-key".

Note: You can generate this API key from your company's account in Profet.

• Go to Menu → Administration → Company
• Switch the Integration tab
• Click “Generate Static Token” to generate your API key

Profet platform can invoke your webhooks to deliver events when they occur within any application in the platform. Customers may register a webhook with Profet and the webhook will be invoked when an event occurs.

You can manage your webhooks using the Webhook Management screen in your Company settings. You should be logged in with the role of a “Company Administrator” to be able to manage your integration settings.

From the main menu, go to Administration -> Company -> Integration

Click “Add Webhook Configuration” to add your webhook. You can choose the event you want to listen to and the authentication credentials for your webhook.

Note that all webhook events will be delivered using HTTP POST method and the request body will have a content type based on the event. Certain events generate a single-part HTTP request and other webhooks generate a multi-part HTTP request. The following table gives you a list of events and the content-type for each event.

For Automated Reviews in Profet Review, the webhook will be invoked when the order reaches the 'Completed' status. The event in the request will be Review.V2.ReadyForReview.

For Manual Reviews, the webhook will be invoked when the order is marked as "NeedsUpdate" or "Approved" by the reviewer. See the events above for the applicable event names.

Depending the Profet application that originates the webhook and the content-type, you will receive different request payloads. These payloads are explained below.

Profet Valuation Single Part Wehbooks

Content-Type: applicaiton/json

The JSON object strtucture for the payload is defined under "ValuationWebhookPayload" in the Schemas section below.

Profet Valuation Multipart Webhooks

Content-Type: form-data (multipart)

The Request will have the following parts with the corresponding part names

Note that the parts received in the Webhook will be dependent on the requestedArtifacts in the initiateOrder API call.

Profet Review Single Part Webhooks

Content-Type: applicaiton/json

The JSON object strtucture for the payload is defined under "ReviewWebhookPayload" in the Schemas section below.

Profet Review Multipart Webhooks

Content-Type: form-data (multipart)

The Request will have the following parts with the corresponding part names

This section presents the Single Sign-On (SSO) implementation information for the Profet platform. Profet is hosted on AWS and uses AWS Cognito for user authentication. User roles and role based access control are managed within the platform and do not use AWS Cognito for role based authorization.

SSO in Profet is supported via 2 options:

• Standard protocols available via AWS Cognito - SAML and OpenID are both supported.

  Please contact PropMix Support at support@propmix.io for additional information on how to configure your Identify Provider to integrate with Profet for standards based SSO.

• Proprietary SSO using Profet APIs

  This option is explained in more detail later in this document.

The following 3 sections explain the below capabilities for SSO:

• Initial onboarding of users into the Profet platform

• User Provisioning: Ongoing Provisioning / De-provisioning Users in the Profet platform

  • Using Profet APIs - Create User, Update User, and Disable User

• Runtime SSO between your application and Profet using proprietary SSO APIs from Profet

Profet supports batch processes to onboard the initial set of users. The following information would be requested for each user to be able to onboard them into Profet:

• User Type: Staff or Non-Staff
  This determines if the user is an employee of your company or an outside user such as a panel appraiser or broker.
• User Profile & Contact Information
  • First Name
  • Last Name
  • Email
  • Phone (optional)
  • Work Address (optional)
• Company Information (only required for Non-Staff users)
  • Company Name
  • Company Address
  • Company Type: Appraisal Company, Real Estate Brokerage, etc.
• License Information: one or more occurrences of the following data
  • License State
  • License Number
  • License Type
  • License Title
  • Issue Date
  • Expiration Date
  • License Document Url
    When provided, the document will be downloaded from the URL and saved within Profet for use in appraisal reports
• Signature Url
  When provided, the signature image will be downloaded from the URL and saved within Profet for use in appraisal reports
• MLS Access Settings
  • MLS Board
  • MLS Id Number

The above information may be provided in one or more CSV (comma-separated values) files to PropMix. The Profet team will transform the data into a standard form for consumption by Profet user onboarding jobs.

Onboarded users will automatically receive an email from PropMix including their username and temporary password. On first login, the users will be required to reset their passwords. If the temporary login expires, the customer administrator or PropMix support can resend the initial activation email.

Note that the activation email content is completely customizable to your specific needs.

User provisioning and runtime SSO operations.

Order creation, management, and reporting for Profet Valuation.

Profet Valuation helps build various valuation models and custom property value reports. In addition, it also supports numerous out-of-the-box reports such as property details, transaction history, market research, etc. Below is a list of available APIs to integrate Profet Valuation into your existing workflows.

While the below APIs are readily available, if your workflow requires any variations from these they can be specialized as needed.

Submission and management of appraisal reviews.