{
"id": "8c1757b4-b479-4a2e-a71d-a5f91649d21b",
"partnerId": 99999999,
"name": "test-product",
"listingName": "Test Product",
"requestTypes": [
"Appraisal"
],
"environment": "sandbox",
"status": "development",
"interfaceUrl": "https://lender.product.io/",
"adminInterfaceUrl": "https://admin.product.io/",
"integrationType": "ASYNC",
"credentials": [
{
"id": "username",
"type": "string",
"title": "Username",
"required": true,
"pattern": null,
"minimum": 4,
"maximum": 30,
"secret": false,
"scope": "user"
},
{
"id": "password",
"type": "string",
"title": "Password",
"required": true,
"pattern": "^.*(?=.{8,})(?=..*[0-9])(?=.*[a-z])(?=.*[A-Z])(?=.*[@#$%^&+=]).*$",
"minimum": 8,
"maximum": 30,
"secret": true,
"scope": "user"
}
],
"tags": {
"workflows": [
"interactive"
],
"categories": [
"APPRAISAL"
],
"applications": [
"LO Connect",
"Encompass Smart Client"
]
},
"extensionLimit": 10,
"entitlements": {
"access": {
"allow": [
"urn:elli:encompass:BE11172646"
],
"deny": []
},
"data": {
"origin": {
"fields": [
{
"fieldId": "12",
"jsonPath": "$.property.city",
"description": "Property City"
},
{
"fieldId": "14",
"jsonPath": "$.property.state",
"description": "Property State"
},
{
"fieldId": "15",
"jsonPath": "$.property.postalCode",
"description": "Property Zip"
},
{
"fieldId": "13",
"jsonPath": "$.property.county",
"description": "Property County"
}
]
},
"transactions": [
{
"requestTypes": [
"Appraisal"
],
"request": {
"fields": [
{
"fieldId": "11",
"jsonPath": "$.property.streetAddress",
"description": "Property Address"
},
{
"fieldId": "12",
"jsonPath": "$.property.city",
"description": "Property City"
},
{
"fieldId": "14",
"jsonPath": "$.property.state",
"description": "Property State"
},
{
"fieldId": "15",
"jsonPath": "$.property.postalCode",
"description": "Property Zip"
},
{
"fieldId": "13",
"jsonPath": "$.property.county",
"description": "Property County"
}
]
},
"response": {
"fields": [
{
"fieldId": "356",
"jsonPath": "$.propertyAppraisedValueAmount",
"description": "Appraised Value"
},
{
"fieldId": "2356",
"jsonPath": "$.underwriterSummary.appraisalType",
"description": "Appraisal Form Type"
},
{
"fieldId": "2353",
"jsonPath": "$.underwriterSummary.appraisalCompletedDate",
"description": "Appraisal Completed Date"
}
]
}
}
],
"created": "2019-10-10T18:33:57Z",
"createdBy": "urn:elli:partner:99999999:environment:test",
}
},
"webhooks": [
{
"subscriptionId": "1fb42f88-2e35-43d6-bb69-ec3832c191a3",
"url": "https://webhook.product.io/",
"events": [
"created",
"updated"
],
"resource": "urn:elli:epc:transaction"
},
{
"subscriptionId": "a985bea0-59c5-4638-a7b7-81d027d42323",
"url": "https://webhook.product.io/",
"events": [
"created"
],
"resource": "urn:elli:epc:transaction:event"
}
],
"created": "2019-10-10T18:33:57Z",
"createdBy": "urn:elli:partner:99999999:environment:test"
}
This section specifies the allowed operations on the products
REST resource.
The product
resource
product
resourceAn EPC product
represents an instance of a partner application. Its data model encapsulates the various pieces of information that govern a partner application on the EPC platform:
Transactional environment and development status
Whether the application serves
sandbox
or billableproduction
transactions, which is based on its development status - indevelopment
orapproved
for production use
Listing information
Its
listingName
for user display on an Encompass application, the specificapplications
it supports, and the servicecategories
it is to be listed under
Supported workflows
Whether it supports headless
automated
ordering, along with user-interface orientedinteractive
ordering
Routing information
Its lender/borrower facing
interfaceUrl
forinteractive
ordering, its administrator facingadminInterfaceUrl
for transaction template creation (used inautomated
ordering), and its subscription information for transactionalwebhooks
Credential requirements
The schema definition for the application credentials required of its users
Entitlements
Its
data
(read/write) andaccess
entitlements
Try It!
Replace the
access_token
you generated using the oAuth2 RESTful API with the placeholder value in the Authorization request header inputs below, and click on the 🧭 Try It button to see theproducts
API endpoints in action!