API Reference

Register a new product

post
https://api.elliemae.com/partner/v2/products

Create a new product listing and initialize its configuration/entitlements

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Defaults to complete

Product entity view to be returned in response body

Allowed:
Body Params

Product resource representation

string
required

Unique name for the product

string
required

Name the product will be listed as on an Encompass application

requestTypes
array of objects
required

The different types of transaction requests lenders/borrowers can initiate with the subject product. Data entitlements for the product are indexed around these request types.

requestTypes*
string
required

URL for the user-interface that will be presented to borrowers/lenders during manual ordering workflows

string

URL for the user-interface that will be presented to an administrator during 1-click/automated order setup workflows

tags
object

Product tags

credentials
array of objects

Schema definition for the user/organization credentials a product requires

credentials
webhooks
array of objects
required

Transaction webhooks a product subscribes for

webhooks*
integer

Number of allowed custom extensions to a products default data entitlements

entitlements
object
required

A products data and access entitlements

Headers
string
required
Defaults to Bearer <access_token>

oAuth 2.0 Bearer authentication/authorization token

Responses

Updated almost 2 years ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated almost 2 years ago