DEVELOPER GUIDE
Stable
Property -Subject Property-30 Ordering Guide
Overview
Your system is ordering a ‘Property -Subject Property-30’ (aka ‘PropertyInvestigation’).
Get the URL from your Pitchpoint Account Representative of where you should be submitting your orders to.
Step 1: Authenticate and Receive Tokens
Refer to the Authentication Guide for detailed steps on authentication and token retrieval.
Step 2: Place an order
This request submits the order details.
Include the access token in the Authorization header following the Bearer keyword. Replace your_access_token_here with the actual token you obtained during the authentication process.
For further explanation of required mandatory fields and their meanings, refer to Property -Subject Property-30 API Reference
Example request
Property is the only mandatory term for a PropertyInvestigation. The following example orders a report using only the property address.
curl -X POST https://api.pointservices.com/riskinsight-services-ws/resources/v1/sami/PropertyInvestigation/PDF-001
-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"
}
} ]
}
}'
Example response
{
"TransactionID" : "0000000000011038343",
"CorrelationID" : "propertyinvestigation-001",
"Terms" : {
"Term" : [ {
"Property" : {
"AddressLine1" : "123 Main St",
"City" : "Anytown",
"State" : "CA",
"PostalCode" : "12345"
}
} ]
},
"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"
}
After submitting, you may have to wait a few minutes for the request to finish processing. When the request has returned, the results of the submission will be in the Messages.Message.Code section. A Status.Code of S001 indicates that the order was a billable transaction.
You can use the url provided in the Ref field to retrieve the order results again.
Other Examples
Including an Optional Borrower
Person is optional on a PropertyInvestigation, and can be included alongside Property to associate a borrower with the request.
curl -X POST https://api.pointservices.com/riskinsight-services-ws/resources/v1/sami/PropertyInvestigation/PDF-001
-H "Authorization: Bearer your_access_token_here"
-H "Content-Type: application/json"
-d '{
"CorrelationID" : "propertyinvestigation-002",
"Terms" : {
"Term" : [ {
"Property" : {
"AddressLine1" : "123 Main St",
"City" : "Anytown",
"State" : "CA",
"PostalCode" : "12345"
}
}, {
"Person" : {
"FirstName" : "Daffy",
"MiddleName" : "A",
"LastName" : "Duckerson",
"NameSuffix" : "Jr.",
"SSN" : "123121234"
}
} ]
}
}'
Example Response
{
"TransactionID" : "0000000000011038344",
"CorrelationID" : "propertyinvestigation-002",
"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/0000000000011038344"
}
Missing Input Data
Property.City, Property.State, and Property.PostalCode are missing.
curl -X POST https://api.pointservices.com/riskinsight-services-ws/resources/v1/sami/PropertyInvestigation/PDF-001
-H "Authorization: Bearer your_access_token_here"
-H "Content-Type: application/json"
-d '{
"CorrelationID" : "propertyinvestigation_missing_fields",
"Terms" : {
"Term" : [ {
"Property" : {
"AddressLine1" : "123 Main St",
"City" : "",
"State" : "",
"PostalCode" : ""
}
} ]
}
}'
Example Response
In this response, we see that Messages.Message.Category = Fault so we know that the submission of this order failed. Check the Messages.Message.Description for more details on how to correct.
{
"TransactionID" : "0000000000010129047",
"CorrelationID" : "propertyinvestigation_missing_fields",
"Terms" : {
"Term" : [ {
"Property" : {
"AddressLine1" : "123 Main St",
"City" : "",
"State" : "",
"PostalCode" : ""
}
} ]
},
"Messages" : {
"Message" : [ {
"Category" : "Fault",
"Code" : "E004",
"Description" : "/Inputs[1]/Input[1]/Loan[1]/Property[1]/Address[1]/City[1] is required."
}, {
"Category" : "Fault",
"Code" : "E004",
"Description" : "/Inputs[1]/Input[1]/Loan[1]/Property[1]/Address[1]/State[1] is required."
}, {
"Category" : "Fault",
"Code" : "E004",
"Description" : "/Inputs[1]/Input[1]/Loan[1]/Property[1]/Address[1]/PostalCode[1] is required."
} ]
},
"Status" : {
"Code" : "U001",
"Description" : "Unserviceable"
},
"Ref" : "https://api.pointservices.com/riskinsight-services-ws/resources/v1/sami/0000000000010129047"
}