Product Configuration

The PATCH https://api.elliemae.com/partner/v2/products/{{product_id}} endpoint can be utilized to update a registered product's configuration. This is the Update a Product request in the Product Registration and Management folder in the sample EPC Postman collection.

This section discusses the different sections in a products configuration which can be utilized to control various aspects of the integration - such as where the application will be available, how it will be listed for users, categories it will be listed under, workflows it supports, entitlements it is governed by, webhook and user-interface endpoints, and its credential requirements.

The following sub-sections cover each of these areas in detail:

  1. Application Availability and Listing
  2. Supported Transactional Workflows
  3. Data and Access Entitlements

Accessing Current Configuration


To get the full configuration for a product, use the Get a Specific Product request in the Product Registration and Management folder in the sample EPC Postman Collection:

GET https://api.elliemae.com/partner/v2/products/{{product_id}}?view=complete

Swap the {{product_id}} with your actual product_id if it hasn't been added as an environment variable, and click Send. The response looks like the below:

{
  "id": "562a9740-2e27-44fd-8ff6-8731de6aa0fc",
  "partnerId": "007001",
  "name": "ZipRight",
  "listingName": "Zipcode Validator",
  "requestTypes": [
    "ZIP Code Validation"
  ],
  "environment": "sandbox",
  "status": "development",
  "interfaceUrl": "https://0b2abc15.ngrok.io",
  "integrationType": "ASYNC",
  "tags": {
    "workflows": [
      "interactive"
    ],
    "categories": [
      "APPRAISAL"
    ],
    "applications": [
      "LO Connect",
      "Encompass Smart Client"
    ]
  },
  "credentials": [
    {
      "id": "username",
      "type": "string",
      "title": "Username",
      "secret": false,
      "required": true,
      "scope": "user"
    },
    {
      "id": "password",
      "type": "string",
      "title": "Username",
      "secret": true,
      "required": true,
      "scope": "user"
    },
    {
      "id": "organizationId",
      "type": "string",
      "title": "Organization ID",
      "secret": false,
      "required": true,
      "scope": "company"
    }
  ],
  "entitlements": {
    "access": {
      "allow": [
        "urn:elli:encompass:tebe99999999"
      ],
      "deny": []
    },
    "data": {
      "origin": {
        "fields": [
          {
            "jsonPath": "$.applications[0].borrower.firstName",
            "description": "Borrower First Name"
          },
          {
            "jsonPath": "$.applications[0].borrower.middleName",
            "description": "Borrower Middle Name"
          },
          {
            "jsonPath": "$.applications[0].borrower.lastName",
            "description": "Borrower Last Name"
          },
          {
            "jsonPath": "$.applications[0].coborrower.firstName",
            "description": "Co-Borrower First Name"
          },
          {
            "jsonPath": "$.applications[0].coborrower.middleName",
            "description": "Co-Borrower Middle Name"
          },
          {
            "jsonPath": "$.applications[0].coborrower.lastName",
            "description": "Co-Borrower Last Name"
          },
          {
            "jsonPath": "$.loanNumber",
            "description": "Trans Details Loan #"
          },
          {
            "jsonPath": "$.property.loanPurposeType",
            "description": "Trans Details Loan Purpose"
          },
          {
            "jsonPath": "$.mortgageType",
            "description": "Trans Details Loan Type"
          },
          {
            "jsonPath": "$.applications[0].propertyUsageType",
            "description": "Subject Property Occupancy Status"
          },
          {
            "jsonPath": "$.property.county",
            "description": "Subject Property County"
          },
          {
            "jsonPath": "$.purchasePriceAmount",
            "description": "Trans Details Purchase Price"
          },
          {
            "jsonPath": "$.loanProductData.lienPriorityType",
            "description": "Trans Details Lien Position"
          },
          {
            "jsonPath": "$.loanProductData.gsePropertyType",
            "description": "Subject Property Type Fannie Mae"
          }
        ]
      },
      "transactions": [
        {
          "requestTypes": [
            "ZIP Code Validation"
          ],
          "request": {
            "fields": [
              {
                "jsonPath": "$.property.city",
                "description": "Subject property city"
              },
              {
                "jsonPath": "$.property.state",
                "description": "Subject property state"
              },
              {
                "jsonPath": "$.property.postalCode",
                "description": "Subject property postal code"
              }
            ]
          },
          "response": {
            "fields": [
              {
                "jsonPath": "$.property.city",
                "description": "Subject property city"
              },
              {
                "jsonPath": "$.property.state",
                "description": "Subject property state"
              },
              {
                "jsonPath": "$.property.county",
                "description": "Subject property county"
              },
              {
                "jsonPath": "$.property.streetAddress",
                "description": "Subject property street address"
              },
              {
                "jsonPath": "$.property.postalCode",
                "description": "Subject property postal code"
              },
              {
                "jsonPath": "$.property.loanPurposeType",
                "description": "Subject loan purpose"
              },
              {
                "jsonPath": "$.property.propertyUsageType",
                "description": "Subject property usage type"
              }
            ]
          }
        }
      ],
      "created": "2019-11-18T23:57:14Z",
      "createdBy": "urn:elli:partner:007001:environment:test",
      "extensionCount": 0
    }
  },
  "webhooks": [
    {
      "subscriptionId": "b8fb8b38-22b4-46a5-b019-418c1fa61a7b",
      "url": "https://0b2abc15.ngrok.io",
      "events": [
        "created",
        "updated"
      ],
      "resource": "urn:elli:epc:transaction"
    }
  ],
  "created": "2019-11-18T23:57:14Z",
  "createdBy": "urn:elli:partner:007001:environment:test",
  "updated": "2019-12-05T22:43:19Z",
  "updatedBy": "urn:elli:partner:007001:environment:test"
}

Did this page help you?