API REFERENCE

Stable

Property -Subject Property-30

Ordering a ‘Property -Subject Property-30’ (aka ‘PropertyInvestigation’) product.

Get the URL from your Pitchpoint Account Representative of where you should be submitting your orders to.

• Sample
  • Header Properties
  • Request Data Properties
    • Terms.Term.propertyOrPerson
    • Terms.Term.propertyOrPerson.Property
    • Terms.Term.propertyOrPerson.Person
• Responses
  • Attachments.Attachment

Sample

url="https://api.pointservices.com/riskinsight-services-ws/resources/v1/sami/PropertyInvestigation/PDF-001"
curl -X POST "${url}"
-H "Authorization: Bearer your_access_token_here"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
  "CorrelationID" : "propertyinvestigation-001",
  "Terms" : {
    "Term" : [ {
      "Property" : {
        "AddressLine1" : "123 Main St",
        "City" : "Anytown",
        "State" : "CA",
        "PostalCode" : "12345"
      }
    }, {
      "Person" : {
        "FirstName" : "Daffy",
        "MiddleName" : "A",
        "LastName" : "Duckerson",
        "NameSuffix" : "Jr.",
        "SSN" : "123121234"
      }
    } ]
  }
}
'

Header Properties

Property	Value	Required?
Content-Type	application/json	true
Accept	application/json	true
X-PPS-UserAlias	your value	false
X-PPS-Authorization-Alias	your value	false
X-PPS-CorrelationID	your value	false

See the Common Headers guide for details on the optional X-PPS-* headers above.

Request Data Properties

Property	Description	Type	Default
CorrelationID	(mandatory) A user-defined reference number to help identify the order. Does not need to be unique.	string
Terms	(mandatory) See section below for more details.	object

Terms.Term.propertyOrPerson

Property	Description	Type
Property	(mandatory) See section below for more details.	object
Person	(optional) aka a Borrower. See section below for more details.	object

Terms.Term.propertyOrPerson.Property

Property	Description	Type
AddressLine1	(mandatory) Line1 of the property address	string
City	(mandatory) City of the property address	string
State	(mandatory) State of the property address – 2-character code	string
PostalCode	(mandatory) 5 or 9 digit zip code of the property address	string

Terms.Term.propertyOrPerson.Person

Property	Description	Type
FirstName	(optional) First name of the person	string
MiddleName	(optional) Middle name of the person	string
LastName	(optional) Last name of the person	string
NameSuffix	(optional) Suffix of the person’s name, e.g. Jr.	string
SSN	(optional) Social Security Number of the person	string

Responses

200

The input data is echo-ed back with following additional fields:

Property	Description	Type
TransactionID	A Pitchpoint generated identifying string to uniquely identify this loan	string
	Messages.Message – A list of messages regarding the result of the order
Category	Typically one of Info or Fault to indicate whether or not this is an information message or an error message.	string
Code	Unique code for the Message. Typically, this is I001 when a report has been generated. A value starting with EXXX generally indicates an error.	string
Description	Description of the message	string
Ref	The url to query to retrieve the results of the order	string
	Status – An object that states the current status of the order as related to billing matters.
Code	The status code. This will typically be S001	string
Description	A description of the code	string
	Attachments – A list of report(s). Depending on your particular product configuration, you may get one or two reports.
Attachments	See section below for more details	object

Attachments.Attachment

Property	Description	Type
Document	A base64 encoded file	string
Classifier	Indicates what type of Attachment this is. Typically report	string
ContentDisposition	Metadata about the file	string
ContentType	The mimetype of the file	string
Extension
Extension.PropertyInvestigationReport	an xml representation of the report	object

Example:

{
  "TransactionID": "0000000000011038343",
  "CorrelationID": "propertyinvestigation-001",
  "Terms": {
    "Term": [
      {
        "Property": {
          "AddressLine1": "123 Main St",
          "City": "Anytown",
          "State": "CA",
          "PostalCode": "12345"
        }
      },
      {
        "Person": {
          "FirstName": "Daffy",
          "MiddleName": "A",
          "LastName": "Duckerson",
          "NameSuffix": "Jr.",
          "SSN": "123121234"
        }
      }
    ]
  },
  "Attachments" : {
    "Attachment" : [ {
      "Extension" : {
        "any" : "<?xml version=\"1.0\" encoding=\"UTF-16\"?>\n<PropertyInvestigationReport>...</PropertyInvestigationReport>"
      },
      "ContentType" : "text/xml"
    } ]
  },
  "Messages" : {
    "Message" : [ {
      "Category" : "Info",
      "Code" : "I001",
      "Description" : "Success"
    } ]
  },
  "Status" : {
    "Code" : "S001",
    "Description" : "Serviceable"
  },
  "Ref" : "https://api.pointservices.com/riskinsight-services-ws/resources/v1/sami/0000000000011038343"
}

For a complete list of possible Message