diff --git a/_api/order/enums/index.md b/_api/order/enums/index.md
new file mode 100644
index 0000000..2927aa9
--- /dev/null
+++ b/_api/order/enums/index.md
@@ -0,0 +1,7 @@
+---
+title: Enums
+layout: api_ref
+nav_order: 90
+has_children: true
+parent: Order
+---
diff --git a/_api/order/messagedef.md b/_api/order/enums/messagedef.md
similarity index 97%
rename from _api/order/messagedef.md
rename to _api/order/enums/messagedef.md
index 5206a41..21182c4 100644
--- a/_api/order/messagedef.md
+++ b/_api/order/enums/messagedef.md
@@ -2,11 +2,10 @@
title: Message
layout: api_ref
nav_order: 89
-parent: Order
+parent: Enums
datatable: true
---
-Beta
-{: .label .label-yellow }
+
#### Result Messages
List of Message codes.
@@ -64,4 +63,4 @@ List of Message codes.
-
\ No newline at end of file
+
diff --git a/_api/order/enums/types_employer.md b/_api/order/enums/types_employer.md
new file mode 100644
index 0000000..d675f63
--- /dev/null
+++ b/_api/order/enums/types_employer.md
@@ -0,0 +1,39 @@
+---
+title: Employer Enums
+layout: api_ref
+nav_order: 89
+parent: Enums
+datatable: true
+---
+
+List of Special Employer Names that do not require a phone number or address.
+
+| Employer Name |
+|---------------------------------|
+| 0 |
+| 99 |
+| 711 |
+| 999 |
+| 99999 |
+| Disabled |
+| Housewife |
+| House Wife |
+| Homemaker |
+| Home Maker |
+| NA |
+| N/A |
+| None |
+| Retired |
+| Retirement |
+| SS Disability |
+| SSI/DISABILITY |
+| Unemployed |
+| RETIRED- PENSION |
+| RETIRED SOCIAL SECURITY |
+| Retired SSI |
+| Retired United States Air Force |
+| RETIRED US MILITARY |
+| RETIRED US POST OFFICE |
+| retired/disabled |
+| RETIRED/SOCIAL SECURITY |
+| Retired-Union |
diff --git a/_api/order/enums/types_loanparticipant.md b/_api/order/enums/types_loanparticipant.md
new file mode 100644
index 0000000..6eca987
--- /dev/null
+++ b/_api/order/enums/types_loanparticipant.md
@@ -0,0 +1,179 @@
+---
+title: Loan Participant Type
+layout: api_ref
+nav_order: 89
+parent: Enums
+datatable: true
+---
+Beta
+{: .label .label-yellow }
+#### Loan Participant Type
+
+List of Loan Participant Type codes.
+
+
+
+| Code | Description |
+|-------------------------------------|-------------------|
+| ACCOUNTING | |
+| APPRAISAL_COMPANY | Appraisal Company |
+| APPRAISER | |
+| ASSIGNEE | |
+| ASSIGNOR | |
+| ATTORNEY | |
+| ATTORNEY_IN_FACT | |
+| AUTHORIZED_REPRESENTATIVE | |
+| AUTHORIZED_THIRD_PARTY | |
+| BANKRUPTCY_FILER | |
+| BANKRUPTCY_TRUSTEE | |
+| BENEFICIAL_INTEREST_PARTY | |
+| BENEFICIARY | |
+| BILL_TO_PARTY | |
+| BORROWER_ALIAS | |
+| BROKER | |
+| BUILDER | |
+| BUILDER_OR_SELLER | |
+| BUYER_ATTORNEY | |
+| BUYER_REAL_ESTATE_AGENT | |
+| CERTIFIED_203_K_CONTRACTING_COMPANY | |
+| CERTIFIED_203_K_CONTRACTOR | |
+| CLIENT | |
+| CLOSER | |
+| CLOSING_AGENT | |
+| CLOSING_ATTORNEY | |
+| CLOSING_COMPANY | |
+| COMPLIANCE | |
+| CONSERVATOR | |
+| CONTRACTOR | |
+| COOPERATIVE_COMPANY | |
+| CORRESPONDENT_LENDER | |
+| COSIGNER | |
+| CREDITOR | |
+| CREDIT_COMPANY | |
+| CREDIT_COUNSELING_AGENT | |
+| CREDIT_ENHANCEMENT_RISK_HOLDER | |
+| CUSTODIAN | |
+| CUSTODIAN_NOTE_PAY_TO | |
+| DELIVER_RESCISSION_TO | |
+| DOCUMENT_CUSTODIAN | |
+| DOC_PREPARER | |
+| DOC_SIGNING | |
+| EMPLOYER | |
+| ESCROW | |
+| EXECUTOR | |
+| E_NOTE_CONTROLLER | |
+| E_NOTE_CONTROLLER_TRANSFEREE | |
+| E_NOTE_CUSTODIAN | |
+| E_NOTE_CUSTODIAN_TRANSFEREE | |
+| E_NOTE_DELEGATEE_FOR_TRANSFERS | |
+| E_NOTE_REGISTERING_PARTY | |
+| E_NOTE_SERVICER | |
+| E_NOTE_SERVICER_TRANSFEREE | |
+| E_NOTE_TRANSFER_INITIATOR | |
+| FHA_SPONSOR | |
+| FINANCIAL_PLANNER | |
+| FLOOD_DETERMINATION | |
+| FLOOD_INSURANCE | |
+| FULFILLMENT_PARTY | |
+| GIFT_DONOR | |
+| GRANTEE | |
+| GRANTOR | |
+| HAZARD_INSURANCE | |
+| HAZARD_INSURANCE_AGENT | |
+| HOMEOWNER_ASSOCIATION | |
+| HUD_1_SETTLEMENT_AGENT | |
+| INSPECTOR | |
+| INTERVIEWER | |
+| INTERVIEWER_EMPLOYER | |
+| INVESTOR | |
+| IRS_TAX_FORM_THIRD_PARTY | |
+| LANDLORD_COMPANY | |
+| LANDLORD_INDIVIDUAL | |
+| LAW_FIRM | |
+| LENDER | |
+| LENDER_ATTORNEY | |
+| LENDER_BRANCH | |
+| LIEN_HOLDER | |
+| LISTING_REAL_ESTATE_AGENT | |
+| LOAN_DELIVERY_FILE_PREPARER | |
+| LOAN_OFFICER | |
+| LOAN_ORIGINATOR | |
+| LOAN_PROCESSOR | |
+| LOAN_SELLER | |
+| LOAN_UNDERWRITER | |
+| LOSS_PAYEE | |
+| MANAGEMENT_COMPANY | |
+| MORTGAGE_BROKER | |
+| MORTGAGE_INSURANCE_AGENT | |
+| MORTGAGE_INSURANCE_COMPANY | |
+| MORTGAGE_SERVICER_COMPANY | |
+| NON_TITLE_SPOUSE | |
+| NOTARY | |
+| NOTE_PAY_TO | |
+| NOTE_PAY_TO_RECIPIENT | |
+| OTHER | |
+| OTHER_COMPANY | |
+| OTHER_INDIVIDUAL | |
+| PAYEE | |
+| PLEDGE_ORIGINATION_COMPANY | |
+| PLEDGE_SETTLEMENT_AGENT | |
+| PLEDGE_SETTLEMENT_COMPANY | |
+| POOL_INSURER | |
+| POOL_ISSUER | |
+| POOL_ISSUER_TRANSFEREE | |
+| POST_CLOSER | |
+| POWER_OF_ATTORNEY | |
+| PREPARED_BY | |
+| PROCESSOR | |
+| PROJECT_DEVELOPER | |
+| PROJECT_MANAGEMENT_AGENT | |
+| PROPERTY_ACCESS_CONTACT | |
+| PROPERTY_OWNER | |
+| REAL_ESTATE_AGENT | |
+| RECEIVING_PARTY | |
+| REGISTRY_OPERATOR | |
+| REGULATORY_AGENCY | |
+| REGULATORY_AGENT | |
+| REQUESTING_PARTY | |
+| RESPA_SERVICE_PROVIDER | |
+| RESPONDING_PARTY | |
+| RESPOND_TO_PARTY | |
+| RETURN_TO | |
+| REVIEW_APPRAISER | |
+| SECURITY_ISSUER | |
+| SELLER | |
+| SELLER_ATTORNEY | |
+| SELLER_REAL_ESTATE_AGENT | |
+| SELLING_REAL_ESTATE_AGENT | |
+| SERVICER_PAYMENT_COLLECTION | |
+| SERVICE_BUREAU | |
+| SERVICE_PROVIDER | |
+| SERVICING | |
+| SETTLOR | |
+| SHIPPER | |
+| SPOUSE | |
+| SUBMITTING_PARTY | |
+| SUPERVISORY_APPRAISER | |
+| SURVEYOR | |
+| TAXABLE_PARTY | |
+| TAXPAYER | |
+| TAX_SERVICER | |
+| TAX_SERVICE_PROVIDER | |
+| THIRD_PARTY_INVESTOR | |
+| THIRD_PARTY_ORIGINATOR | |
+| TITLE_AGENT | |
+| TITLE_COMPANY | |
+| TITLE_HOLDER | |
+| TITLE_UNDERWRITER | |
+| TRUST | |
+| TRUSTEE | |
+| TRUST_BENEFICIARY | |
+| UNDERWRITER | |
+| WAREHOUSE | |
+| WARRANTOR | |
+| WITNESS | |
+
+
+
+
+
diff --git a/_api/order/enums/types_property.md b/_api/order/enums/types_property.md
new file mode 100644
index 0000000..7aced53
--- /dev/null
+++ b/_api/order/enums/types_property.md
@@ -0,0 +1,50 @@
+---
+title: Property Types
+layout: api_ref
+nav_order: 89
+parent: Enums
+datatable: true
+---
+Beta
+{: .label .label-yellow }
+#### Property Usage Type
+
+List of Property Usage Type codes.
+
+
+
+| Code | Description |
+|--------------------------|-------------------|
+| INVESTMENT | |
+| OTHER | |
+| PRIMARY_RESIDENCE | |
+| SECOND_HOME | |
+
+
+
+
+#### Property Type
+
+List of Property Usage Type codes.
+
+
+
+| Code | Description |
+|-----------------------------------------------------|-------------|
+| ATTACHED | |
+| CONDOMINIUM | |
+| COOPERATIVE | |
+| DETACHED | |
+| DETACHED_CONDOMINIUM | |
+| HIGH_RISE_CONDOMINIUM | |
+| MANUFACTURED_HOME_CONDOMINIUM | |
+| MANUFACTURED_HOME_CONDOMINIUM_OR_PUD_OR_COOPERATIVE | |
+| MANUFACTURED_HOUSING | |
+| MANUFACTURED_HOUSING_DOUBLE_WIDE | |
+| MANUFACTURED_HOUSING_MULTI_WIDE | |
+| MANUFACTURED_HOUSING_SINGLE_WIDE | |
+| MODULAR | |
+| OTHER | |
+| PUD | |
+
+
diff --git a/_api/order/order_adv.md b/_api/order/order_adv.md
new file mode 100644
index 0000000..3d783b7
--- /dev/null
+++ b/_api/order/order_adv.md
@@ -0,0 +1,296 @@
+---
+title: ADV
+layout: api_ref
+nav_order: 2
+parent: Order
+datatable: true
+---
+Stable
+{: .label .label-green }
+
+## Order
+
+Ordering an ADV product.
+
+{: .before_starting }
+Get the URL from your Pitchpoint Account Representative of where you should be submitting your orders to.
+
+
+```bash
+url="https://api.pointservices.com/riskinsight-services-ws/resources/v1/sami/ADV/ADV-120J"
+data='{
+ "CorrelationID" : "12345",
+ "Terms" : {
+ "Term" : [ {
+ "Person" : {
+ "FirstName" : "John",
+ "MiddleName" : "A",
+ "LastName" : "Doe",
+ "NameSuffix" : "Jr.",
+ "SSN" : "123-45-6789",
+ "DOB" : "01/01/1980",
+ "Gender" : "M",
+ "HomePhone" : "123-456-7890",
+ "Residences" : {
+ "Residence" : [ {
+ "Address" : {
+ "AddressLine1" : "123 Main St",
+ "City" : "Anytown",
+ "State" : "CA",
+ "PostalCode" : "12345",
+ "County" : "AnyCounty"
+ },
+ "CurrentIndicator" : true
+ } ]
+ },
+ "Employers" : {
+ "Employer" : [ {
+ "Name" : "ABC Corp",
+ "Phone" : "987-654-3210",
+ "EIN" : "12-3456789",
+ "MonthlyIncome" : "5000",
+ "MonthsOnJob" : "24",
+ "YearsOnJob" : "2",
+ "Address" : {
+ "AddressLine1" : "123 Main St",
+ "City" : "Anytown",
+ "State" : "CA",
+ "PostalCode" : "12345",
+ "County" : "AnyCounty"
+ },
+ "CurrentIndicator" : true,
+ "SelfEmployedIndicator" : false
+ } ]
+ },
+ "Declarations" : {
+ "AlimonyChildSupportObligationIndicator" : false,
+ "BorrowedDownPaymentIndicator" : false,
+ "CitizenshipResidencyType" : "PermanentResidentAlien",
+ "CoMakerEndorserOfNoteIndicator" : false,
+ "HomeownerPastThreeYearsIndicator" : true,
+ "IntentToOccupyIndicator" : true,
+ "LoanForeclosureOrJudgementIndicator" : false,
+ "OutstandingJudgementsIndicator" : false,
+ "PartyToLawsuitIndicator" : false,
+ "PresentlyDelinquentIndicator" : false,
+ "PriorPropertyTitleType" : "JointWithSpouse",
+ "PriorPropertyUsageType" : "PrimaryResidence",
+ "PriorPropertyUsageTypeOtherDescription" : "N/A",
+ "PropertyForeclosedPastSevenYearsIndicator" : false,
+ "BorrowerFirstTimeHomebuyerIndicator" : true
+ }
+ }
+ }, {
+ "Property" : {
+ "Address" : {
+ "AddressLine1" : "123 Apple St",
+ "City" : "Bearsville",
+ "State" : "CA",
+ "PostalCode" : "12345",
+ "County" : "Carrot County"
+ },
+ "SupplementaryId" : "SUPP123",
+ "AssessorsParcelNumber" : "APN123",
+ "CountyFIPSCode" : "12345",
+ "SaleDate" : "01/01/2020",
+ "SaleAmount" : "300000",
+ "AssessmentDate" : "01/01/2021",
+ "AssessmentAmount" : "350000",
+ "PropertyUsage" : "PrimaryResidence",
+ "PropertyUsageOtherDescription" : "N/A",
+ "PropertyType" : "DetachedCondominium",
+ "PropertyTypeOtherDescription" : "N/A",
+ "NumberOfUnits" : "1",
+ "Valuations" : {
+ "Valuation" : [ {
+ "ValuationType" : "Appraisal",
+ "ValuationTypeOtherDescription" : "N/A",
+ "ValuationAmount" : "350000"
+ } ]
+ },
+ "OwnerName" : "John Doe"
+ }
+ }, {
+ "Participant" : {
+ "FirstName" : "Jane",
+ "MiddleName" : "B",
+ "LastName" : "Smith",
+ "CompanyName" : "XYZ Corp",
+ "ParticipantType" : "Appraiser",
+ "ContactPoint" : {
+ "RoleType" : "Mobile",
+ "Type" : "Phone",
+ "Value" : "1234567890",
+ "PreferenceIndicator" : true
+ },
+ "Address" : {
+ "AddressLine1" : "123 Dunkin St",
+ "City" : "Frisco",
+ "State" : "CA",
+ "PostalCode" : "12345",
+ "County" : "Eagle Ridge County"
+ },
+ "Licenses" : {
+ "License" : [ {
+ "LicenseNumber" : "LIC123",
+ "LicenseType" : "Appraiser License",
+ "LicenseState" : "CA"
+ } ]
+ }
+ }
+ } ]
+ }
+}'
+
+curl -X POST "${url}"
+-H "Authorization: Bearer your_access_token_here"
+-H "Content-Type: application/json"
+-H "Accept: application/json"
+-d "${data}"
+```
+
+#### Header Properties
+{% include_relative api_includes/header_properties_json.md %}
+
+
+#### Request Data Properties
+
+
+| Property | Description | Type |
+|---------------|------------------------------------------------------------------------------------------------------|--------|
+| TransactionID | Only mandatory when refreshing a previously ordered ADV | string |
+| 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.personOrPropertyOrParticipant
+
+
+| Property | Description | Type |
+|--------------------|--------------------------------------------------------------------------|--------|
+| Person | (mandatory) aka a `Borrower`. See section below for more details. | object |
+| Participant | (optional) aka a `Loan Participant`. See section below for more details. | object |
+| Property | (optional) See section below for more details. | object |
+
+
+
+##### Terms.Term.personOrPropertyOrParticipant.Person
+
+
+| Property | Description | Type |
+|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
+| FirstName | (mandatory) First name of the person | string |
+| MiddleName | (optional) Middle name of the person | string |
+| LastName | (mandatory) Last name of the person | string |
+| HomePhone | (mandatory) Home phone number -- in the `NNN-NNN-NNNN` or `(NNN) NNN-NNNN` or `NNNNNNNNNN` format | string |
+| DOB | (mandatory) Date of Birth -- in the `MM/DD/YYYY` format | string |
+| SSN | (mandatory) Social Security Number of the person -- in the `NNN-NN-NNNN` or `NNNNNNNNN` format | string |
+| | (mandatory) Residences.Residence | |
+| CurrentIndicator | (mandatory) Indicates whether the address is the current place of residence. | boolean |
+| | (mandatory) Residences.Residence.Address | |
+| AddressLine1 | (mandatory) Line1 of the residence of a person | string |
+| City | (mandatory) City of the residence of a person | string |
+| State | (mandatory) State of the residence of a person. 2-character code indicating which state. | string |
+| PostalCode | (mandatory) 5 or 9 digit zip code of the residence. | string |
+| | (optional) Employers.Employer -- this section is optional, but if provided the following becomes mandatory: | |
+| Name | (mandatory) Name of the Employer. If the Employer object is added, then a `Name` is mandatory. For special cases like `Housewife` or `Retired` where there are no associated Employer Address, then the Address and Phone number become optional. See [Employer](/api/order/enums/types_employer) for more special names. | string |
+| Phone | (mandatory) in the `NNN-NNN-NNNN` or `(NNN) NNN-NNNN` or `NNNNNNNNNN` format | string |
+| | (mandatory) Employers.Employer.Address | |
+| AddressLine1 | (mandatory) Line1 of the address | string |
+| City | (mandatory) City of the address | string |
+| State | (mandatory) State of the address. 2-character code indicating which state. | string |
+| PostalCode | (mandatory) 5 or 9 digit zip code of the address. | string |
+| _all other fields_ | (optional) other fields are optional | |
+
+
+
+##### Terms.Term.personOrPropertyOrParticipant.Participant
+
+
+| Property | Description | Type |
+|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
+| ParticipantType | (mandatory) The type of Participant, depending on the type set, (person vs company), various fields will become mandatory while others are optional. | string |
+
+
+
+See [Loan Participant Type](/api/order/enums/types_loanparticipant/) for a list of possible `ParticipantType` values.
+
+
+##### Terms.Term.personOrPropertyOrParticipant.Property
+
+
+| Property | Description | Type |
+|--------------------|-------------------------------------------------------------------------------------------|--------|
+| | The entire Property section is optional, but if included, the following becomes mandatory | |
+| | (mandatory) Address | object |
+| AddressLine1 | (mandatory) Line1 of the propery of a person | string |
+| City | (mandatory) City of the property of a person | string |
+| State | (mandatory) State of the property of a person. 2-character code indicating which state. | string |
+| PostalCode | (mandatory) 5 or 9 digit zip code of the property. | string |
+| PropertyUsage | (optional) See enums at: [Property Type](/api/order/enums/types_property/) | string |
+| PropertyType | (optional) See enums at: [Property Type](/api/order/enums/types_property/) | string |
+| _all other fields_ | (optional) other fields are optional | string |
+
+
+
+See [Property Type](/api/order/enums/types_property/) for a list of possible enum values.
+
+
+
+### Responses
+
+200
+{: .label .label-green }
+
+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 `I004` when an order has initially been submitted, as PPS is still processing the order. When the report has successfully been generated, you should see a value of `I001`. 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 `U001` during the ordering phase as Pitchpoint has not completed generating the reports. However once the report has been successfully generated this will typically become `S001` | string |
+| Description | A description of the code | string |
+
+
+
+
+Example:
+```json
+{
+ "TransactionID": "0000000000000134076",
+ "(echoed input data)": ...,
+ "Attachments" : {
+ "Attachment" : [ {
+ "Document" : "RW5jb2RlZCBEb2N1bWVudCBoZXJl",
+ "Classifier" : "report",
+ "ContentDisposition" : "inline; filename=\"ADV120\"; creation-date=\"Wed, 05 Mar 2014 14:52:07 EST\"; modification-date=\"Wed, 05 Mar 2014 14:52:07 EST\"; read-date=\"Wed, 05 Mar 2014 14:52:07 EST\"; size=131536",
+ "ContentType" : "application/pdf"
+ } ]
+ },
+ "Messages" : {
+ "Message" : [ {
+ "Category" : "Info",
+ "Code" : "I001",
+ "Description" : "Success"
+ } ]
+ },
+ "Status" : {
+ "Code" : "S001",
+ "Description" : "Serviceable"
+ },
+ "Ref" : "https://api.pointservices.com/riskinsight-services-ws/resources/v1/sami/0000000000000511164"
+}
+```
+
+For a complete list of possible [Message](/api/order/enums/messagedef/)
+
+
+
diff --git a/_api/order/order_irs8821transcript.md b/_api/order/order_irs8821transcript.md
index ecafc1d..caa257b 100644
--- a/_api/order/order_irs8821transcript.md
+++ b/_api/order/order_irs8821transcript.md
@@ -242,7 +242,7 @@ Example:
}
```
-For a complete list of possible [Message](/api/order/messagedef/)
+For a complete list of possible [Message](/api/order/enums/messagedef/)
diff --git a/_api/order/order_ssaform89ecbsv.md b/_api/order/order_ssaform89ecbsv.md
index 7bd9980..e9389f0 100644
--- a/_api/order/order_ssaform89ecbsv.md
+++ b/_api/order/order_ssaform89ecbsv.md
@@ -173,7 +173,7 @@ Example:
}
```
-For a complete list of possible [Message](/api/order/messagedef/)
+For a complete list of possible [Message](/api/order/enums/messagedef/)
diff --git a/_developer_guides/orders/ADV.md b/_developer_guides/orders/ADV.md
new file mode 100644
index 0000000..d617a15
--- /dev/null
+++ b/_developer_guides/orders/ADV.md
@@ -0,0 +1,507 @@
+---
+title: ADV
+layout: dev_guide
+parent: Orders
+nav_order: 5
+---
+Beta
+{: .label .label-yellow }
+# ADV Ordering Guide
+{:.no_toc}
+
+* TOC
+{: toc}
+
+
+
+## Overview
+Your system is ordering an ADV.
+
+
+{: .before_starting }
+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](/developer_guides/authentication/access_token/) for detailed steps on authentication and token retrieval.
+
+
+### Step 2: Place an order
+
+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.
+
+{: .api_ref }
+For further explanation of required mandatory fields and their meanings, refer to [ADV API Reference](/api/order/order_adv)
+
+
+#### Example 2 Borrowers Request
+Ordering an ADV with two borrowers.
+
+
+```bash
+curl -X POST https://api.pointservices.com/riskinsight-services-ws/resources/v1/sami/ADV/ADV-120
+-H "Authorization: Bearer your_access_token_here"
+-H "Content-Type: application/json"
+-H "Accept: application/json"
+-d '{
+ "CorrelationID" : "SAMI_ADV120_1534192619544",
+ "Terms" : {
+ "Term" : [ {
+ "Person" : {
+ "FirstName" : "Melvin",
+ "LastName" : "Frost",
+ "SSN" : "123334444",
+ "DOB" : "11/11/1977",
+ "HomePhone" : "6128883322",
+ "Residences" : {
+ "Residence" : [ {
+ "Address" : {
+ "AddressLine1" : "2824 Pumpkin Avenue",
+ "City" : "Minneapolis",
+ "State" : "mn",
+ "PostalCode" : "55408"
+ },
+ "CurrentIndicator" : true
+ } ]
+ },
+ "Employers" : {
+ "Employer" : [ {
+ "Name" : "Google",
+ "Phone" : "650 253 0000",
+ "Address" : {
+ "AddressLine1" : "1600 Amphitheatre Parkway",
+ "City" : "Mountain View",
+ "State" : "CA",
+ "PostalCode" : "94043"
+ },
+ "CurrentIndicator" : true
+ } ]
+ }
+ }
+ }, {
+ "Person" : {
+ "FirstName" : "JETHRO",
+ "LastName" : "CCLAMPETT",
+ "SSN" : "222014141",
+ "DOB" : "10/25/1966",
+ "HomePhone" : "5556663333",
+ "Residences" : {
+ "Residence" : [ {
+ "Address" : {
+ "AddressLine1" : "12 Some Address",
+ "City" : "SomeCity",
+ "State" : "AL",
+ "PostalCode" : "55408"
+ },
+ "CurrentIndicator" : true
+ } ]
+ },
+ "Employers" : {
+ "Employer" : [ {
+ "Name" : "Thornton & Thornton",
+ "Phone" : "612 861 8619",
+ "Address" : {
+ "AddressLine1" : "7128 James Ave S",
+ "City" : "Minneapolis",
+ "State" : "MN",
+ "PostalCode" : "55423"
+ },
+ "CurrentIndicator" : true
+ } ]
+ }
+ }
+ }, {
+ "Property" : {
+ "Address" : {
+ "AddressLine1" : "210 PeachTree Rd",
+ "City" : "Oakboro",
+ "State" : "nc",
+ "PostalCode" : "28129"
+ }
+ }
+ } ]
+ }
+}'
+```
+
+
+If you plan on ordering a `Refresh` later, it is recommended that you keep a copy of the original request (or ensure you're able to generate it again).
+
+
+
+#### Example response
+
+```json
+{
+ "TransactionID" : "0000000000001857105",
+ "CorrelationID" : "SAMI_ADV120_1534193229528",
+ "Terms" : {
+ "Term" : [ { /* trimmed for brevity */ } ]
+ },
+ "Attachments" : {
+ "Attachment" : [ {
+ "Extension" : {
+ "any" : "\n2018-08-13T16:47:12.573-04:00SAMI_ADV120_1534193229528Melvin Frost2824 Pumpkin AvenueMinneapolisMINNESOTA55408123-33-444411/11/1977(612) 888-3322(home) (650) 253-0000(business)\n\t\t\t\t\t991Phone and Zip code mismatch.\n\t\t\t\t\t\t\t2Date Of Birth could not be verified\n\t\t\t\t\t\t\t3Name not reported at Address\n\t\t\t\t\t\t\t4Phone Number could not be verified\n\t\t\t\t\t\t\t5Neighborhood risk interaction.\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\tMelvinFailed\n\t\t\t\t\t\tFrostFailed\n\t\t\t\t\t\t2824 Pumpkin AvenueFailedAddress is invalid.Name not reported at AddressNeighborhood risk interaction.\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t(612) 888-3322FailedNo Name or Address reported with PhonePhone and Zip code mismatch.Phone Number could not be verified\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t123-33-4444Failed\n\t\t\t\t\t\t1977-11-11FailedDate Of Birth could not be verified\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t55408FailedNo match to zip+4 file\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\tPass\n\t\t\t\t\t\tPass\n\t\t\t\t\t\tPass\n\t\t\t\t\t\tFail\n\t\t\t\t\t\tn/a\n\t\t\t\t\t\t\t\n\t\t\t\t\t\tn/a\n\t\t\t\t\t\t\t\n\t\t\t\t\t\tn/a\n\t\t\t\t\t\t\t\n\t\t\t\t\t\tn/a\n\t\t\t\t\t\t\t\n\t\t\t\t\t\tn/a\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t0\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t"
+ },
+ "ContentType" : "text/xml"
+ }, {
+ "Extension" : {
+ "any" : "\n123334444\n\t\t\t\t\t\n\t\t\t\t"
+ },
+ "ContentType" : "text/xml"
+ }, {
+ "Extension" : {
+ "any" : "\n2018-08-13T16:47:14.215-04:00SAMI_ADV120_1534193229528JETHRO CCLAMPETT12 Some AddressSomeCityALABAMA55408222-01-414110/25/1966(555) 666-3333(home) (612) 861-8619(business)\n\t\t\t\t\t991Social Issued Before DOB\n\t\t\t\t\t\t\t2Social belongs to a deceased individual\n\t\t\t\t\t\t\t3Phone reported only with different name(s) or Address(es)\n\t\t\t\t\t\t\t4Name not reported at Address\n\t\t\t\t\t\t\t5Phone Number could not be verified\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\tJETHROPass08/01/2018\n\t\t\t\t\t\tCCLAMPETTPass07/28/2018\n\t\t\t\t\t\t12 Some AddressFailedAddress is invalid.Name not reported at Address\n\t\t\t\t\t\t\t07/28/2018123 BEVERLY HILLS DRAlternate\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t(555) 666-3333FailedPhone reported only with different First name(s)Phone reported only with different Last name(s)Phone reported only with different Address(es)Phone reported only with different name(s) or Address(es)Phone Number could not be verified\n\t\t\t\t\t\t\t08/01/2018\n\t\t\t\t\t\t222-01-4141PassDeceased Identity Found with No Name MatchSocial Issued Before DOBSocial belongs to a deceased individual\n\t\t\t\t\t\t\t08/01/2018\n\t\t\t\t\t\t1966-10-25Close Match08/01/2018\n\t\t\t\t\t\t55408FailedNo match to zip+4 file\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\tPass\n\t\t\t\t\t\tPass\n\t\t\t\t\t\tFail\n\t\t\t\t\t\tFail\n\t\t\t\t\t\tn/a\n\t\t\t\t\t\t\t\n\t\t\t\t\t\tn/a\n\t\t\t\t\t\t\t\n\t\t\t\t\t\tn/a\n\t\t\t\t\t\t\t\n\t\t\t\t\t\tn/a\n\t\t\t\t\t\t\t\n\t\t\t\t\t\tn/a\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t0\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t"
+ },
+ "ContentType" : "text/xml"
+ }, {
+ "Extension" : {
+ "any" : "\nMelvinFrost\n\t\t\t\t\t\t12333444411111977\n\t\t\t\t\t\t\n\t\t\t\t\tThe Social Security Number supplied is incorrect. Please verify and resubmit your order.\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t"
+ },
+ "ContentType" : "text/xml"
+ }, {
+ "Extension" : {
+ "any" : "\n2018813204713690\n\t\t\t\t\t\t\n\t\t\t\t\tMelvin FrostMelvinFrost12333444419771111\n\t\t\t\t\t\t\t2824 Pumpkin Avenue Minneapolis, MN 5540861288833222824 Pumpkin AvenueMinneapolisMN55408\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\tYes8NoYesYesYesUnknown ResultNo matchNoNoNoNot PerformedNo Input Data0\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t0\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t"
+ },
+ "ContentType" : "text/xml"
+ }, {
+ "Extension" : {
+ "any" : "\n222014141\n\t\t\t\t\tActive9999902000040000235398 41WK VW DSW 6DASTORIANY1110599936539841WK VW DSW 6D\n\t\t\t\t\t\t\t$400,000342009\n\t\t\t\t\t\t\tJETHROCCLAMPETT\n\t\t\t\t\t\t\tY132010\n\t\t\t\t\t\t\tPNC Bank, N.A.1002320NN\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t"
+ },
+ "ContentType" : "text/xml"
+ }, { /* trimmed for brevity */ },
+ {
+ "Document" : "JVBERi0xLjUKJd/++LIKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMyAwIFIvTGFuZyhlbi1VUykvTmFtZXMgNCAwIFIvTWV0YWRhdGEgNSAwIFI+PgplbmRvYmoKNSAwIG9iago8PC9UeXBlL01ldGFkYXRhL1N1YnR5cGUvWE1ML0xlbmd0aCAxMDc2Pj5zdHJlYW0NCjw/eHBhY2tldCBiZWdpbj0n77u/JyBpZD0nVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkJz8+Cjw/eHBhY2tldCBiZWdpbj0n77u/JyBpZD0nVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkJz8+PHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQkZPWE1QIDEuMS42Mi1yMjYyMzIiPjxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3lu.....",
+ "Classifier" : "report",
+ "ContentDisposition" : "inline; filename=\"ADV120Test\"; creation-date=\"Mon, 13 Aug 2018 16:47:28 EDT\"; modification-date=\"Mon, 13 Aug 2018 16:47:28 EDT\"; read-date=\"Mon, 13 Aug 2018 16:47:29 EDT\"; size=182184",
+ "ContentType" : "application/pdf" }
+ ]
+ },
+ "Messages" : {
+ "Message" : [ {
+ "Category" : "Info",
+ "Code" : "I001",
+ "Description" : "Success"
+ } ]
+ },
+ "Status" : {
+ "Code" : "S001",
+ "Description" : "Serviceable"
+ },
+ "Ref" : "https://api.pointservices.com/riskinsight-services-ws/resources/v1/sami/0000000000001857105"
+}
+```
+
+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.
+
+
+
+Make note of the `TransactionID` that was returned. Especially if you plan to order a refresh later.
+
+
+
+### Step 3: Ordering a Refresh
+
+{: .before_starting }
+Get the REFRESH URL from your Pitchpoint Account Representative.
+
+Before you're able to order the refresh, you must first get the `OrderGuid` of the transaction that you just ordered.
+Refer to [Querying](/api/order/query) for more information. A sample query might be:
+
+```bash
+curl -X POST https://api.pointservices.com/riskinsight-services-ws/resources/v1/orders/query
+-H "Authorization: Bearer your_access_token_here"
+-H "Content-Type: application/json"
+
+{
+ "filters": {
+ "ReferenceNumber": {
+ "eq": "SAMI_ADV120_1534193229528"
+ }
+ }
+}
+
+```
+
+Use the `CorrelationID` from the previous request to populate the `ReferenceNumber` field.
+
+
+#### Example response
+
+
+```json
+{
+ "count": 1,
+ "filters": {
+ "ReferenceNumber": {
+ "ge": "SAMI_ADV120_1534193229528"
+ }
+ },
+ "limit": 100,
+ "results": [
+ {
+ "Completed": "2024-04-09T18:50:06.000Z",
+ "Created": "2024-04-09T18:50:03.000Z",
+ "Deleted": false,
+ "Fulfilled": "2024-04-09T18:50:03.000Z",
+ "OrderGuid": "0000000000014623826",
+ "OrderSummary": "Melvin Frost & Jethro Cclamptett",
+ "OwnerCompanyName": "My Company",
+ "OwnerUserContactMechanism": "sample.user@user.com",
+ "OwnerUserDisplayName": "User, Sample",
+ "ProductDisplayName": "ADV Enterprise",
+ "ProductType": "ADV",
+ "ReferenceNumber": "SAMI_ADV120_1534193229528",
+ "ReportAvailable": true,
+ "Status": "complete"
+ }
+ ]
+}
+
+```
+
+If the `ReferenceNumber` was not unique, you may get multiple results. Select the `OrderGuid` from the result that you want to refresh.
+
+
+Add the `TranasactionID` to the original request and make any additional modifications to the request as required.
+
+Using the `OrderGuid` retrieved from the previous request, order the refresh using the modified original request.
+
+```bash
+# Note: We've added the `TransactionID` to the request, since we are telling the system that we wish to target the
+# refresh on the `0000000000001857105` loan.
+# Note: We've added a middle name to Melvin Frost
+# Note: All other data is the same as the original request. Any data that is not submitted, is considered _removed_.
+# Note: `OrderGuid` is used in the URL as the last part of the path.
+
+curl -X POST https://api.pointservices.com/riskinsight-services-ws/resources/v1/sami/ADV/refresh/0000000000014623826
+-H "Authorization: Bearer your_access_token_here"
+-H "Content-Type: application/json"
+-H "Accept: application/json"
+-d '{
+ "TransactionID" : "0000000000001857105",
+ "CorrelationID" : "SAMI_ADV120_1534192619544",
+ "Terms" : {
+ "Term" : [ {
+ "Person" : {
+ "FirstName" : "Melvin",
+ "MiddleName" : "A",
+ "LastName" : "Frost",
+ "SSN" : "123334444",
+ "DOB" : "11/11/1977",
+ "HomePhone" : "6128883322",
+ "Residences" : {
+ "Residence" : [ {
+ "Address" : {
+ "AddressLine1" : "2824 Pumpkin Avenue",
+ "City" : "Minneapolis",
+ "State" : "mn",
+ "PostalCode" : "55408"
+ },
+ "CurrentIndicator" : true
+ } ]
+ },
+ "Employers" : {
+ "Employer" : [ {
+ "Name" : "Google",
+ "Phone" : "650 253 0000",
+ "Address" : {
+ "AddressLine1" : "1600 Amphitheatre Parkway",
+ "City" : "Mountain View",
+ "State" : "CA",
+ "PostalCode" : "94043"
+ },
+ "CurrentIndicator" : true
+ } ]
+ }
+ }
+ }, {
+ "Person" : {
+ "FirstName" : "JETHRO",
+ "LastName" : "CCLAMPETT",
+ "SSN" : "222014141",
+ "DOB" : "10/25/1966",
+ "HomePhone" : "5556663333",
+ "Residences" : {
+ "Residence" : [ {
+ "Address" : {
+ "AddressLine1" : "12 Some Address",
+ "City" : "SomeCity",
+ "State" : "AL",
+ "PostalCode" : "55408"
+ },
+ "CurrentIndicator" : true
+ } ]
+ },
+ "Employers" : {
+ "Employer" : [ {
+ "Name" : "Thornton & Thornton",
+ "Phone" : "612 861 8619",
+ "Address" : {
+ "AddressLine1" : "7128 James Ave S",
+ "City" : "Minneapolis",
+ "State" : "MN",
+ "PostalCode" : "55423"
+ },
+ "CurrentIndicator" : true
+ } ]
+ }
+ }
+ }, {
+ "Property" : {
+ "Address" : {
+ "AddressLine1" : "210 PeachTree Rd",
+ "City" : "Oakboro",
+ "State" : "nc",
+ "PostalCode" : "28129"
+ }
+ }
+ } ]
+ }
+}
+
+
+````
+
+## Other Examples
+### An example of everything available to be set in a request
+
+
+```bash
+curl -X POST https://api.pointservices.com/riskinsight-services-ws/resources/v1/sami/ADV/ADV-120J
+-H "Authorization: Bearer your_access_token_here"
+-H "Content-Type: application/json"
+-d '{
+ "CorrelationID" : "12345",
+ "Terms" : {
+ "Term" : [ {
+ "Person" : {
+ "FirstName" : "John",
+ "MiddleName" : "A",
+ "LastName" : "Doe",
+ "NameSuffix" : "Jr.",
+ "SSN" : "123-45-6789",
+ "DOB" : "01/01/1980",
+ "Gender" : "M",
+ "HomePhone" : "123-456-7890",
+ "Residences" : {
+ "Residence" : [ {
+ "Address" : {
+ "AddressLine1" : "123 Main St",
+ "City" : "Anytown",
+ "State" : "CA",
+ "PostalCode" : "12345",
+ "County" : "AnyCounty"
+ },
+ "CurrentIndicator" : true
+ } ]
+ },
+ "Employers" : {
+ "Employer" : [ {
+ "Name" : "ABC Corp",
+ "Phone" : "987-654-3210",
+ "EIN" : "12-3456789",
+ "MonthlyIncome" : "5000",
+ "MonthsOnJob" : "24",
+ "YearsOnJob" : "2",
+ "Address" : {
+ "AddressLine1" : "123 Main St",
+ "City" : "Anytown",
+ "State" : "CA",
+ "PostalCode" : "12345",
+ "County" : "AnyCounty"
+ },
+ "CurrentIndicator" : true,
+ "SelfEmployedIndicator" : false
+ } ]
+ },
+ "Declarations" : {
+ "AlimonyChildSupportObligationIndicator" : false,
+ "BorrowedDownPaymentIndicator" : false,
+ "CitizenshipResidencyType" : "PermanentResidentAlien",
+ "CoMakerEndorserOfNoteIndicator" : false,
+ "HomeownerPastThreeYearsIndicator" : true,
+ "IntentToOccupyIndicator" : true,
+ "LoanForeclosureOrJudgementIndicator" : false,
+ "OutstandingJudgementsIndicator" : false,
+ "PartyToLawsuitIndicator" : false,
+ "PresentlyDelinquentIndicator" : false,
+ "PriorPropertyTitleType" : "JointWithSpouse",
+ "PriorPropertyUsageType" : "PrimaryResidence",
+ "PriorPropertyUsageTypeOtherDescription" : "N/A",
+ "PropertyForeclosedPastSevenYearsIndicator" : false,
+ "BorrowerFirstTimeHomebuyerIndicator" : true
+ }
+ }
+ }, {
+ "Property" : {
+ "Address" : {
+ "AddressLine1" : "123 Apple St",
+ "City" : "Bearsville",
+ "State" : "CA",
+ "PostalCode" : "12345",
+ "County" : "Carrot County"
+ },
+ "SupplementaryId" : "SUPP123",
+ "AssessorsParcelNumber" : "APN123",
+ "CountyFIPSCode" : "12345",
+ "SaleDate" : "01/01/2020",
+ "SaleAmount" : "300000",
+ "AssessmentDate" : "01/01/2021",
+ "AssessmentAmount" : "350000",
+ "PropertyUsage" : "PrimaryResidence",
+ "PropertyUsageOtherDescription" : "N/A",
+ "PropertyType" : "DetachedCondominium",
+ "PropertyTypeOtherDescription" : "N/A",
+ "NumberOfUnits" : "1",
+ "Valuations" : {
+ "Valuation" : [ {
+ "ValuationType" : "Appraisal",
+ "ValuationTypeOtherDescription" : "N/A",
+ "ValuationAmount" : "350000"
+ } ]
+ },
+ "OwnerName" : "John Doe"
+ }
+ }, {
+ "Participant" : {
+ "FirstName" : "Jane",
+ "MiddleName" : "B",
+ "LastName" : "Smith",
+ "CompanyName" : "XYZ Corp",
+ "ParticipantType" : "Appraiser",
+ "ContactPoint" : {
+ "RoleType" : "Mobile",
+ "Type" : "Phone",
+ "Value" : "1234567890",
+ "PreferenceIndicator" : true
+ },
+ "Address" : {
+ "AddressLine1" : "123 Dunkin St",
+ "City" : "Frisco",
+ "State" : "CA",
+ "PostalCode" : "12345",
+ "County" : "Eagle Ridge County"
+ },
+ "Licenses" : {
+ "License" : [ {
+ "LicenseNumber" : "LIC123",
+ "LicenseType" : "Appraiser License",
+ "LicenseState" : "CA"
+ } ]
+ }
+ }
+ } ]
+ }
+}
+'
+```
+
+
+
+