The Services: Partner API provides lenders with the ability to place service requests and retrieve reports from service providers for services such as credit, electronic verification, appraisal and underwriting.

From a functional standpoint, the Services: Partner APIs primarily enable create, read and update operations on a Transaction object, which is a representation of an individual service transaction initiated with a service Partner.

A Transaction object is created when a Lender API user initiates a transaction by specifying the product (service) they would like to place an order for. Product related information is encapsulated within a Product object - which the API user will need to construct and post to the platform when creating a new transaction.

The Product Object

The Product object contains all the necessary product/service information needed for a service provider to contextualize and process a service request. Core attributes contained by the Product object are the product name, service credentials, reference to the loan in whose context the order is being placed and user preferences with respect to the product/service.

The Product object also includes the Options attribute, which encapsulates user selection for the various service options with respect to the product in question - for example, whether to order a new Credit service or reissue an existing request. The child attributes defined within the Options attribute can vary across service categories as well as across providers within a category. The schema for the Options attribute is defined for each individual product in the categorical sample pages below.

The Transaction Object

A Transaction object is created when a service transaction is initiated by a Lender API user with a Partner service provider. This object is unique for a given service request, and provides the mechanism for a Lender API user to track status and access the data and documents returned by the Partner as part of their response.

Ordering a product and retrieving a report from a service provider is an asynchronous process. Upon subscribing to Transaction webhooks, Lender API users will receive a webhook once a Partner service provider posts a response for a given service request (transaction).

Currently, there are two supported schemas for the Transaction object:

1. Transaction object: This schema is currently supported across all service categories. Metadata for view-able file formats returned by the Partner are made available within the documents attribute. These files can then be accessed using the Loan eFolder APIs. The Transaction schema attributes are described in the Transaction object attributes table.

2. Resource_Transaction object: This schema is currently supported for a limited number of service categories and products, as indicated within the categorical sample pages. Both viewable file formats and native file formats returned by the Partner are made available within the resources, given the API user has the necessary permissions. The Resource_Transaction schema attributes are described in the Resource_Transaction object attributes table.

Transaction Object

Resource_Transaction Object

{
  "status": "",
  "resources": [
    {
      "id": "",
      "name": "",
      "mimeType": "",
      "url": ""
    }
  ],
  "product": {
    "partnerID": "",
    "productName": "",
    "displayName": "",
    "category": "",
    "entityRef": {
      "entityId": "",
      "entityType": ""
    }
  }
}

{  
    "status":"",
    "documents":{  
        "id":"",
        "name":"",
        "attachments":[  
            {  
                "mimeType":"",
                "name":"",
                "content":{  
                    "createdDateTime":"",
                    "attachmentFile":""
                }
            }
        ]
    },
    "product":{  
        "partnerID":"",
        "productName":"",
        "displayName":"",
        "category":"",
        "entityRef":{  
            "entityId":"",
            "entityType":""
        }
    }
}