Configuring Entitlements

Configuring the data and access entitlements for the ZipRight application

All integrations built on EPC are governed by two types of application entitlements - access entitlements and data entitlements.


Access Entitlements:

These govern which instances of an Ellie Mae application can access and originate transactions with your integration. These sets of entitlements follow a standard allowed whitelist and denied blacklist model, with the blacklist taking precedence over the whitelist. You may have noticed your sandbox Encompass instance was included as an entitled instance to access the ZipRight application you registered in the last section.

{
  "entitlements": {
    "access": {
      "allow": [],
      "deny": []
    }
  }
}

Data Entitlements:

These govern which data fields the application backend receives when a transaction is being originated and requested, and which data fields an application can write back to when it is fulfilling a transaction request. You can read more about the EPC integration entitlements framework in the deeper dive section.


The JSON below includes the data entitlements necessary for ZipRight to complete its ZIP code verification:

📘

Get these entitlements applied!

To run the ZipRight application, you will need these data entitlements to be applied for the EPC product you have registered. Reach out to the EPC Support Team at [email protected] or contact your Account Manager to get these entitlements applied.

{
  "entitlements": {
    "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"
              }
            ]
          }
        }
      ]
    }
  }
}

Did this page help you?