Sign in
Products

Register a new product

Create a new product listing and initialize its configuration/entitlements

post/products

Query parameters

view'id' | 'credential' | 'integrationType' | 'entitlement' | 'webhook' | 'complete'

Product resource view

Product entity view to be returned in response body

Headers

Authorizationstring required

oAuth 2.0 Bearer authentication/authorization token

Request body

nameName required— unresolved $ref
listingNameListingName required— unresolved $ref
requestTypesRequestTypes required— unresolved $ref
interfaceUrlInterfaceUrl required— unresolved $ref
adminInterfaceUrlAdminInterfaceUrl — unresolved $ref
extensionLimitinteger

Number of allowed custom extensions to a products default data entitlements

Response

A new product resource

idstring uuid

Unique identifier (GUID) for the subject resource

partnerIdinteger required

Unique identifier for the Partner who owns the product

namestring required

Unique name for the product

listingNamestring required

Name the product will be listed as on an Encompass application

requestTypesProductRequestType[] 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.

environment'sandbox' | 'production'

A products environment

status'development' | 'inReview' | 'approved' | 'deprecated'

A products status

integrationType'ASYNC' | 'P2P' required

Product integration pattern

interfaceUrlstring

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

adminInterfaceUrlstring

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

extensionLimitinteger

Number of allowed custom extensions to a products default data entitlements

createdstring date-time

Resource created/updated time-stamp (IS0 8601 UTC)

createdBystring

Entity that created/updated the subject resource

updatedstring date-time

Resource created/updated time-stamp (IS0 8601 UTC)

updatedBystring

Entity that created/updated the subject resource

Changes

No recorded changes to this endpoint across all 1 revision of this API.