API Reference

Transaction Request

{
  "type": "Appraisal",
  "loanFormat": "application/vnd.plm-2.0.0+json",
  "loan": {
    "property": {
      "city": "Pleasanton",
      "state": "CA",
      "county": "Alameda",
      "postalCode": "94588",
      "streetAddress": "4430 Rosewood Dr"
    },
    "loanNumber": "1911EM000412515"
  },
  "credentials": {
    "username": "donaldd",
    "password": "p@s$w0rd"
  },
  "requestingParty": {
    "name": "AMG Mortgage",
    "address": "4140 Dublin Blvd. #301",
    "city": "Santa Maria",
    "state": "CA",
    "postalCode": "93458",
    "pointOfContact": {
      "name": "Donald Duck",
      "email": "[email protected]",
      "phone": "666-666-6666"
    }
  },
  "options": {
    "testOptionBool": true,
    "testOptionNumber": 100,
    "testOptionString": "string",
    "testOptionObject": {
      "testOptionBool": true,
      "testOptionNumber": 100,
      "testOptionString": "string"
    }
  }
}

The transaction request is created by the lender - and for the life of the transaction, can only be updated by the lender. It comprises of the lender selected request type, lender selected options pertaining to the request, applicable loan data the partner is entitled to access in the context of the request, credentials configured for the requesting user, and contact information for the requesting user and lending organization.

👍

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 the transactions API endpoints in action!