Appraisal Scope Client API Document Version 1.5.20191104 · 29/01/2019 · E012 The appraisal has...
Transcript of Appraisal Scope Client API Document Version 1.5.20191104 · 29/01/2019 · E012 The appraisal has...
1
Appraisal Scope Client API Document
Version 1.5.20191104.01
2
Document Version History
No. Date Revised By Version Summary of Changes
1 12/04/18 Alex Patel V1.5.20181204.01
2 01/29/19 Mahavir Jain V1.5.20190129.01
3 02/12/19 Mahavir Jain V1.5.20190212.01 Introduced SendInvoice Call
4 02/12/19 Hitesh Patel V1.5.20190212.02 Update User Password
5 05/08/19 David Ashmon V1.5.2019.0508.01 Added ‘status’ and ‘job_type’ params to GetAppraisals Call
6 7/10/2019 David Ashmon V1.5.20190710.01 Added log_only param to AddComment
7 10/24/2019 Cynthia Burton V1.5.20191024.01 Reformatted document
8 11/04/19 Cynthia Burton In the createappraisal section:
• Removed ‘originator’ to reduce duplication/confusion
• Added submitting_party_name
3
Contents Introduction: ............................................................................................................................................... 11
Login API [Authentication] .......................................................................................................................... 13
Request Parameters: ............................................................................................................................... 13
Response Parameters: ............................................................................................................................ 13
Example Response Data: ......................................................................................................................... 13
Possible Error Codes: .............................................................................................................................. 13
Get Loan Officers ........................................................................................................................................ 14
Request Parameters: ............................................................................................................................... 14
Response Parameters: ............................................................................................................................ 14
Example Response Data: ......................................................................................................................... 14
Possible Error Codes: .............................................................................................................................. 14
Get Processors ............................................................................................................................................ 15
Request Parameters: ............................................................................................................................... 15
Response Parameters: ............................................................................................................................ 15
Example Response Data: ......................................................................................................................... 15
Possible Error Codes: .............................................................................................................................. 15
Get Client Displayed on Report ................................................................................................................... 16
Request Parameters: ............................................................................................................................... 16
Response Parameters: ............................................................................................................................ 16
Example Response Data: ......................................................................................................................... 16
Possible Error Codes: .............................................................................................................................. 16
Get Job Types .............................................................................................................................................. 17
Request Parameters: ............................................................................................................................... 17
Response Parameters: ............................................................................................................................ 17
Example Response Data: ......................................................................................................................... 17
Possible Error Codes: .............................................................................................................................. 17
Get Job Types based on Client Displayed on Report .................................................................................. 18
Request Parameters: ............................................................................................................................... 18
Response Parameters: ............................................................................................................................ 18
Example Response Data: ......................................................................................................................... 18
Possible Error Codes: .............................................................................................................................. 18
Get Appraisals ............................................................................................................................................. 19
4
Request Parameters: ............................................................................................................................... 19
Response Parameters: ............................................................................................................................ 19
Example Response Data: ......................................................................................................................... 20
Possible Error Codes: .............................................................................................................................. 20
Get Appraisal Details ................................................................................................................................... 21
Request Parameters: ............................................................................................................................... 21
Response Parameters: ............................................................................................................................ 21
Example Response Data: ......................................................................................................................... 24
Possible Error Codes: .............................................................................................................................. 25
Get Appraisal Status .................................................................................................................................... 26
Request Parameters: ............................................................................................................................... 26
Response Parameters: ............................................................................................................................ 26
Example Response Data: ......................................................................................................................... 26
Possible Error Codes: .............................................................................................................................. 26
Check FHA ................................................................................................................................................... 27
Request Parameters: ............................................................................................................................... 27
Response Parameters: ............................................................................................................................ 27
Example Response Data: ......................................................................................................................... 27
Possible Error Codes: .............................................................................................................................. 27
Create New Appraisal ................................................................................................................................. 28
Request Parameters: ............................................................................................................................... 28
Response Parameters: ............................................................................................................................ 36
Example Response Data: ......................................................................................................................... 36
Possible Error Codes: .............................................................................................................................. 36
Add Form..................................................................................................................................................... 37
Request Parameters: ............................................................................................................................... 37
Response Parameters: ............................................................................................................................ 45
Example Response Data: ......................................................................................................................... 45
Possible Error Codes: .............................................................................................................................. 45
Update Appraisal ........................................................................................................................................ 46
Request Parameters: ............................................................................................................................... 46
Response Parameters: ............................................................................................................................ 53
Example Response Data: ......................................................................................................................... 54
5
Possible Error Codes: .............................................................................................................................. 54
Payment Authorize & Capture .................................................................................................................... 55
Request Parameters: ............................................................................................................................... 55
Response Parameters: ............................................................................................................................ 55
Example Response Data: ......................................................................................................................... 56
Possible Error Codes: .............................................................................................................................. 56
Payment Authorize Only ............................................................................................................................. 57
Request Parameters: ............................................................................................................................... 57
Response Parameters: ............................................................................................................................ 57
Example Response Data: ......................................................................................................................... 58
Possible Error Codes: .............................................................................................................................. 58
Payment Capture Only ................................................................................................................................ 59
Request Parameters: ............................................................................................................................... 59
Response Parameters: ............................................................................................................................ 59
Example Response Data: ......................................................................................................................... 59
Possible Error Codes: .............................................................................................................................. 59
Partial Payment ........................................................................................................................................... 60
Request Parameters: ............................................................................................................................... 60
Response Parameters: ............................................................................................................................ 60
Example Response Data: ......................................................................................................................... 61
Possible Error Codes: .............................................................................................................................. 61
Split Payment .............................................................................................................................................. 62
Request Parameters: ............................................................................................................................... 62
Example Request Data: ........................................................................................................................... 63
Response Parameters: ............................................................................................................................ 63
Example Response Data: ......................................................................................................................... 63
Possible Error Codes: .............................................................................................................................. 64
Send Invoice ................................................................................................................................................ 65
Request Parameters: ............................................................................................................................... 65
Response Parameters: ............................................................................................................................ 65
Example Response Data: ......................................................................................................................... 65
Possible Error Codes: .............................................................................................................................. 65
Bill Invoice ................................................................................................................................................... 66
6
Request Parameters: ............................................................................................................................... 66
Response Parameters: ............................................................................................................................ 66
Example Response Data: ......................................................................................................................... 66
Possible Error Codes: .............................................................................................................................. 66
Save Payment to Capture Later .................................................................................................................. 67
Request Parameters: ............................................................................................................................... 67
Response Parameters: ............................................................................................................................ 67
Example Response Data: ......................................................................................................................... 67
Possible Error Codes: .............................................................................................................................. 67
Echeck Payment .......................................................................................................................................... 68
Request Parameters: ............................................................................................................................... 68
Response Parameters: ............................................................................................................................ 68
Example Response Data: ......................................................................................................................... 69
Possible Error Codes: .............................................................................................................................. 69
Get Payment Options .................................................................................................................................. 70
Request Parameters: ............................................................................................................................... 70
Response Parameters: ............................................................................................................................ 70
Example Response Data: ......................................................................................................................... 70
Possible Error Codes: .............................................................................................................................. 70
Get Appraisal Documents ........................................................................................................................... 71
Request Parameters: ............................................................................................................................... 71
Response Parameters: ............................................................................................................................ 71
Example Response Data: ......................................................................................................................... 72
Possible Error Codes: .............................................................................................................................. 72
Add Appraisal Document ............................................................................................................................ 73
Request Parameters: ............................................................................................................................... 73
Response Parameters: ............................................................................................................................ 73
Example Response Data: ......................................................................................................................... 73
Possible Error Codes: .............................................................................................................................. 73
Add Multi-Appraisal Document .................................................................................................................. 74
Request Parameters: ............................................................................................................................... 74
Response Parameters: ............................................................................................................................ 74
Example Response Data: ......................................................................................................................... 74
7
Possible Error Codes: .............................................................................................................................. 74
Get Property View Type .............................................................................................................................. 75
Request Parameters: ............................................................................................................................... 75
Response Parameters: ............................................................................................................................ 75
Example Response Data: ......................................................................................................................... 75
Possible Error Codes: .............................................................................................................................. 75
Get Appraisals Document Content ............................................................................................................. 76
Request Parameters: ............................................................................................................................... 76
Response Parameters: ............................................................................................................................ 76
Example Response Data: ......................................................................................................................... 76
Possible Error Codes: .............................................................................................................................. 76
Get Appraisal Comment .............................................................................................................................. 77
Request Parameters: ............................................................................................................................... 77
Response Parameters: ............................................................................................................................ 77
Example Response Data: ......................................................................................................................... 77
Possible Error Codes: .............................................................................................................................. 77
Add Appraisal Comment ............................................................................................................................. 78
Request Parameters: ............................................................................................................................... 78
Response Parameters: ............................................................................................................................ 78
Example Response Data: ......................................................................................................................... 78
Possible Error Codes: .............................................................................................................................. 78
Get Appraisal Revisions/Stipulations .......................................................................................................... 79
Request Parameters: ............................................................................................................................... 79
Response Parameters: ............................................................................................................................ 79
Example Response Data: ......................................................................................................................... 79
Possible Error Codes: .............................................................................................................................. 79
Add Appraisal Revisions/Stipulations ......................................................................................................... 80
Request Parameters: ............................................................................................................................... 80
Response Parameters: ............................................................................................................................ 80
Example Response Data: ......................................................................................................................... 80
Possible Error Codes: .............................................................................................................................. 80
Get Job Type Addons .................................................................................................................................. 81
Request Parameters: ............................................................................................................................... 81
8
Response Parameters: ............................................................................................................................ 81
Example Response Data: ......................................................................................................................... 81
Possible Error Codes: .............................................................................................................................. 81
Upload Contract Document ........................................................................................................................ 82
Request Parameters: ............................................................................................................................... 82
Response Parameters: ............................................................................................................................ 82
Example Response Data: ......................................................................................................................... 82
Possible Error Codes: .............................................................................................................................. 82
Upload Contract Document Multi .............................................................................................................. 83
Request Parameters: ............................................................................................................................... 83
Response Parameters: ............................................................................................................................ 83
Example Response Data: ......................................................................................................................... 83
Possible Error Codes: .............................................................................................................................. 83
Get Details of an Appraisal for Add Appraisal Form ................................................................................... 84
Request Parameters: ............................................................................................................................... 84
Response Parameters: ............................................................................................................................ 84
Example Response Data: ......................................................................................................................... 86
Possible Error Codes: .............................................................................................................................. 86
Create Client User ....................................................................................................................................... 87
Request Parameters: ............................................................................................................................... 87
Response Parameters: ............................................................................................................................ 87
Example Response Data: ......................................................................................................................... 87
Possible Error Codes: .............................................................................................................................. 87
Update Client User ...................................................................................................................................... 88
Request Parameters: ............................................................................................................................... 88
Response Parameters: ............................................................................................................................ 88
Example Response Data: ......................................................................................................................... 88
Possible Error Codes: .............................................................................................................................. 88
Get Branch List ............................................................................................................................................ 89
Request Parameters: ............................................................................................................................... 89
Response Parameters: ............................................................................................................................ 89
Example Response Data: ......................................................................................................................... 89
Possible Error Codes: .............................................................................................................................. 90
9
Create Branch ............................................................................................................................................. 91
Request Parameters: ............................................................................................................................... 91
Response Parameters: ............................................................................................................................ 91
Example Response Data: ......................................................................................................................... 92
Possible Error Codes: .............................................................................................................................. 92
Update Branch ............................................................................................................................................ 93
Request Parameters: ............................................................................................................................... 93
Response Parameters: ............................................................................................................................ 93
Example Response Data: ......................................................................................................................... 94
Possible Error Codes: .............................................................................................................................. 94
Get Appraiser Fee by Location .................................................................................................................... 95
Request Parameters: ............................................................................................................................... 95
Response Parameters: ............................................................................................................................ 95
Example Response Data: ......................................................................................................................... 95
Possible Error Codes: .............................................................................................................................. 95
Get Job Types by Loan Type ........................................................................................................................ 96
Request Parameters: ............................................................................................................................... 96
Response Parameters: ............................................................................................................................ 96
Example Response Data: ......................................................................................................................... 96
Possible Error Codes: .............................................................................................................................. 96
Get Loan Type ............................................................................................................................................. 97
Request Parameters: ............................................................................................................................... 97
Response Parameters: ............................................................................................................................ 97
Example Response Data: ......................................................................................................................... 97
Possible Error Codes: .............................................................................................................................. 97
Get Intended Use ........................................................................................................................................ 98
Request Parameters: ............................................................................................................................... 98
Response Parameters: ............................................................................................................................ 98
Example Response Data: ......................................................................................................................... 98
Possible Error Codes: .............................................................................................................................. 98
Get Investor ................................................................................................................................................ 99
Request Parameters: ............................................................................................................................... 99
Response Parameters: ............................................................................................................................ 99
10
Example Response Data: ......................................................................................................................... 99
Possible Error Codes: .............................................................................................................................. 99
Get Users ................................................................................................................................................... 100
Request Parameters: ............................................................................................................................. 100
Response Parameters: .......................................................................................................................... 100
Example Response Data: ....................................................................................................................... 100
Possible Error Codes: ............................................................................................................................ 100
Get AMC Preference ................................................................................................................................. 101
Request Parameters: ............................................................................................................................. 101
Response Parameters: .......................................................................................................................... 101
Example Response Data: ....................................................................................................................... 101
Possible Error Codes: ............................................................................................................................ 101
Get Property Type ..................................................................................................................................... 102
Request Parameters: ............................................................................................................................. 102
Response Parameters: .......................................................................................................................... 102
Example Response Data: ....................................................................................................................... 102
Possible Error Codes: ............................................................................................................................ 102
Get Additional Document Type ................................................................................................................ 103
Request Parameters: ............................................................................................................................. 103
Response Parameters: .......................................................................................................................... 103
Example Response Data: ....................................................................................................................... 103
Possible Error Codes: ............................................................................................................................ 103
Update User Password .............................................................................................................................. 104
Request Parameters: ............................................................................................................................. 104
Response Parameters: .......................................................................................................................... 104
Example Response Data: ....................................................................................................................... 104
Possible Error Codes: ............................................................................................................................ 104
PHP Code Sample: ..................................................................................................................................... 105
11
Introduction: Appraisal Scope has developed its own web services that allow third parties to communicate with our system. Like
other communication gateways, Appraisal Scope has some rules that need to be followed during communication.
Highlights:
• Appraisal Scope web services are based on REST protocol, generally known as RESTful API.
• Appraisal Scope has created a REST Server. For communication, third parties will need to implement a REST
client, cURL, or equivalent mechanism they can use to call the Appraisal Scope API.
• The client (3rd party software) will initiate requests and send them to Appraisal Scope over this API. Appraisal
Scope API will parse and process the request and send the response.
• All requests and responses are in JSON format.
• The first call to initiate communication will be to authenticate.
o The dologin API call is made first.
o Upon successful authentication, the dologin response will include an authentication key, which needs
to be included in all subsequent calls.
• All API calls have a "success" variable in the JSON response, which could be set to “true” or “false” depending
on whether call was successful or not.
o If success = true then the requested data can be found in the JSON response.
o If success = false then the API called failed due to an error and the reason for the error can be found
in the "error_code” and "error_msg” variables in JSON response.
Integration:
Appraisal Scope has different integration URLs and different login credentials.
URL Environment Login Credentials
https://stage.appraisalscope.com/index.php/api/resapi Test On Request
Production URL is provided on request. Production On Request
Error Codes & Messages:
If there is an error when processing a request, Appraisal Scope returns success = false along with “error_code” and
“error_msg”. The error codes and their meanings are below.
Error Code (error_code) Error Message (error_msg)
E001 No details found.
E002 Required parameters not supplied.
E003 Login Expired.
E004 Payment Declined.
E005 Email sending failed.
E006 Invalid login details.
E007 Account Disabled.
E008 Error while creating appraisal.
E009 Error while updating appraisal.
E010 Invalid request data.
E011 Error while adding comment.
12
E012 The appraisal has not yet been completed to submit a revision.
E013 You can’t edit this order. The appraisal is assigned to an appraiser.
E014 You can’t add a new form because this appraisal is not completed.
E015 Invalid upload file.
E016 You selected a Non-FHA product or form type. Please remove the FHA# or select an FHA product or form type.
E017 You selected an FHA product or form type. An FHA# is required.
E018 Total payment amount is larger than due amount.
E019 Duplicate credit card used.
E020 This order cannot be submitted. Unfortunately, ‘Company’ does not provide coverage for the location of the property.
E021 The FHA# must be at least 10 digits.
E022 The Due Date must be greater than Order Create Date.
E023 Invalid Client ID. It does not exist.
E024 Invalid job type.
E025 Invalid job type Addon.
E026 <setting_name> is disabled.
E027 Job Type cannot be changed once order is assigned to an appraiser.
E028 New appraisal and Add form feature locked for you
E029 Address must not start with disallowed words <disallowed_address_words>
E030 Appraisal Documents not retrieved because order status still not completed
E031 Strong Password Error.
E032 Not reuse last 4 passwords
13
Login API [Authentication]
The primary API for authentication is below.
Method Request URI Test Environment URL
POST /dologin https://stage.appraisalscope.com/index.php/api/resapi/dologin
Request Parameters: Name Field Name Required Details
Username username Yes Username for authentication
Password password Yes Password for authentication
Time Zone time_zone No Local Time Zone Offset from GMT/UTC. Format +/- HH.MM [Example: +05.30 OR +04.30]
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great, authentication was successful
• “false” means something went wrong, authentication failed, check error code and error msg for details of the error
Key api_key On success = true, returns value API key for calling other APIs
Example Response Data: {"success":true,"api_key":"a2371bf8ebc6bc769c170d114de51f146b993e98"}
Possible Error Codes: E002, E006
14
Get Loan Officers
This API call retrieves all loan officers available for the authenticated client.
Method Request URI Test Environment URL
POST /getloanofficer https://stage.appraisalscope.com/index.php/api/resapi/getloanofficer
Request Parameters: Name Field Name Required Details
API Key api key Yes Use the API Key received from the dologin response
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. A list of loan officers is returned in the “result” variable.
• “false” means something went wrong. Check error code and error msg for details of the error.
Result result Result variable will have a list of loan officers with
• id
• name
• internal_id
Example Response Data: {"success":true,"result":[{"id":"103841","name":"Jackson Disa"},{"id":"103842","name":"Jack
Pitt","internal_id":"12312"}]}
Possible Error Codes: E003
15
Get Processors
This API call retrieves all processors available for the authenticated client.
Method Request URI Test Environment URL
POST /getprocessor https://stage.appraisalscope.com/index.php/api/resapi/getprocessor
Request Parameters: Name Field Name Required Details
API Key api key Yes Use the API Key received from the dologin response
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. A list of processors is returned in the “result” variable.
• “false” means something went wrong. Check error code and error msg for details of the error.
Result result Result variable will have a list of processors with
• id
• name
• internal_id
Example Response Data: {"success":true,"result":[{"id":"103886","name":"Lousi Dack","internal_id":"12312"}, {"id":"103885","name":"John
Gellite","internal_id":"12311"},{"id":"103839","name":"Brock
Brown","internal_id":"123112"},{"id":"103840","name":"Robin Jackmen","internal_id":"87878"}]}
Possible Error Codes: E003
16
Get Client Displayed on Report
This API call retrieves a list of all clients who can be set to display on the report for the authenticated client.
Method
Request URI Test Environment URL
POST /getclientdisplayonreport
https://stage.appraisalscope.com/index.php/api/resapi/getclientdisplayonreport
Request Parameters: Name Field Name Required Details
API Key Api_key Yes Use the API Key received from the dologin response
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. A list of clients is returned in the “result” variable.
• “false” means something went wrong. Check error code and error msg for details of the error.
Result result Result variable will have a list of clients with
• id
• name
Example Response Data: {"success":true,"result":[{"id":"104782","name":"ABMS, Inc."},{"id":"103843","name":"C
company"},{"id":"103864","name":"Gellite Co."},{"id":"103833","name":"Suntrust Mortgage"},
{"id":"104756","name":"Tester Inc"}]}
Possible Error Codes: E003, E001
17
Get Job Types
This API call retrieves a list of available job types for the authenticated client.
Method Request URI Test Environment URL
POST /getjobtype https://stage.appraisalscope.com/index.php/api/resapi/getjobtype
Request Parameters: Name Field Name Required Details
API Key api key Yes Use the API Key received from the dologin response
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. A list of job types returned in the “result” variable.
• “false” means something went wrong. Check error code and error msg for details of the error.
Result result Result variable will have a list of job types with
• id
• name
Example Response Data: {"success":true,"result":[{"id":"58","name":"(1004) URAR + 1004MC (USDA)"}, {"id":"70","name":"(1073) Condo +
1004MC (203K)"},{"id":"54","name":"(1073) Condo FHA + 1004MC"},{"id":"545","name":"(1004) URAR + 1004MC
(203K)"},{"id":"55","name":"(1004) URAR + 1004MC with Income Statement"},{"id":"53","name":"(1073) Condo +
1004MC"}, {"id":"56","name":"(1004) URAR + 1004MC with Comp. Rent Schedule"}, {"id":"7","name":"Operating
Income Statement"}]}
Possible Error Codes: E003, E001
18
Get Job Types based on Client Displayed on Report
This API call retrieves a list of available job types for the selected client displayed on the report.
Method Request URI Test Environment URL
POST /clientdisplayedgetjobtype
https://stage.appraisalscope.com/index.php/api/resapi/clientdisplayedgetjobtype
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Client Displayed on Report Id
client_displayed_id Yes Id of Client Displayed on Report
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. A list of job types based on client is returned in the “result” variable.
• “false” means something went wrong. Check error code and error msg for details of the error.
Result result Result variable will have a list of job types with
• id
• name
Example Response Data: {"success":true,"result":[{"id":"58","name":"(1004) URAR + 1004MC (USDA)"}, {"id":"70","name":"(1073) Condo +
1004MC (203K)"},{"id":"54","name":"(1073) Condo FHA + 1004MC"},{"id":"545","name":"(1004) URAR + 1004MC
(203K)"},{"id":"55","name":"(1004) URAR + 1004MC with Income Statement"},{"id":"53","name":"(1073) Condo +
1004MC"}, {"id":"56","name":"(1004) URAR + 1004MC with Comp. Rent Schedule"}, {"id":"7","name":"Operating
Income Statement"}]}
Possible Error Codes: E003, E001
19
Get Appraisals
This API call retrieves all appraisals ordered by the authenticated client with their basic details.
Method Request URI Test Environment URL
POST /getappraisals https://stage.appraisalscope.com/index.php/api/resapi/getappraisals
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Create Start Date create_date_start No The date the order was created. This value is used to filter the appraisals list between given dates.
Create Date End create_date_end No The date the order was created. This value is used to filter the appraisals list between given dates.
Loan Number loan_number No The loan number associated with the order(s). This value is used to filter appraisals by loan number.
Job Type ID job_type No Filters orders that are of the given job type.
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. A list of appraisals are returned in the “result” variable.
• “false” means something went wrong. Check error code and error msg for details of the error.
Result result Result variable will have a list of appraisals with
• appraisal_id
• sequence_number
• file_no
• borrower_name
• address
• city
• loan_no
• date_ordered
• ordered_by
• status
• inspection_date
• estimated_completion_date
• investor_company
20
Example Response Data: {"success":true,"result": [{"appraisal_id":"7437","sequence_number":"1","file_no":"42","borrower_name":"fg fg
fg","address":"sdg, dgs","city":"Chase, MD","loan_no":"546","date_ordered":"07-09- 2012","ordered_by":"Saa
dd","status":"New","inspection_date":"N\/A","estimated_completion_date":"N\/A"},
{"appraisal_id":"7438","file_no":"43","borrower_name":"23 23 23","address":"23, 23","city":"Jacksonville,
FL","loan_no":"23","date_ordered":"07-09-
2012","ordered_by":"Sardar","status":"New","inspection_date":"N\/A","estimated_completion_d
ate":"N\/A"},{"appraisal_id":"7439","file_no":"44","borrower_name":"Ask","address":"343434 adf,
","city":"Pikesville, MD","loan_no":"","date_ordered":"07-09-
2012","ordered_by":"sardar","status":"New","inspection_date":"N\/A","estimated_completion_da
te":"N\/A","investor_company":"Test Investor"}]}
Possible Error Codes: E003, E001
21
Get Appraisal Details
This API call retrieves all appraisal details associated with an appraisal for the authenticated client.
Method Request URI Test Environment URL
POST /getappraisaldetail
https://stage.appraisalscope.com/index.php/api/resapi/getappraisaldetail
Request Parameters: Name Field Name Required Details
API Key api key Yes Use the API Key received from the dologin response
Appraisal Id appraisal id Yes Appraisal identifier for the Appraisal Scope system
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. The details of an appraisal are returned in the “result” variable.
• “false” means something went wrong. Check error code and error msg for details of the error.
Result result Result variable will have a list of appraisals with
• appraisal_id
• paren_appraisal_id
• sequence_number
• client
• client_displayed_on_report
• submitted_by
• job_type
• job_type_addon
• loan_officer
• processor
• notify_email
• order_date
• status
• assigned_date
• client_fee
• inspection_date
• due_date
• estimated_complete_date
• completed_date
• completed_date
• form_fee
• management_fee
• paid_amount
• invoiced_amount
• due_amount
• parent_appraisal_id This field will contain the id of the parent appraisal from which the ADD FORM request was initiated. In other words, it will be present only when an appraisal was created from the ADD FORM screen. Otherwise it will contain value 0.
22
• paid status
• fha
• loan_no
• loan_amount
• loan_type
• Intended Use
• file_no
• purchase_price
• amc_licence
• address1
• address2
• city
• state
• zip
• county
• property_type
• occupancy
• borrower
• borrower_fname
• borrower_mname
• borrower_lname
• borrower_home_number
• borrower_work_number
• borrower_cell_number
• borrower_email
• borrower_intent_to_proceed_date
• borrower_address1
• borrower_address2
• borrower_city
• borrower_state
• borrower_zip
• borrower_county
• coborrower
• coborrower_fname
• coborrower_mname
• coborrower_lname
• coborrower_home_number
• coborrower_work_number
• coborrower_cell_number
• coborrower_email
• coborrower_intent_to_proc eed_date
• coborrower_address1
• coborrower_address2
• coborrower_city
• coborrower_state
• coborrower zip
• coborrower_county
• owner
• owner_fname
23
• owner_mname
• owner_lname
• owner_home_number
• owner_work_number
• owner_cell_number
• owner_email
• realtor
• realtor_home_number
• realtor_work_number
• realtor_cell_number
• realtor_email
• other
• other_fname
• other_mname
• other_lname
• other_home_number
• other_work_number
• other_cell_number
• other_email
• assistant
• assistant_fname
• assistant_mname
• assistant_lname
• assistant_home_number
• assistant_work_number
• assistant_cell_number
• assistant_email
• listing_agent
• listing_agent_fname
• listing_agent_mname
• listing_agent_lname
• listing_agent_home_number
• listing_agent_work_number
• listing_agent_cell_number
• listing_agent_email
• selling_agent
• selling_agent_fname
• selling_agent_mname
• selling_agent_lname
• selling_agent_home_number
• selling_agent_work_number
• selling_agent_cell_number
• selling_agent_email
• primary_contact
• comments
• appraisal_contract_orig_name
• appraisal_contract_path
• appraisal_contract_date
• appraisal_contract_sales_price
• appraisal_contract_concession
24
• appraisal_contract_concession_type
• cu_score
• cu_comments
• borrower_report_delivered_time
• ucdp_order_id
• info_lien_position
• override_borrower_delivery_option
• final_decision
• cu_rw
• lca_rw
• cc_reviewed_email
• appraiser_company
• appraiser_name
• appraiser_phone
• appraiser_email
• appraiser_city
• appraiser_state
• assigned_AMC
• assigned_AMC_file_no
• accepted_date
• appraisal_upload_date
• appraised_value
• appraisal_apn
• Investor
• estimated_closing_date
• investor_id
• investor_company
Example Response Data: {"success":true,"result":{"appraisal_id":"12345", "parent_appraisal_id":"0","sequence_number":"1","client":"tst
Co,<br \/>209-regent square<br \/>Surat, Alaska, 39005","client_dispayed_on_report":"tst Co,<br>209-regent
square<br \/>Surat, Alaska, 39005","submitted_by":"Jordan Rothstein (Superadmin)","job_type":"1004D
Completion Report","loan_officer":"tst test","processor":"test mahavir
123","notify_email":"N\/A","order_date":"2016-03-02 08:54:50","status":"Completed","assigned_date":"2016-03-
30 14:50:08","client_fee":"1000.00","inspection_date":"N\/A","due_date":"2016-06-
30","estimated_complete_date":"N\/A","completed_date":"2016-07-
08","form_fee":"0","management_fee":"0","paid_amount":"0","invoiced_amount":"0","due_amo
unt":"1,000","paid_status":"Not
Paid","fha":"12345678901","loan_no":"12121221","loan_amount":"121212","loan_type":"Other",
"file_no":"EFG1315","purchase_price":"N\/A","amc_licence":"5555555","address1":"1234 Lexington
Ave","address2":"N\/A","city":"New york","state":"NY","zip":"10028","county":"New
york","property_type":"Office","occupancy":"Owner","borrower":"Mahavir P
Jain","borrower_home_number":"898-878-7897","borrower_work_number":"987-789-
7897","borrower_cell_number":"987-879-
8777","borrower_email":"[email protected]","borrower_address1":"N\/A","borrower_address2":"N\
/A","borrower_city":"N\/A","borrower_state":"N\/A","borrower_zip":"N\/A","borrower_county":"
N\/A","coborrower":"a a a","coborrower_home_number":"111-111- 1111","coborrower_work_number":"111-
25
111-1111","coborrower_cell_number":"111-111-
1111","coborrower_email":"[email protected]","coborrower_address1":"N\/A","coborrower_address2":"N
\/A","coborrower_city":"N\/A","coborrower_state":"N\/A","coborrower_zip":"N\/A","coborrower
_county":"N\/A","owner":"ad ds sd","owner_home_number":"222-222- 2222","owner_work_number":"222-222-
2222","owner_cell_number":"222-222- 2222","owner_email":"[email protected]","realtor":"test realtor
name","realtor_home_number":"111- 111-1111","realtor_work_number":"222-222-
2222","realtor_cell_number":"333-333- 3333","realtor_email":"[email protected]","other":"adf fdf
df","other_home_number":"333- 333-
3333","other_work_number":"333-333-3333","other_cell_number":"333-333-
3333","other_email":"[email protected]","primary_contact":"Borrower","comments":"test order from client
login.","job_type_addon":"N\/A","appraisal_contract_orig_name":"","appraisal_contract_path":"",
"appraisal_contract_date":"","appraisal_contract_salse_price":"","appraisal_contract_concession":
"","appraisal_contract_concession_type":"0","cu_score":"","cu_comments":"","borrower_report_
delivered_time":"2016-07-08 15:42:18","ucdp_order_id":"358EAB36-1EE8-F827-6351-
9B187865895F","final_decision":"Approve","cu_rw":"Yes","lca_rw":"No","estimated_closing_date ": "2018-10-
25","investor_id":"11111","investor_company":"Test Company"}}
Possible Error Codes: E001, E002, E003
26
Get Appraisal Status
This API call retrieves the status of the requested appraisal for the authenticated user.
Method Request URI Test Environment URL
POST /getappraisalstatus
https://stage.appraisalscope.com/index.php/api/resapi/getappraisalstatus
Request Parameters: Name Field Name Required Details
API Key api key Yes Use the API Key received from the dologin response
Appraisal Id appraisal id Yes Id of Client Displayed on Report
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Appraisal status
Appraisal_status Appraisal status can be one of the following:
• New
• Assigned
• Accepted
• Declined
• Inspection Scheduled
• Inspection Complete
• Late
• On Hold
• Revision Sent
• Revision Received
• Ready for Review
• Reviewed
• Completed
• Canceled
Example Response Data: {"success":true,"appraisal_status":"Completed"}
Possible Error Codes: E001, E002, E003
27
Check FHA
This API call checks if FHA is required for the requested job type.
Method Request URI Test Environment URL
POST /checkfha https://stage.appraisalscope.com/index.php/api/resapi/checkfha
Request Parameters: Name Field Name Required Details
API Key api key Yes Use the API Key received from the dologin response
Job type id job type Yes Job type identifier in Appraisal Scope
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great “false” means something went wrong, check error code and error msg for details of the error
Result result Result variable will be:
• 0 = FHA is not required
• 1 = FHA is required
If FHA is required, then it must be supplied in the create appraisal request.
Example Response Data: {"success":true,"result":"1"}
Possible Error Codes: E001, E003
28
Create New Appraisal
This API is used to create a new appraisal in Appraisal Scope for the authenticated user.
Method Request URI Test Environment URL
POST /createappraisal https://stage.appraisalscope.com/index.php/api/resapi/createappraisal
Request Parameters: Name Field Name Required Details
API Key api key Yes Use the API Key received from the dologin response
Client ID client_displayed_id Yes Client id of a Client who needs to be displayed on report. [Ref : Client Display On Report API Call]
Processor ID processor_id No Id of a user who is set as the processor for the appraisal. [ Ref : Processor API Call]
Due date due_date No Date by when appraisal is due. Date format must be yyyy-mm-dd [eg : - 2013-02-25]
Email address notify_email No Notify email address.
Address 1 address1 Yes Primary Address line of property.
Address 2 address2 No Secondary Address line of property.
City City Yes City of property.
State state Yes State of property.
Zip zip Yes Zip code of property.
County county No County of property
Property type property_type Yes Property type must be one of following:
• Single Family
• Multi Family
• Condominium
• Duplex
• Manufactured Home
• Mobile Home
• Modular Home
• Vacant Land
• Vacant Lot
• Other
Job Type job_type Yes Job type identifier. [Ref : Job type API call.]
Job Type Addon job_type-addon No A comma separated list of addon job type ids.
FHA fha No [conditional]
If job type selected for appraisal is set to FHA = 1, then this field is required.
29
[Ref: Check FHA API call.]
Job Fee job_fee Yes Client fee for the appraisal.
Management Fee
management_fee No Management fee set for given client and job type. If nothing is passed, API will consider 0.
Loan Type loan_type Yes Loan type identifier. [Ref : get Loan type API call.]
Intended Use intended_use Yes Intended use type identifier. [Ref : get Intended use API call.]
Loan Number loan_number Yes Loan number for the appraisal.
Loan Amount loan_amount No Amount of the loan.
Loan Officer loan_officer No Id of a user who is set as loan officer for appraisal. [Ref: Loan Officers API Call.]
Purchase Amount
purchase_amount No [conditional]
If Intended Use is set to Purchase, then Purchase amount is required.
Occupancy occupancy No Occupancy must be one of following:
• Owner
• Tenant
• Vacant
• New Construction
Entity Name entity_name No [conditional]
If Job Type AND Entity Name field by Job Type = “Commercial”, then this field OR Borrower first and last name are conditionally required. If Job Type AND Entity Name field by Job Type = “Residential”, then this field OR Borrower first and last name are conditionally required. If the Entity Name field by Job Type setting = Both, then this field OR Borrower first and last name are conditionally required.
Borrower Full Name
borrower_name No Borrower's full name.
Borrower First Name
borrower_fname Yes Borrower's first name.
Borrower Middle Name
borrower_mname No Borrower's middle name.
Borrower Last Name
borrower_lname Yes Borrower's last name.
Borrower Home Number
borrower_home_number No Borrower's home phone number
Borrower Work Number
borrower_work_number No Borrower's work phone number
Borrower Cell Number
borrower_cell_number No [conditional]
Borrower's cell phone number.
30
Required if “Best person to contact” value is Borrower and Borrower Email is empty.
Borrower Email borrower_email Yes [conditional]
Borrower's email
Borrower Intent to Proceed Date
borrower_intent_to_proceed_date Yes [conditional]
If the “Require Borrower's Email Address” setting is Required, then this field is required. Else optional.
Mail Hard Copy to Borrower
mail_to_hard_copy_borrower No Borrower's Mail Hard Copy Option
Borrower Address1
borrower_address1 No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Borrower Address2
borrower_address2 No Borrower’s Address 2
Borrower City borrower_city No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Borrower State borrower_state No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Borrower Zip borrower_zip No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Borrower County
borrower_county No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower Full Name
coborrower_name No [conditional]
Co-borrower's full name. Required if “Best person to contact” value is Co-Borrower and First and last name field are empty.
Co-borrower First Name
coborrower_fname No [conditional]
Co-borrower's first name. Required if “Best person to contact” value is Co-Borrower
31
Co-borrower Middle name
coborrower_mname No Co-borrower's middle name.
Co-borrower Last Name
coborrower_lname No [conditional]
Co-borrower's last name. Required if “Best person to contact” value is Co-Borrower
Co-Borrower Home Number
coborrower_home_number No Co-borrower's home phone #.
Co-Borrower Work Number
coborrower_work_number No Co-borrower's work phone #.
Co-Borrower Cell Number
coborrower_cell_number No [conditional]
Co-borrower's cell #. Required if “Best person to contact” value is Co-Borrower and Co-Borrower Email is empty.
Co-borrower Email
coborrower_email No [conditional]
Co-borrower's email address. Required if “Best person to contact” value is Co-Borrower and Borrower Cell# is empty.
Co-Borrower Intent to Proceed Date
coborrower_intent_to_proceed_date Yes [conditional]
IF "Co-Borrower Intent to Proceed" required? Set to 'Yes' and user have entered co-borrower first name then field is required else optional.
Mail Hard Copy To Co-borrower
mail_to_hard_copy_coborrower No Co-borrower's Mail Hard Copy Option
Co-borrower Address1
coborrower_address1 No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower Address2
coborrower_address2 No Co-borrower's Address2.
Co-borrower City
coborrower_city No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower State
coborrower_state No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower Zip
coborrower_zip No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower County
coborrower_county No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes'
32
and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Owner Name owner [Conditional] No Owner's full name. Required if “Best person to contact” value is Owner and First and Last name is empty.
Owner First Name
owner_fname No [conditional]
Owner's first name. Required if “Best person to contact” value is Owner.
Owner Middle Name
owner_mname No Owner's middle name.
Owner Last Name
owner_lname No [conditional]
Owner's Last Name. Required if “Best person to contact” value is Owner.
Owner Home Number
owner_home_number No Owner's home phone #.
Owner Work Number
owner_work_number No Owner's work phone #.
Owner Cell Number
owner_cell_number No [conditional]
Owner's cell #. Required if “Best person to contact” value is Owner and Owner Cell# is empty.
Owner Email owner_email No [conditional]
Owner's email address. Required if “Best person to contact” value is Owner and Owner Email is empty.
Other Contact Name
other No [conditional]
Other contact's full name. Required if “Best person to contact” value is Other and First and Last name is empty.
Other Contact First Name
other_fname No [conditional]
Other contact's first name. Required if “Best person to contact” value is Other.
Other Contact Middle Name
other_mname No Other contact's middle name.
Other Contact Last Name
other_lname No [conditional]
Other contact's last name. Required if “Best person to contact” value is Other.
Other Home Number
other_home_number No Other contact's home phone #.
Other Work Number
other_work_number No Other Contact's work phone #.
Other Cell Number
other_cell_number No [conditional]
Other contact's cell #. Required if “Best person to contact” value is Other and Other Cell# is empty.
Other Email other_email No [conditional]
Other contact's email address. Required if “Best person to contact” value is Borrower and Borrower Email is empty.
33
Assistant Contact Name
assistant No [conditional]
Assistant contact's full name. Required if “Best person to contact” value is Assistant and First and Last name is empty.
Assistant Contact First Name
assistant_fname No [conditional]
Assistant contact's first name. Required if “Best person to contact” value is Assistant.
Assistant Contact Middle Name
assistant_mname No Assistant contact's middle name.
Assistant Contact Last Name
assistant_lname No [conditional]
Assistant contact's last name. Required if “Best person to contact” value is Assistant
Assistant Home Number
assistant_home_number No Assistant contact's home phone #.
Assistant Work Number
assistant_work_number No Assistant Contact's work phone #.
Assistant Cell Number
assistant_cell_number No [conditional]
Assistant contact's cell #. Required if “Best person to contact” value is Assistant and Assistant Email is empty.
Assistant Email assistant_email No [conditional]
Assistant contact's email address. Required if “Best person to contact” value is Assistant and Assistant Cell# is empty.
Listing Agent Contact Name
listing_agent No [conditional]
Listing Agent contact's full name. Required if “Best person to contact” value is Listing Agent and First and Last name is empty.
Listing Agent Contact First Name
listing_agent_fname No [conditional]
Listing Agent contact's first name. Required if “Best person to contact” value is Listing Agent.
Listing Agent Contact Middle Name
Listing_agent_mname No Listing Agent contact's middle name.
Listing Agent Contact Last Name
listing_agent_lname No [conditional]
Listing Agent contact's last name. Required if “Best person to contact” value is Listing Agent.
Listing Agent Home Number
listing_agent_home_number No Listing Agent contact's home phone #.
Listing Agent Work Number
listing_agent_work_number No Listing Agent Contact's work phone #.
Listing Agent Cell Number
listing_agent_cell_number No [conditional]
Listing Agent contact's cell #. Required if “Best person to contact” value is Listing Agent and Listing Agent Email is empty.
Listing Agent Email
listing_agent_email No [conditional]
Listing Agent contact's email address. Required if “Best
34
person to contact” value is Listing Agent and Listing Agent Cell# is empty.
Selling Agent Contact Name
selling_agent No [conditional]
Selling Agent contact's full name. Required if “Best person to contact” value is Selling Agent and First and Last name is empty.
Selling Agent Contact First Name
selling_agent_fname No [conditional]
Selling Agent contact's first name. Required if “Best person to contact” value is Selling Agent.
Selling Agent Contact Middle Name
selling_agent_mname No Selling Agent contact's middle name.
Selling Agent Contact Last Name
selling_agent_lname No [conditional]
Selling Agent contact's last name. Required if “Best person to contact” value is Selling Agent.
Selling Agent Home Number
selling_agent_home_number No Selling Agent contact's home phone #.
Selling Agent Work Number
selling_agent_work_number No Selling Agent Contact's work phone #.
Selling Agent Cell Number
selling_agent_cell_number No [conditional]
Selling Agent contact's cell #. Required if “Best person to contact” value is Selling Agent and Selling Agent Email is empty.
Selling Agent Email
selling_agent_email No [conditional]
Selling Agent contact's email address. Required if “Best person to contact” value is Selling Agent and Selling Agent Email is empty.
Best Person to Contact
primary_contact Yes Primary Contact must be one of following:
• Borrower
• Co-Borrower
• Owner
• Other
• Realtor
• Assistant
• Listing Agent
• Selling Agent
Comments comments No Special comment for appraisal.
Contract Document
appraisal_contract_content No [conditional]
Contract Document in Base 64 format
Contract Date appraisal_contract_date No [conditional]
Date of Contract
Contract Sales Price
appraisal_contract_salesprice No [conditional]
Sales Price of Contract
35
Contract Concession Price
appraisal_contract_concession No [conditional]
Concession amount of Contract
Concession Concession Type
appraisal_contract_concession_type No [conditional]
Type of Concession of Contract
• 0 = Amount
• 1 = Percentage
Rush Order appraisal_is_rush No • 0 = False
• 1 = True
Property View Type
property_view_type_id No Property View Type Id can be multiple with comma separated
Contract Name appraisal_contract_origname No [conditional]
Name of Contract
FIN# info_fin No Max 5 alphanumeric
Task Order info_task_order No Max 4 alphanumeric
Asset Number info_asset No Max 12 alphanumeric
Line info_line No Line should be (1 or 2 or 3)
Contractor info_contractor No Contractor name
Asset Type info_asset_type No Asset type should be (Settlement or ORE or Loan)
Lien Position info_lien_position No Lien Position
AMC Id amc_id No If AMC ID exists then override auto assigned AMC on newly created appraisal.
Override Borrower Delivery Option
override_borrower_delivery option No Flag to override borrower delivery option when order gets auto completed.
Estimated Closing Date
estimated_closing_date No [conditional]
Estimated Closing Date
Legal Description
comm_legal No Property Legal Description
Realtor Contact Name
realtor No [conditional]
Realtor contact's full name. Required if “Best person to contact” value is Realtor and First and Last name is empty.
Realtor Contact First Name
realtor_fname No [conditional]
Realtor contact's first name. Required if “Best person to contact” value is Realtor.
Realtor Contact Middle Name
realtor_mname No Realtor contact's middle name
Realtor Contact Last Name
realtor_lname No [conditional]
Realtor contact's last name. Required if “Best person to contact” value is Realtor.
Realtor Home Number
realtor_home_number No Realtor contact's home phone #.
Realtor Work Number
realtor_work_number No Realtor contact's work phone #.
Realtor Cell Number
realtor_cell_number No [conditional]
Realtor contact's cell #. Required if “Best person to contact” value is Realtor and Realtor Email is empty.
36
Realtor Email realtor_email No [conditional]
Realtor contact's email address. Required if “Best person to contact” value is Realtor and Realtor Email is empty.
Investor investor_id No [conditional]
If “Show the Investor field on the order form” option is set as 'Required', then this field is required.
Submitting Party Name
submitting_party_name Yes Sets the integration source
Response Parameters: Name Value Details Notes
Success Success For the API call status:
• success = true
• success = false
• “true” means everything was great “false” means something went wrong, check error code and error msg for details of the error
Appraisal status
appraisal_id Appraisal identifier for newly created appraisal.
File Number file_number File number of newly created appraisal.
Loan Number
loan_number Loan number of newly created appraisal.
Example Response Data:
{"success":true,"appraisal_id":7967,"sequence_number":"1", "file_number":"xyz293",
"loan_number":"LN12345678"}
Possible Error Codes:
E002, E003, E008, E016, E017, E021, E023, E024, E025
37
Add Form
This API call add a form to a completed appraisal in Appraisal Scope for the authenticated user. This is similar to
the create appraisal process with the difference being that it will attach a new order to the parent order in the
Appraisal Scope system.
Method Request URI Test Environment URL
POST /addform https://stage.appraisalscope.com/index.php/api/resapi/addform
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Appraisal Id to which you need to add the form
Client ID client_displayed_id Yes Client id of a Client who needs to be displayed on report. [Ref : Client Display On Report API Call]
Processor ID processor_id No Id of a user who is set as the processor for the appraisal. [ Ref : Processor API Call]
Due date due_date No Date by when appraisal is due. Date format must be yyyy-mm-dd [eg : - 2013-02-25]
Email address notify_email No Notify email address.
Address 1 address1 Yes Primary Address line of property.
Address 2 address2 No Secondary Address line of property.
City City Yes City of property.
State state Yes State of property.
Zip zip Yes Zip code of property.
County county No County of property
Property type property_type Yes Property type must be one of following:
• Single Family
• Multi Family
• Condominium
• Duplex
• Manufactured Home
• Mobile Home
• Modular Home
• Vacant Land
• Vacant Lot
• Other
Job Type job_type Yes Job type identifier. [Ref : Job type API call.]
38
Job Type Addon job_type-addon No A comma separated list of addon job type ids.
FHA Fha No [conditional]
If job type selected for appraisal is set to FHA = 1, then this field is required. [Ref: Check FHA API call.]
Job Fee job_fee Yes Client fee for the appraisal.
Management Fee
management_fee No Management fee set for given client and job type. If nothing is passed, API will consider 0.
Loan Type loan_type Yes Loan type identifier. [Ref : get Loan type API call.]
Intended Use intended_use Yes Intended use type identifier. [Ref : get Intended use API call.]
Loan Number loan_number Yes Loan number for the appraisal.
Loan Amount loan_amount No Amount of the loan.
Loan Officer loan_officer No Id of a user who is set as loan officer for appraisal. [Ref: Loan Officers API Call.]
Purchase Amount
purchase_amount No [conditional]
If Intended Use is set to Purchase, then Purchase amount is required.
Occupancy occupancy No Occupancy must be one of following:
• Owner
• Tenant
• Vacant
• New Construction
Entity Name entity_name No [conditional]
If Job Type AND Entity Name field by Job Type = “Commercial”, then this field OR Borrower first and last name are conditionally required. If Job Type AND Entity Name field by Job Type = “Residential”, then this field OR Borrower first and last name are conditionally required. If the Entity Name field by Job Type setting = Both, then this field OR Borrower first and last name are conditionally required.
Borrower Full Name
borrower_name No Borrower's full name.
Borrower First Name
borrower_fname Yes Borrower's first name.
Borrower Middle Name
borrower_mname No Borrower's middle name.
Borrower Last Name
borrower_lname Yes Borrower's last name.
Borrower Home Number
borrower_home_number No Borrower's home phone number
39
Borrower Work Number
borrower_work_number No Borrower's work phone number
Borrower Cell Number
borrower_cell_number No [conditional]
Borrower's cell phone number. Required if “Best person to contact” value is Borrower and Borrower Email is empty.
Borrower Email borrower_email Yes [conditional]
Borrower's email
Borrower Intent to Proceed Date
borrower_intent_to_proceed_date Yes [conditional]
If the “Require Borrower's Email Address” setting is Required, then this field is required. Else optional.
Mail Hard Copy to Borrower
mail_to_hard_copy_borrower No Borrower's Mail Hard Copy Option
Borrower Address1
borrower_address1 No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Borrower Address2
borrower_address2 No Borrower’s Address 2
Borrower City borrower_city No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Borrower State borrower_state No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Borrower Zip borrower_zip No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Borrower County
borrower_county No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower Full Name
coborrower_name No [conditional]
Co-borrower's full name. Required if “Best person to contact” value is Co-Borrower and First and last name field are empty.
40
Co-borrower First Name
coborrower_fname No [conditional]
Co-borrower's first name. Required if “Best person to contact” value is Co-Borrower
Co-borrower Middle Name
coborrower_mname No Co-borrower's middle name.
Co-borrower Last Name
coborrower_lname No [conditional]
Co-borrower's last name. Required if “Best person to contact” value is Co-Borrower
Co-Borrower Home Number
coborrower_home_number No Co-borrower's home phone #.
Co-Borrower Work Number
coborrower_work_number No Co-borrower's work phone #.
Co-Borrower Cell Number
coborrower_cell_number No [conditional]
Co-borrower's cell #. Required if “Best person to contact” value is Co-Borrower and Co-Borrower Email is empty.
Co-borrower Email
coborrower_email No [conditional]
Co-borrower's email address. Required if “Best person to contact” value is Co-Borrower and Borrower Cell# is empty.
Co-Borrower Intent to Proceed Date
coborrower_intent_to_proceed_date Yes [conditional]
IF "Co-Borrower Intent to Proceed" required? Set to 'Yes' and user have entered co-borrower first name then field is required else optional.
Mail Hard Copy To Co-borrower
mail_to_hard_copy_coborrower No Co-borrower's Mail Hard Copy Option
Co-borrower Address1
coborrower_address1 No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower Address2
coborrower_address2 No Co-borrower's Address2.
Co-borrower City
coborrower_city No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower State
coborrower_state No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower Zip
coborrower_zip No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower
41
is enabled, then this field is required.
Co-borrower County
coborrower_county No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Owner Name owner [Conditional] No Owner's full name. Required if “Best person to contact” value is Owner and First and Last name is empty.
Owner First Name
owner_fname No [conditional]
Owner's first name. Required if “Best person to contact” value is Owner.
Owner Middle Name
owner_mname No Owner's middle name.
Owner Last Name
owner_lname No [conditional]
Owner's Last Name. Required if “Best person to contact” value is Owner.
Owner Home Number
owner_home_number No Owner's home phone #.
Owner Work Number
owner_work_number No Owner's work phone #.
Owner Cell Number
owner_cell_number No [conditional]
Owner's cell #. Required if “Best person to contact” value is Owner and Owner Cell# is empty.
Owner Email owner_email No [conditional]
Owner's email address. Required if “Best person to contact” value is Owner and Owner Email is empty.
Other Contact Name
other No [conditional]
Other contact's full name. Required if “Best person to contact” value is Other and First and Last name is empty.
Other Contact First Name
other_fname No [conditional]
Other contact's first name. Required if “Best person to contact” value is Other.
Other Contact Middle Name
other_mname No Other contact's middle name.
Other Contact Last Name
other_lname No [conditional]
Other contact's last name. Required if “Best person to contact” value is Other.
Other Home Number
other_home_number No Other contact's home phone #.
Other Work Number
other_work_number No Other Contact's work phone #.
Other Cell Number
other_cell_number No [conditional]
Other contact's cell #. Required if “Best person to contact” value is Other and Other Cell# is empty.
42
Other Email other_email No [conditional]
Other contact's email address. Required if “Best person to contact” value is Borrower and Borrower Email is empty.
Assistant Contact Name
assistant No [conditional]
Assistant contact's full name. Required if “Best person to contact” value is Assistant and First and Last name is empty.
Assistant Contact First Name
assistant_fname No [conditional]
Assistant contact's first name. Required if “Best person to contact” value is Assistant.
Assistant Contact Middle Name
assistant_mname No Assistant contact's middle name.
Assistant Contact Last Name
assistant_lname No [conditional]
Assistant contact's last name. Required if “Best person to contact” value is Assistant
Assistant Home Number
assistant_home_number No Assistant contact's home phone #.
Assistant Work Number
assistant_work_number No Assistant Contact's work phone #.
Assistant Cell Number
assistant_cell_number No [conditional]
Assistant contact's cell #. Required if “Best person to contact” value is Assistant and Assistant Email is empty.
Assistant Email assistant_email No [conditional]
Assistant contact's email address. Required if “Best person to contact” value is Assistant and Assistant Cell# is empty.
Listing Agent Contact Name
listing_agent No [conditional]
Listing Agent contact's full name. Required if “Best person to contact” value is Listing Agent and First and Last name is empty.
Listing Agent Contact First Name
listing_agent_fname No [conditional]
Listing Agent contact's first name. Required if “Best person to contact” value is Listing Agent.
Listing Agent Contact Middle Name
listing agent mname No Listing Agent contact's middle name.
Listing Agent Contact Last Name
listing_agent_lname No [conditional]
Listing Agent contact's last name. Required if “Best person to contact” value is Listing Agent.
Listing Agent Home Number
listing_agent_home_number No Listing Agent contact's home phone #.
Listing Agent Work Number
listing_agent_work_number No Listing Agent Contact's work phone #.
Listing Agent Cell Number
listing_agent_cell_number No [conditional]
Listing Agent contact's cell #.
43
Required if “Best person to contact” value is Listing Agent and Listing Agent Email is empty.
Listing Agent Email
listing_agent_email No [conditional]
Listing Agent contact's email address. Required if “Best person to contact” value is Listing Agent and Listing Agent Cell# is empty.
Selling Agent Contact Name
selling_agent No [conditional]
Selling Agent contact's full name. Required if “Best person to contact” value is Selling Agent and First and Last name is empty.
Selling Agent Contact First Name
selling_agent_fname No [conditional]
Selling Agent contact's first name. Required if “Best person to contact” value is Selling Agent.
Selling Agent Contact Middle Name
selling_agent_mname No Selling Agent contact's middle name.
Selling Agent Contact Last Name
selling_agent_lname No [conditional]
Selling Agent contact's last name. Required if “Best person to contact” value is Selling Agent.
Selling Agent Home Number
selling_agent_home_number No Selling Agent contact's home phone #.
Selling Agent Work Number
selling_agent_work_number No Selling Agent Contact's work phone #.
Selling Agent Cell Number
selling_agent_cell_number No [conditional]
Selling Agent contact's cell #. Required if “Best person to contact” value is Selling Agent and Selling Agent Email is empty.
Selling Agent Email
selling_agent_email No
Selling Agent contact's email address.
Best Person to Contact
primary_contact Yes Primary Contact must be one of following:
• Borrower
• Co-Borrower
• Owner
• Other
• Realtor
• Assistant
• Listing Agent
• Selling Agent
Comments comments No Special comment for appraisal.
Contract Document
appraisal_contract_content No [conditional]
Contract Document in Base 64 format
Contract Date appraisal_contract_date No [conditional]
Date of Contract
Contract Sales Price
appraisal_contract_salesprice No [conditional]
Sales Price of Contract
44
Contract Concession Price
appraisal_contract_concession No [conditional]
Concession amount of Contract
Concession Concession Type
appraisal_contract_concession_type No [conditional]
Type of Concession of Contract
• 0 = Amount
• 1 = Percentage
Rush Order appraisal_is_rush No • 0 = False
• 1 = True
Property View Type
property_view_type_id No Property View Type Id can be multiple with comma separated
Contract Name appraisal_contract_origname No [conditional]
Name of Contract
FIN# info_fin No Max 5 alphanumeric
Task Order info_task_order No Max 4 alphanumeric
Asset Number info_asset No Max 12 alphanumeric
Line info_line No Line should be (1 or 2 or 3)
Contractor info_contractor No Contractor name
Asset Type info_asset_type No Asset type should be (Settlement or ORE or Loan)
Lien Position info_lien_position No Lien Position
AMC Id amc_id No If AMC ID exists then override auto assigned AMC on newly created appraisal.
Override Borrower Delivery Option
override_borrower_delivery option No Flag to override borrower delivery option when order gets auto completed.
Estimated Closing Date
estimated_closing_date No [conditional]
Estimated Closing Date
Investor investor_id No [conditional]
If “Show the Investor field on the order form” option is set as ‘Required’, then this field is required.
Legal Description
comm_legal No Property Legal Description
Realtor Contact Name
realtor No [conditional]
Realtor contact's full name. Required if “Best person to contact” value is Realtor and First and Last name is empty.
Realtor Contact First Name
realtor_fname No [conditional]
Realtor contact's first name. Required if “Best person to contact” value is Realtor.
Realtor Contact Middle Name
realtor_mname No Realtor contact's middle name
Realtor Contact Last Name
realtor_lname No [conditional]
Realtor contact's last name. Required if “Best person to contact” value is Realtor.
Realtor Home Number
realtor_home_number No Realtor contact's home phone #.
Realtor Work Number
realtor_work_number No Realtor contact's work phone #.
45
Realtor Cell Number
realtor_cell_number No [conditional]
Realtor contact's cell #. Required if “Best person to contact” value is Realtor and Realtor Email is empty.
Realtor Email realtor_email No Realtor contact's email address.
Response Parameters: Name Value Details Notes
Success Success For the API call status:
• success = true
• success = false
• “true” means everything was great “false” means something went wrong, check error code and error msg for details of the error
Appraisal status
appraisal_id Appraisal identifier for newly created appraisal.
File Number file_number File number of newly created appraisal.
Loan Number
loan_number Loan number of newly created appraisal.
Example Response Data:
{"success":true,"appraisal_id":7967,"sequence_number":"1", "file_number":"xyz293",
"loan_number":"LN12345678"}
Possible Error Codes:
E002, E003, E008, E014, E016, E017, E021, E024, E025
46
Update Appraisal
This API call updates appraisal details for an appraisal requested by the authenticated user.
Method Request URI Test Environment URL
POST /updateappraisal https://stage.appraisalscope.com/index.php/api/resapi/updateappraisal
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Appraisal Id to which you need to add the form
Client ID client_displayed_id No Client id of a Client who needs to be displayed on report. [Ref : Client Display On Report API Call]
Processor ID processor_id No Id of a user who is set as the processor for the appraisal. [ Ref : Processor API Call]
Due date due_date No Date by when appraisal is due. Date format must be yyyy-mm-dd [eg : - 2013-02-25]
Email address notify_email No Notify email address.
Address 1 address1 No Primary Address line of property.
Address 2 address2 No Secondary Address line of property.
City city No City of property.
State state No State of property.
Zip zip No Zip code of property.
County county No County of property
Property type property_type No Property type must be one of following:
• Single Family
• Multi Family
• Condominium
• Duplex
• Manufactured Home
• Mobile Home
• Modular Home
• Vacant Land
• Vacant Lot
• Other
Job Type job_type No Job type identifier. [Ref : Job type API call.]
Job Type Addon job_type-addon No A comma separated list of addon job type ids.
47
FHA Fha No If job type selected for appraisal is set to FHA = 1, then this field is required. [Ref: Check FHA API call.]
Job Fee job_fee No Client fee for the appraisal.
Management Fee
management_fee No Management fee set for given client and job type. If nothing is passed, API will consider 0.
Loan Type loan_type Yes Loan type identifier. [Ref : get Loan type API call.]
Intended Use intended_use Yes Intended use type identifier. [Ref : get Intended use API call.]
Loan Number loan_number Yes Loan number for the appraisal.
Loan Amount loan_amount No Amount of the loan.
Loan Officer loan_officer No Id of a user who is set as loan officer for appraisal. [Ref: Loan Officers API Call.]
Purchase Amount
purchase_amount No If Intended Use is set to Purchase, then Purchase amount is required.
Occupancy occupancy No Occupancy must be one of following:
• Owner
• Tenant
• Vacant
• New Construction
Borrower Full Name
borrower_name No Borrower's full name.
Borrower First Name
borrower_fname Yes Borrower's first name.
Borrower Middle Name
borrower_mname No Borrower's middle name.
Borrower Last Name
borrower_lname Yes Borrower's last name.
Borrower Home Number
borrower_home_number No Borrower's home phone number
Borrower Work Number
borrower_work_number No Borrower's work phone number
Borrower Cell Number
borrower_cell_number No [conditional]
Borrower's cell phone number. Required if “Best person to contact” value is Borrower and Borrower Email is empty.
Borrower Email borrower_email Yes [conditional]
Borrower's email
Borrower Intent to Proceed Date
borrower_intent_to_proceed_date Yes [conditional]
If the “Require Borrower's Email Address” setting is Required, then this field is required. Else optional.
Mail Hard Copy to Borrower
mail_to_hard_copy_borrower No Borrower's Mail Hard Copy Option
Borrower Address1
borrower_address1 No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and
48
company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Borrower Address2
borrower_address2 No Borrower’s Address 2
Borrower City borrower_city No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Borrower State borrower_state No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Borrower Zip borrower_zip No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Borrower County
borrower_county No [conditional]
If Mail Hard Copy To Borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower Full Name
coborrower_name No [conditional]
Co-borrower's full name. Required if “Best person to contact” value is Co-Borrower and First and last name field are empty.
Co-borrower First Name
coborrower_fname No [conditional]
Co-borrower's first name. Required if “Best person to contact” value is Co-Borrower
Co-borrower Middle Name
coborrower_mname No Co-borrower's middle name.
Co-borrower Last Name
coborrower_lname No [conditional]
Co-borrower's last name. Required if “Best person to contact” value is Co-Borrower
Co-Borrower Home Number
coborrower_home_number No Co-borrower's home phone #.
Co-Borrower Work Number
coborrower_work_number No Co-borrower's work phone #.
Co-Borrower Cell Number
coborrower_cell_number No [conditional]
Co-borrower's cell #. Required if “Best person to contact” value is Co-Borrower and Co-Borrower Email is empty.
49
Co-borrower Email
coborrower_email No [conditional]
Co-borrower's email address. Required if “Best person to contact” value is Co-Borrower and Borrower Cell# is empty.
Co-Borrower Intent to Proceed Date
coborrower_intent_to_proceed_date Yes [conditional]
IF "Co-Borrower Intent to Proceed" required? Set to 'Yes' and user have entered co-borrower first name then field is required else optional.
Mail Hard Copy To Co-borrower
mail_to_hard_copy_coborrower No Co-borrower's Mail Hard Copy Option
Co-borrower Address1
coborrower_address1 No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower Address2
coborrower_address2 No Co-borrower's Address2.
Co-borrower City
coborrower_city No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower State
coborrower_state No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower Zip
coborrower_zip No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Co-borrower County
coborrower_county No [conditional]
If Mail Hard Copy To Co-borrower option is set as 'Yes' and company setting Mail Hard Copy to Borrower/Co-borrower is enabled, then this field is required.
Owner Name owner [Conditional] No Owner's full name. Required if “Best person to contact” value is Owner and First and Last name is empty.
Owner First Name
owner_fname No [conditional]
Owner's first name. Required if “Best person to contact” value is Owner.
Owner Middle Name
owner_mname No Owner's middle name.
50
Owner Last Name
owner_lname No [conditional]
Owner's Last Name. Required if “Best person to contact” value is Owner.
Owner Home Number
owner_home_number No Owner's home phone #.
Owner Work Number
owner_work_number No Owner's work phone #.
Owner Cell Number
owner_cell_number No [conditional]
Owner's cell #. Required if “Best person to contact” value is Owner and Owner Cell# is empty.
Owner Email owner_email No [conditional]
Owner's email address. Required if “Best person to contact” value is Owner and Owner Email is empty.
Other Contact Name
other No [conditional]
Other contact's full name. Required if “Best person to contact” value is Other and First and Last name is empty.
Other Contact First Name
other_fname No [conditional]
Other contact's first name. Required if “Best person to contact” value is Other.
Other Contact Middle Name
other_mname No Other contact's middle name.
Other Contact Last Name
other_lname No [conditional]
Other contact's last name. Required if “Best person to contact” value is Other.
Other Home Number
other_home_number No Other contact's home phone #.
Other Work Number
other_work_number No Other Contact's work phone #.
Other Cell Number
other_cell_number No [conditional]
Other contact's cell #. Required if “Best person to contact” value is Other and Other Cell# is empty.
Other Email other_email No [conditional]
Other contact's email address. Required if “Best person to contact” value is Borrower and Borrower Email is empty.
Assistant Contact Name
assistant No [conditional]
Assistant contact's full name. Required if “Best person to contact” value is Assistant and First and Last name is empty.
Assistant Contact First Name
assistant_fname No [conditional]
Assistant contact's first name. Required if “Best person to contact” value is Assistant.
Assistant Contact Middle Name
assistant_mname No Assistant contact's middle name.
Assistant Contact Last Name
assistant_lname No [conditional]
Assistant contact's last name. Required if “Best person to contact” value is Assistant
51
Assistant Home Number
assistant_home_number No Assistant contact's home phone #.
Assistant Work Number
assistant_work_number No Assistant Contact's work phone #.
Assistant Cell Number
assistant_cell_number No [conditional]
Assistant contact's cell #. Required if “Best person to contact” value is Assistant and Assistant Email is empty.
Assistant Email assistant_email No [conditional]
Assistant contact's email address. Required if “Best person to contact” value is Assistant and Assistant Cell# is empty.
Listing Agent Contact Name
listing_agent No [conditional]
Listing Agent contact's full name. Required if “Best person to contact” value is Listing Agent and First and Last name is empty.
Listing Agent Contact First Name
listing_agent_fname No [conditional]
Listing Agent contact's first name. Required if “Best person to contact” value is Listing Agent.
Listing Agent Contact Middle Name
listing_agent_mname No Listing Agent contact's middle name.
Listing Agent Contact Last Name
listing_agent_lname No [conditional]
Listing Agent contact's last name. Required if “Best person to contact” value is Listing Agent.
Listing Agent Home Number
listing_agent_home_number No Listing Agent contact's home phone #.
Listing Agent Work Number
listing_agent_work_number No Listing Agent Contact's work phone #.
Listing Agent Cell Number
listing_agent_cell_number No [conditional]
Listing Agent contact's cell #. Required if “Best person to contact” value is Listing Agent and Listing Agent Email is empty.
Listing Agent Email
listing_agent_email No [conditional]
Listing Agent contact's email address. Required if “Best person to contact” value is Listing Agent and Listing Agent Cell# is empty.
Selling Agent Contact Name
selling_agent No [conditional]
Selling Agent contact's full name. Required if “Best person to contact” value is Selling Agent and First and Last name is empty.
Selling Agent Contact First Name
selling_agent_fname No [conditional]
Selling Agent contact's first name. Required if “Best person to contact” value is Selling Agent.
52
Selling Agent Contact Middle Name
selling_agent_mname No Selling Agent contact's middle name.
Selling Agent Contact Last Name
selling_agent_lname No [conditional]
Selling Agent contact's last name. Required if “Best person to contact” value is Selling Agent.
Selling Agent Home Number
selling_agent_home_number No Selling Agent contact's home phone #.
Selling Agent Work Number
selling_agent_work_number No Selling Agent Contact's work phone #.
Selling Agent Cell Number
selling_agent_cell_number No [conditional]
Selling Agent contact's cell #. Required if “Best person to contact” value is Selling Agent and Selling Agent Email is empty.
Selling Agent Email
selling_agent_email No
Selling Agent contact's email address.
Best Person to Contact
primary_contact No Primary Contact must be one of following:
• Borrower
• Co-Borrower
• Owner
• Other
• Realtor
• Assistant
• Listing Agent
• Selling Agent
Comments comments No Special comment for appraisal.
Contract Document
appraisal_contract_content No [conditional]
Contract Document in Base 64 format
Contract Date appraisal_contract_date No [conditional]
Date of Contract
Contract Sales Price
appraisal_contract_salesprice No [conditional]
Sales Price of Contract
Contract Concession Price
appraisal_contract_concession No [conditional]
Concession amount of Contract
Concession Concession Type
appraisal_contract_concession_type No [conditional]
Type of Concession of Contract
• 0 = Amount
• 1 = Percentage
Rush Order appraisal_is_rush No • 0 = False
• 1 = True
Property View Type
property_view_type_id No Property View Type Id can be multiple with comma separated
Contract Name appraisal_contract_origname No [conditional]
Name of Contract
FIN# info_fin No Max 5 alphanumeric
Task Order info_task_order No Max 4 alphanumeric
Asset Number info_asset No Max 12 alphanumeric
Line info_line No Line should be (1 or 2 or 3)
Contractor info_contractor No Contractor name
53
Asset Type info_asset_type No Asset type should be (Settlement or ORE or Loan)
Lien Position info_lien_position No Lien Position
Override Borrower Delivery Option
override_borrower_delivery_option No Flag to override borrower delivery option when order gets auto completed.
Estimated Closing Date
estimated_closing_date No Estimated Closing Date
Investor investor_id No [conditional]
If “Show the Investor field on the order form” option is set as ‘Required’, then this field is required.
Legal Description
comm_legal No Property Legal Description
Realtor Contact Name
Realtor No [conditional]
Realtor contact's full name. Required if “Best person to contact” value is Realtor and First and Last name is empty.
Realtor Contact First Name
realtor_fname No [conditional]
Realtor contact's first name. Required if “Best person to contact” value is Realtor.
Realtor Contact Middle Name
realtor_mname No Realtor contact's middle name
Realtor Contact Last Name
realtor_lname No [conditional]
Realtor contact's last name. Required if “Best person to contact” value is Realtor.
Realtor Home Number
realtor_home_number No Realtor contact's home phone #.
Realtor Work Number
realtor_work_number No Realtor contact's work phone #.
Realtor Cell Number
realtor_cell_number No [conditional]
Realtor contact's cell #. Required if “Best person to contact” value is Realtor and Realtor Email is empty.
Realtor Email realtor_email No Realtor contact's email address.
Response Parameters: Name Value Details Notes
Success Success For the API call status:
• success = true
• success = false
• “true” means everything was great “false” means something went wrong, check error code and error msg for details of the error
Appraisal status
appraisal_id Appraisal identifier for newly created appraisal.
File Number file_no File number of newly created appraisal.
Loan Number
loan_no Loan number of newly created appraisal.
54
Example Response Data:
{"success":true, "appraisal_id":"123456", "loan_no":"LN12345678", "file_no":"xyz123" }
Possible Error Codes:
E002, E003, E009, E013, E016, E017, E021, E025, E027
55
Payment Authorize & Capture
This API call helps capture the amount charged on the credit card. First, it authorizes the card details. If approved,
it captures the amount that will need to be settled.
Method
Request URI Test Environment URL
POST /paymentauthcapture
https://stage.appraisalscope.com/index.php/api/resapi/paymentauthcapture
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Id of an appraisal for which payment is being made.
Token token Yes Unique code generated for transaction. Extra measure for securely tracking it.
First Name first_name Yes First name of a person whose card is being charged.
Last Name last_name Yes Last name of a person whose card is being charged.
Address 1 address1 Yes Primary address line of a person whose card is being charged.
Address 2 address2 No Secondary address line of a person whose card is being charged.
City city Yes City of a person whose card is being charged.
State state Yes State of a person whose card is being charged.
Zip zip Yes Zip of a person whose card is being charged.
Country country No Country of a person whose card is being charged.
Phone phone No Person's phone #
Email email Yes Person's email address for sending receipt of transaction etc.
CC # credit_card_number Yes Credit card # for transaction.
CC Expiry Date
expiry_date Yes Credit card expiration date. Format: yyyy-mm
CCV # card_code Yes 3 or 4 digit CCV # of credit card, which is found on back of CC in most cases.
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Transaction Id
transaction_id Transaction id returned by payment gate way on successful transaction.
56
Example Response Data: {"success":true,"transaction_id":21267}
Possible Error Codes: E002, E003, E004
57
Payment Authorize Only
This API call authorizes the users credit card for payment.
Note: The credit card is not actually charged until the Capture request is made.
Method Request URI Test Environment URL
POST /paymentauthonly https://stage.appraisalscope.com/index.php/api/resapi/paymentauthonly
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Id of an appraisal for which payment is being made.
Token token Yes Unique code generated for transaction. Extra measure for securely tracking it.
First Name first_name Yes First name of a person whose card is being charged.
Last Name last_name Yes Last name of a person whose card is being charged.
Address 1 address1 Yes Primary address line of a person whose card is being charged.
Address 2 address2 No Secondary address line of a person whose card is being charged.
City city Yes City of a person whose card is being charged.
State state Yes State of a person whose card is being charged.
Zip zip Yes Zip of a person whose card is being charged.
Country country No Country of a person whose card is being charged.
Phone phone No Person's phone #
Email email Yes Person's email address for sending receipt of transaction etc.
CC # credit_card_number Yes Credit card # for transaction.
CC Expiry Date
expiry_date Yes Credit card expiration date. Format: yyyy-mm
CCV # card_code Yes 3 or 4 digit CCV # of credit card, which is found on back of CC in most cases.
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Transaction Id
transaction_id Transaction id returned by payment gate way on successful transaction.
58
Example Response Data: {"success":true,"transaction_id":21267}
Possible Error Codes: E002, E003, E004
59
Payment Capture Only
This API call can be used to capture payments for transactions previously authorized. If a transaction was not
previously authorized, then use “Payment Authorize and Capture” API instead of this one.
Note: The credit card is not actually charged until the Capture request is made.
Method Request URI Test Environment URL
POST /paymentcapture https://stage.appraisalscope.com/index.php/api/resapi/paymentcapture
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Id of an appraisal for which payment is being made.
Token token Yes Unique code generated for transaction. Extra measure for securely tracking it.
Email email Yes Person's email address for sending receipt of transaction etc.
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Transaction Id
transaction_id Transaction id returned by payment gate way on successful transaction.
Example Response Data: {"success":true,"transaction_id":21267}
Possible Error Codes: E002, E003, E004
60
Partial Payment
This API call is used to make a partial payment. The Amount send as partial payment will be authorized. If
authorized successfully, then it will be captured and sent for settlement too. The remaining amount will be
invoiced to the client.
Method Request URI Test Environment URL
POST /partialpayment https://stage.appraisalscope.com/index.php/api/resapi/partialpayment
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Id of an appraisal for which payment is being made.
Token token Yes Unique code generated for transaction. Extra measure for securely tracking it.
Partial Amount
partial_amount Yes Amount to be paid from total appraisal amount.
First Name first_name Yes First name of a person whose card is being charged.
Last Name last_name Yes Last name of a person whose card is being charged.
Address 1 address1 Yes Primary address line of a person whose card is being charged.
Address 2 address2 No Secondary address line of a person whose card is being charged.
City city Yes City of a person whose card is being charged.
State state Yes State of a person whose card is being charged.
Zip zip Yes Zip of a person whose card is being charged.
Country country No Country of a person whose card is being charged.
Phone phone No Person's phone #
Email email Yes Person's email address for sending receipt of transaction etc.
CC # credit_card_number Yes Credit card # for transaction.
CC Expiry Date
expiry_date Yes Credit card expiration date. Format: yyyy-mm
CCV # card_code Yes 3 or 4 digit CCV # of credit card, which is found on back of CC in most cases.
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Transaction Id
transaction_id Transaction id returned by payment gate way on successful transaction.
61
Example Response Data: {"success":true,"transaction_id":21267}
Possible Error Codes: E002, E003, E004
62
Split Payment
This API call is used to make payment using different credit cards for the same order at once. All credit cards will
be authorized and charged right away. All transaction for all involved credit cards will be sent for settlement if
authorized and charged successfully.
Note: In addition to updating billing and payment information, the user can pay with credit cards that have
different emails.
Method Request URI Test Environment URL
POST /splitpayment https://stage.appraisalscope.com/index.php/api/resapi/splitpayment
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Id of an appraisal for which payment is being made.
Token token Yes Unique code generated for transaction. Extra measure for securely tracking it.
Payment Data
payment_data (array) Yes Multiple payment information for amount and CC details
amount Amount to pay
credit_card_number Credit card number user wants to pay with
expiry_date Expiry date of credit card
card_code Credit card security code (CVI)
first_name First name on the credit card
last_name Last name on the credit card
address1 Billing address line 1
address2 Billing address line 2
city Billing address city
state Billing address state
zip Billing address zip
phone Phone number
email Email address of the person
is_edit_payment_profile_info Select this option if the user wants to update their payment profile info
is_edit_billing_info Select this option if the user wants to update their billing information
63
Example Request Data:
amount:"200", credit_card_number:"601000000012", expiry_date:"2022-12", card_code:"123" first_name:”diana”
last_name:”berlin” address1:”720, main street” address2:”” city:”Lawrenceville” state:”GA” zip:”30045”
phone:”444-444-4444” email:”[email protected]”
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Response Data
response_data (array) Response data with details of each credit card transaction and status (success or failure)
first_name
last_name
address1
address2
city
state
zip
phone
credit_card_number
expiry_date
card_code
amount
is_edit_payment_profile_info
is_edit_billing_info
transaction_id
Example Response Data:
{"success":true,"response_data":{"1":
{"first_name":"t1","last_name":"t1","address1":"t1","address2":"","city":"t1","state":"t1","zip":"t1
","phone":"t1","email":"[email protected]","credit_card_number":"4556377039352507
","expiry_date":"2015-
02","card_code":"123","amount":"800","is_edit_payment_profile_info":"1","is_edit_billing_info":"
1","response":"Success","transaction_id":"2209943219"},"2":
{"first_name":"t2","last_name":"t2","address1":"t2","address2":"","city":"t2","state":"t2","zip":"t2
","phone":"t2","email":"[email protected]","credit_card_number":"4556846188992792
","expiry_date":"2016-
64
02","card_code":"123","amount":"98.99","is_edit_payment_profile_info":"1","is_edit_billing_info
":"1","response":"Success","transaction_id":"2209943221"}}}
Possible Error Codes: E002, E003, E004, E018, E019
65
Send Invoice
This API call is used to send an invoice for the appraisal to a specified email address.
Method Request URI Test Environment URL
POST /sendinvoice https://stage.appraisalscope.com/index.php/api/resapi/sendinvoice
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Id of an appraisal for which payment is being made.
Email email Yes Person's email address for sending receipt of transaction etc.
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Example Response Data: {"success":true}
Possible Error Codes: E002, E003
66
Bill Invoice
This API call is used to send an invoice for the appraisal to a specified email address.
Method Request URI Test Environment URL
POST /billinvoice https://stage.appraisalscope.com/index.php/api/resapi/billinvoice
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Id of an appraisal for which payment is being made.
Bill Me Option
bill_me_option No The options below are allowed: 1 = Bank 2 = Borrower
Bill Me Note bill_me_note No Bill me note
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Example Response Data: {"success":true}
Possible Error Codes: E002, E003
67
Save Payment to Capture Later
This API call will save payment details on the PCI compliance server of authorize.net. The credit card won’t be
charged until the Capture request is made.
Method Request URI Test Environment URL
POST /paymenttocapturelater https://stage.appraisalscope.com/index.php/api/resapi/paymenttocapturelater
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Id of an appraisal for which payment is being made.
Token token Yes Unique code generated for transaction. Extra measure for securely tracking it.
First Name first_name Yes First name of a person whose card is being charged.
Last Name last_name Yes Last name of a person whose card is being charged.
Address 1 address1 Yes Primary address line of a person whose card is being charged.
Address 2 address2 No Secondary address line of a person whose card is being charged.
City city Yes City of a person whose card is being charged.
State state Yes State of a person whose card is being charged.
Zip zip Yes Zip of a person whose card is being charged.
Country country No Country of a person whose card is being charged.
Phone phone No Person's phone #
Email email Yes Person's email address for sending receipt of transaction etc.
CC # credit_card_number Yes Credit card # for transaction.
CC Expiry Date
expiry_date Yes Credit card expiration date. Format: yyyy-mm
CCV # card_code Yes 3 or 4 digit CCV # of credit card, which is found on back of CC in most cases.
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Example Response Data: {"success":true}
Possible Error Codes: E002, E003, E004
68
Echeck Payment
This API call captures the amount using the Echeck Payment method. It first authorizes the details, and if
approved, it captures the amount which then goes to settlement.
Method Request URI Test Environment URL
POST /echeckpayment https://stage.appraisalscope.com/index.php/api/resapi/echeckpayment
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Id of an appraisal for which payment is being made.
Token token Yes Unique code generated for transaction. Extra measure for securely tracking it.
First Name first_name Yes First name of a person whose bank account is being charged.
Last Name last_name Yes Last name of a person whose bank account is being charged.
Address 1 address1 Yes Primary address line of a person whose bank account is being charged.
Address 2 address2 No Secondary address line of a person whose bank account is being charged.
City city Yes City of a person whose bank account is being charged.
State state Yes State of a person whose bank account is being charged.
Zip zip Yes Zip of a person whose bank account is being charged.
Phone phone No Person's phone #
Email email Yes Person's email address for sending receipt of transaction etc.
Bank Name bank_name Yes Bank Name
Bank Account Number
bank_account_number Yes Bank Account Number
ABA Routing Number
aba_routing_number Yes ABA Routing Number
Name on Account
name_on_account Yes Name on Account
Bank Account Type
bank_account_type Yes Allowed Bank Account Types:
• checking
• businessChecking
• savings
Amount amount Yes Amount to be paid.
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
69
Transaction Id
transaction_id Transaction id returned by payment gate way on successful transaction.
Example Response Data: {"success":true,"transection_id":"2222392139"}
Possible Error Codes: E002, E003, E004
70
Get Payment Options
This API call is used to retrieve all payment options available for the authenticated client.
Method Request URI Test Environment URL
POST /getpaymentoptions https://stage.appraisalscope.com/index.php/api/resapi/getpaymentoptions
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Payment Form Available
payment_form_available Indicates if the user is allowed to see payment form or not.
• 1 = Allowed
• 0 = Not allowed
Payment Options
payment_options
• id
• name
Payment option list with available payment types for the logged in user. All options will be listed with id and readable names.
Example Response Data: {"success":true,"result":{"payment_form_available":"1","payment_options":
[{"id":"authorize_and_capture","name":"Authorize and Capture"},{"id":"bill_me","name":"Bill
Me"},{"id":"split_payment","name":"Split Payment"},{"id":"partial_payment","name":"Partial Payment"}]}}
Possible Error Codes: E002, E003
71
Get Appraisal Documents
This API call is used to retrieve all appraisal documents & additional documents for the authenticated client.
Method Request URI Test Environment URL
POST /retrieveappraisaldocuments https://stage.appraisalscope.com/index.php/api/resapi/retrieveappraisaldocuments
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal Id appraisal_id Yes Appraisal ID of an appraisal for which document list needs to be fetched.
Additional Document Flag
get_additional_documents No Decides if additional documents attached with appraisal should be fetched too or not. If parameter value is set 1, then additional documents will also be fetched. Else only appraisal report is fetched.
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Result All available documents with their details are supplied in this variable. If a document has both an XML and PDF version then document_id of the xml version will be like, 1111_XML and for pdf version document_id will be like 1111, where 1111 is assumed as original document_id. So while sending request for “retrieve document content”, one must send document_id in same format as mentioned above and API will interpret which version (xml/pdf) of document needs to be send back.
document_id
appraisal_id
loan_no
file_no
document_url
document_filename
document_description
document_size
has_xml
xml_filename
create_date
is_addition_doc
ucdp_order_id
ucdp_orderstatus
ucdp_document_id
ucdp_fnm_filename
ucdp frd filename
document type
72
Example Response Data: {"success":true,"result":
[{"document_id":"25900_XML","appraisal_id":"29870","loan_no":"LN_12345678","file_no":"XYZ1
23","document_url":"http:\/\/ascope-docs.s3.amazonaws.com\/Jain(EFG2449)-
V1.xml","document_filename":"Jain(EFG2449)-
V1.xml","document_description":null,"document_size":"372505","has_xml":"1","xml_filename":"J ain(EFG2449)-
V1.xml","create_date":"2016-04-25
00:33:45","is_addition_doc":"0","ucdp_order_id":null,"ucdp_orderstatus":null,"ucdp_document_i
d":null,"ucdp_fnm_filename":"","ucdp_frd_filename":"","document_type":"Appraisal
Document"},{"document_id":"25900","appraisal_id":"29870","document_url":"http:\/\/ascope-
docs.s3.amazonaws.com\/Jain(EFG2449)-V1.pdf","document_filename":"Jain(EFG2449)-
V1.pdf","document_description":null,"document_size":"372505","has_xml":"1","xml_filename":"J ain(EFG2449)-
V1.xml","create_date":"2016-04-25
00:33:45","is_addition_doc":"0","ucdp_order_id":null,"ucdp_orderstatus":null,"ucdp_document_i
d":null,"ucdp_fnm_filename":"","ucdp_frd_filename":"","document_type":"Appraisal Document"}]}
Possible Error Codes: E002, E003, E030
73
Add Appraisal Document
This API call is used to upload additional documents for a requested appraisal.
Method Request URI Test Environment URL
POST /uploaddocument https://stage.appraisalscope.com/index.php/api/resapi/uploaddocument
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal Identity
appraisal_id Yes Appraisal ID of the appraisal documents will be added to
File Name file name Yes Original name of the file to be uploaded.
Document Content
Content Yes File Content in Base 64 encoded format.
Document Type
doc_type No Type of document. [Example: Invoice, Purchase Contract etc.]
Document Title
doc_title No Title of Document (use when doc type is "Other" )
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Document ID
Result
• Document_id
Identifier of a document for which file content is being retrieved.
Example Response Data: {"success":true,"result":{"document_id":30465}}
Possible Error Codes: E002, E003, E015, E011
74
Add Multi-Appraisal Document
This API call is used to upload multiple additional documents for a requested appraisal.
Method Request URI Test Environment URL
POST /uploaddocumentmulti https://stage.appraisalscope.com/index.php/api/resapi/uploaddocumentmulti
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal Identity
appraisal_id Yes Appraisal ID of the appraisal documents will be added to
Documents Documents Yes Documents key with array values Example: Array(content => Document Content, file_name => File Name, doc_type => Document Type);
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Example Response Data: • Everything is good:
{"success":true}
• Partially uploaded:
{"success":true,"response":{"EoDoc.pdf":
{"documentUpload":"success"},"notificaiton.xml":{"ErrorMsg":"Invalid file
extension","documentUpload":"fail"}}}
• All documents failed:
{"success":false,"response":{"EoDoc.xml":{"ErrorMsg":"Invalid file
extension","documentUpload":"fail"},"notificaiton.xml":{"ErrorMsg":"Invalid file
extension","documentUpload":"fail"}}}
Possible Error Codes: E002, E003, E015
75
Get Property View Type
This API call is used to fetch the property characteristics for a requested appraisal.
Method Request URI Test Environment URL
POST /getpropertytypeview https://stage.appraisalscope.com/index.php/api/resapi/getpropertytypeview
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Property View Type
property_view_type_id Yes Name of a Property View Type. You can pass multiple with comma separating them
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Result property_view_type_id When success = true, result array will contain property characteristics with the following details: property view type id = Property View Type ID
Example Response Data: {"success":true,"result":{"property_view_type_id": ["11"]}}
Possible Error Codes: E002, E003, E011, E012
76
Get Appraisals Document Content
This API call is used to retrieve content of a particular appraisal document file.
Method Request URI Test Environment URL
POST /retrievedocumentcontent https://stage.appraisalscope.com/index.php/api/resapi/retrievedocumentcontent
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Document ID Result Document_id
Yes Identifier of a document for which file content is being retrieved.
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Result result File content in Base64 encoded format.
Example Response Data: {"success":true,"result":[{"File Content"}]}
Possible Error Codes: E002, E003
77
Get Appraisal Comment
This API call is used to retrieve all comments for a particular appraisal.
Method Request URI Test Environment URL
POST /getcomments https://stage.appraisalscope.com/index.php/api/resapi/getcomments
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Appraisal ID that comments will be retrieved for
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Result result
• comment_id
• comment
• comment_by
• comment_date
When success= true, the result array will contain all comments with following details:
• comment_id = Comment ID
• comment = Comment's actual message
• comment_by = Name of the Person who wrote the comment
• comment date = Date when the comment was written
Example Response Data:
{"success":true,"result":[{"comment_id":"602","comment":"Notification: being reviewed by appraiser Message:
","comment_by":" rt(Appraiser)","comment_date":"2012-06-26 01:46:30"},
{"comment_id":"596","comment":"great job","comment_by":" (Appraiser)","comment_date":"2012-06-26
00:55:39"}]}
Possible Error Codes: E002, E003
78
Add Appraisal Comment
This API call is used to add a comment to an appraisal.
Method Request URI Test Environment URL
POST /addcomment https://stage.appraisalscope.com/index.php/api/resapi/addcomment
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Appraisal ID that comments will be added to
Comment Message
comment Yes Message of the comment. Comment's actual text.
Log Only log_only No If this parameter is passed, the message will not be shown in the messages queue.
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Comment Id comment_id For the API call status:
• success = true [Everything went well.]
• success = false [Something went wrong.]. Includes a failure error code and error msg.
Example Response Data:
{"success":true,"comment_id":4043}
Possible Error Codes: E002, E003, E011
79
Get Appraisal Revisions/Stipulations
This API call is used to retrieve the revision details for an appraisal.
Method Request URI Test Environment URL
POST /getrevisions https://stage.appraisalscope.com/index.php/api/resapi/getrevisions
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Appraisal ID that the revisions details will be retrieved for
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Result result
• revision_id
• revision
• revision_by
• revision_date
When success= true, the resulting array with all revision comments will be returned. Each revision element will contain following information:
• revision_id - Revision's identity number.
• revision - Revision's message details.
• revision_by - Name of person who initiated revision.
• revision date - Date when revision was initiated.
Example Response Data:
{"success":true,"result":[{"revision_id":"148","revision":"This is test revision from
API","revision_by":"Client","revision_date":"2013-04-18 04:41:59"}, {"revision_id":"147","revision":"This is test
revision from API","revision_by":"Client","revision_date":"2013-04-17 12:11:26"}]}
Possible Error Codes: E002, E003, E012
80
Add Appraisal Revisions/Stipulations
This API call is used to initiate a revision for an appraisal.
Method Request URI Test Environment URL
POST /addrevision https://stage.appraisalscope.com/index.php/api/resapi/addrevision
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Appraisal ID that the revision will be added to
Revision Message
Revision Yes Revision message to be added to revision entry
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Revision ID revision_id When success = true, the Revision Id will be returned
Example Response Data:
{"success":true,"revision_id":149}
Possible Error Codes: E002, E003, E011, E012
81
Get Job Type Addons
This API call is used to retrieve all selected addons for a given job type.
Method Request URI Test Environment URL
POST /getjobtypeaddons https://stage.appraisalscope.com/index.php/api/resapi/getjobtypeaddons
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Job Type job_type Yes Job type identifier for the Appraisal Scope system
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great. “false” means something went wrong. Check error code and error msg for details of the error.
Result result
• id
• name
When success = true, a result array with all selected addons for given job type will be returned with their id and name.
Example Response Data:
{"success":true,"result":[{"id":"5","name":"(1004) URAR + 1004MC w\/Comp. Rent
Schedule(FHA)"},{"id":"7","name":"(1004) URAR + 1004MC with Income Statement"}, {"id":"10","name":"(1004)
URAR Full Single Family + 1004MC(1 MIL+)"},{"id":"12","name":"(1025) 2-4 Family Full"},{"id":"15","name":"(1073)
Condo + 1004MC"}]}
Possible Error Codes: E001, E003
82
Upload Contract Document
This API call is used to add a Contract document to an order.
Method Request URI Test Environment URL
POST /uploadcontract https://stage.appraisalscope.com/index.php/api/resapi/uploadcontract
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Appraisal Id for order identifier
Content content Yes Document Content
File Name file_name Yes Document Identifier
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great.
• “false” means something went wrong. Check error code and error msg for details of the error.
Result result
• document_id
When success = true, the result includes a document id
Example Response Data:
{"success":true,"result":{"document_id":30465}}
Possible Error Codes: E001, E003
83
Upload Contract Document Multi
This API call is used to add multiple Contract documents to an order.
Method Request URI Test Environment URL
POST /uploadcontractmulti https://stage.appraisalscope.com/index.php/api/resapi/uploadcontractmulti
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Appraisal Id for order identifier
Documents documents Yes Array with a key file name, content, and doc type
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great.
• “false” means something went wrong. Check error code and error msg for details of the error.
Result result
• document_ids
When success = true, the result includes document ids
Example Response Data:
{"success":true,"result":{"document_ids":array('123123123','987987')}}
Possible Error Codes: E001, E003
84
Get Details of an Appraisal for Add Appraisal Form
This API call is used to get details of a requested appraisal for Add Appraisal Form.
Method Request URI Test Environment URL
POST /getaddformdetail https://stage.appraisalscope.com/index.php/api/resapi/getaddformdetail
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Appraisal ID appraisal_id Yes Appraisal Id for order identifier
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great.
• “false” means something went wrong. Check error code and error msg for details of the error.
Result result
• appraisal_assigned_to
• due_date
• ordered_for
• client_dispayed_on_report
• job_type
• loan_officer
• processor
• notify_email
• loan_number
• loan_type
• loan_amount
• purchase_amount
• fha
• job_fee
• address1
• address2
• city
• state
• zip
• county
• property_type
• occupancy
• borrower_fname
• borrower_mname
• borrower_lname
• borrower_home_number
• borrower_work_number
When success = the result includes an array
85
• borrower_cell_number
• borrower_email
• coborrower_fname
• coborrower_mname
• coborrower_lname
• coborrower_home_number
• coborrower_work_number
• coborrower_cell_number
• coborrower_email
• owner_fname
• owner_mname
• owner_lname
• owner_home_number
• owner_work_number
• owner_cell_number
• owner_email
• realtor_fname
• realtor_mname
• realtor_lname
• realtor_home_number
• realtor_work_number
• realtor_cell_number
• realtor_email
• other_fname
• other_mname
• other_lname
• other_home_number
• other_work_number
• other_cell_number
• other_email
• assistant_fname
• assistant_mname
• assistant_lname
• assistant_home_number
• assistant_work_number
• assistant_cell_number
• assistant_email
• listing_agent_fname
• listing_agent_mname
• listing_agent_lname
• listing_agent_home_number
• listing_agent_work_number
• listing_agent_cell_number
• listing_agent_email
• selling_agent_fname
• selling_agent_mname
• selling_agent_lname
• selling_agent_home_number
• selling_agent_work_number
• selling_agent_cell_number
86
• selling_agent_email
• primary_contact
• comments
Example Response Data:
{"success":true,"result":
{"appraisal_assigned_to":"43776","due_date":"","ordered_for":"4385059","client_dispayed_on_re
port":"4380","job_type":"5183","loan_officer":"0","processor":null,"notify_email":"","loan_numb
er":"341245","loan_type":"Other","loan_amount":"0","purchase_amount":"0","fha":"","job_fee":
"1000.00","address1":"1231","address2":"","city":"New york","state":"NY","zip":"","county":"New
york","property_type":"Single
Family","occupancy":"Owner","borrower_fname":"mahavir","borrower_mname":"p","borrower_l
name":"Jain","borrower_home_number":"8789","borrower_work_number":"","borrower_cell_nu
mber":"98798789","borrower_email":"[email protected]","coborrower_fname":"123","coborrower_
mname":"","coborrower_lname":"","coborrower_home_number":"","coborrower_work_number"
:"","coborrower_cell_number":"","coborrower_email":"","owner_fname":"","owner_mname":"","
owner_lname":"","owner_home_number":"","owner_work_number":"","owner_cell_number":"",
"owner_email":"","realtor_fname":"RealtorFirst","realtor_mname":"RealtorMiddle","realtor_lnam
e":"RealtorLast","realtor_home_number":"111-111-1111","realtor_work_number":"222-222-
2222","realtor_cell_number":"333-333-
3333","realtor_email":"[email protected]","other_fname":"test","other_mname":"","other_lna
me":"","other_home_number":"","other_work_number":"","other_cell_number":"","other_email
":"","assistant_fname":null,"assistant_mname":null,"assistant_lname":null,"assistant_home_numb
er":null,"assistant_work_number":null,"assistant_cell_number":null,"assistant_email":null,"listing
_agent_fname":null,"listing_agent_mname":null,"listing_agent_lname":null,"listing_agent_home_
number":null,"listing_agent_work_number":null,"listing_agent_cell_number":null,"listing_agent_e
mail":null,"selling_agent_fname":null,"selling_agent_mname":null,"selling_agent_lname":null,"sel
ling_agent_home_number":null,"selling_agent_work_number":null,"selling_agent_cell_number":
null,"selling_agent_email":null,"primary_contact":"","comments":"."}}
Possible Error Codes: E001, E003
87
Create Client User
This API call is used to create a new client user.
Method Request URI Test Environment URL
POST /createclientuser https://stage.appraisalscope.com/index.php/api/resapi/createclientuser
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Username user_name Yes Username for Appraisal Scope system.
Email email Yes Email address of new user.
First Name first_name Yes First name of user.
Last Name last_name Yes Last name of user.
Password password Yes Password of user to login.
Level level_id Yes Level of user
Internal Id internal_id No Internal Id of user
Branch Id branch_id No Branch Id of user
Internal Branch Id
internal_branch_id No Internal Branch Id of user
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great.
• “false” means something went wrong. Check error code and error msg for details of the error.
UserId user_id User id of Appraisal Scope system
Username username Unique username of created user
Result Result Success message if user is created
Example Response Data:
{"success":true,"result":"User created successfully","user_name":"testuser","user_id":"438542"}
Possible Error Codes: E001, E003
88
Update Client User
This API call is used to update a client user.
Method Request URI Test Environment URL
POST /update_client_user https://stage.appraisalscope.com/index.php/api/resapi/update_client_user/<user_id>
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Username user_name Yes Username for Appraisal Scope system.
Email email Yes Email address of new user.
First Name first_name Yes First name of user.
Last Name last_name Yes Last name of user.
Password password Yes Password of user to login.
Level level_id Yes Level of user
Address 1 address1 Yes The user’s address line 1
Address 2 address2 No The user’s address line 2
City city Yes The user’s address city
State state Yes The user’s address state
Zip Code zip Yes The user’s address zip code
Internal Id internal_id No Internal Id of user
Branch Id branch_id No Branch Id of user
Internal Branch Id
internal_branch_id No Internal Branch Id of user
Response Parameters: Name Value Details Notes
Success success For the API call status:
• success = true
• success = false
• “true” means everything was great.
• “false” means something went wrong. Check error code and error msg for details of the error.
UserId user_id User id of Appraisal Scope system
Username username Unique username of created user
Result Result Success message if user is created
Example Response Data:
{"success":true,"result":"User updated successfully","user_name":"testuser","user_id":"438542"}
Possible Error Codes:
E001, E003
89
Get Branch List
This API call is used to retrieve a branch list.
Method Request URI Test Environment URL
POST /getbranchlist https://stage.appraisalscope.com/index.php/api/resapi/getbranchlist
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Response Parameters: Name Value Details Notes
Branch ID branch_id The ID associated with the Branch
Branch Name
branch_name Name of the branch
Company Id company_id Company Id of Appraisal Scope system
Address Line 1
address1 Address line 1 of the branch
Address Line 2
address2 Address line 2 of the branch
City city City the branch is in
State state State the branch is in
Zip zip Zip the branch is in
Contact Name
contact_name Branch contact name
Email email Branch email address
Phone phone Branch phone number
Fax fax Branch fax number
Is Active is_active Is the branch active?
Is Default is_default Is the Branch the default?
Is Delete is_delete Has the branch been deleted?
Example Response Data:
{["branch_id:123,"branch_name":"Default branch","company_id":234,"address1":"12,
address1","address2":"","city":"New
York","state":"NY","zip":"90001","contact_name":null,"email":null,"phone":null,"phone_ext":null,
"fax":null,"is_active":"1","is_default":"1","is_delete":"0"]}
90
Possible Error Codes:
E001, E003
91
Create Branch
This API call is used to create a branch.
Method Request URI Test Environment URL
POST /createbranch https://stage.appraisalscope.com/index.php/api/resapi/createbranch
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Branch Name
branch_name Yes Name of the branch
Branch Address Line 1
branch_address1 No Address line 1 of the branch
Branch Address Line 2
branch_address2 No Address line 2 of the branch
Branch City branch_city No City the branch is in
Branch State
branch_state No State the branch is in
Branch Zip branch_zip No Zip the branch is in
Branch Contact Name
branch_contact_name No Branch contact name
Branch Email
branch_email No Branch email address
Estimated Number of Monthly Orders
estimate_amount_of_orders_a_month No Estimate the branch’s monthly orders
Branch Phone
branch_phone No Branch phone number
Branch Phone Ext
branch_phone_ext No Branch phone number extension
Branch Fax branch_fax No Branch fax number
Branch ID branch_id No Branch id for the new branch
Internal Branch ID
internal_branch_id No Internal branch id for the new branch
Response Parameters: Name Value Details Notes
Success success For the API call status success = true [Everything went well.] success = false [Something went wrong.] Return a failure error code and error msg.
92
Branch ID branch_id The ID associated with the Branch
Branch Name
branch_name Name of the branch
Result result Success message if user is created
Example Response Data:
{
"branch_id": 702387,
"branch_name": "BranchTest",
"success": true,
"result": "Branch created successfully." }
Possible Error Codes:
E001, E003
93
Update Branch
This API call is used to update a branch.
Method Request URI Test Environment URL
POST /editbranch https://stage.appraisalscope.com/index.php/api/resapi/editbranch
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Branch Name
branch_name Yes Name of the branch
Branch Address Line 1
branch_address1 No Address line 1 of the branch
Branch Address Line 2
branch_address2 No Address line 2 of the branch
Branch City branch_city No City the branch is in
Branch State
branch_state No State the branch is in
Branch Zip branch_zip No Zip the branch is in
Branch Contact Name
branch_contact_name No Branch contact name
Branch Email
branch_email No Branch email address
Estimated Number of Monthly Orders
estimate_amount_of_orders_a_month No Estimate the branch’s monthly orders
Branch Phone
branch_phone No Branch phone number
Branch Phone Ext
branch_phone_ext No Branch phone number extension
Branch Fax branch_fax No Branch fax number
Branch ID branch_id No Branch id for the new branch
Internal Branch ID
internal_branch_id No Internal branch id for the new branch
Response Parameters: Name Value Details Notes
Success success For the API call status success = true [Everything went well.] success = false [Something went wrong.] Return a failure error code and error msg.
94
Branch ID branch_id The ID associated with the Branch
Branch Name
branch_name Name of the branch
Result result Success message if user is created
Example Response Data:
{
"branch_id": 702387,
"branch_name": "BranchTest",
"success": true,
"result": "Branch created successfully." }
Possible Error Codes:
E001, E003
95
Get Appraiser Fee by Location
This API call is used to get the appraiser fee by location.
Method Request URI Test Environment URL
POST /getappraiserfeesbylocation https://stage.appraisalscope.com/index.php/api/resapi/getappraiserfeesbylocation
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
State state Yes Pass State to fetch fee data
Zip zip Yes Pass Zip to fetch fee data
Response Parameters: Name Value Details Notes
Success success For the API call status success = true [Everything went well.] success = false [Something went wrong.] Return a failure error code and error msg.
Result result
• fee
• job_type
• user
• user_type
Result variable will consist of the appraiser fee, job_type, user, and user_type.
Example Response Data:
{"success":true,"result":[{"fee":"525.00","job_type":"(1004)
Update\/Final","user":"LRES","user_type":"AMC"},{"fee":"525.00","job_type":"(1004) URAR + 1004MC with
Income Statement(FHA)","user":"LRES","user_type":"AMC"} ]}
Possible Error Codes:
E001, E002, E003
96
Get Job Types by Loan Type
This API call is used to get the list of job types by loan type for a given client.
Method Request URI Test Environment URL
POST /get_jobtypes_by_loantype https://stage.appraisalscope.com/index.php/api/resapi/get_jobtypes_by_loantype
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Loan Type loan_type_id Yes Pass ID of loan type
Client client_id Yes Pass ID of client company
Response Parameters: Name Value Details Notes
Success success For the API call status success = true [Everything went well.] success = false [Something went wrong.] Return a failure error code and error msg.
Result result
• id
• name
• id: Job Type
• id name: Name of Job Type
Example Response Data:
{"success":true,"result":[{"id":"8","name":"(1004) URAR + 1004MC with Income Statement(FHA)"}]}
Possible Error Codes:
E001, E002, E003, E010, E023, E026
97
Get Loan Type
This API call is used to get Loan Types from the sub-platform.
Method Request URI Test Environment URL
POST /getloantype https://stage.appraisalscope.com/index.php/api/resapi/getloantype
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Response Parameters: Name Value Details Notes
Success success For the API call status success = true [Everything went well.] success = false [Something went wrong.] Return a failure error code and error msg.
Result result
• id
• name
• id: Loan Type
• id name: Name of Loan Type
Example Response Data:
{"success":true,"result":[{"id":"4","name":"New Construction"},
{"id":"5","name":"Foreclosure\/REO"},{"id":"6","name":"Reverse Mortgage"},
{"id":"34","name":"FHA"},{"id":"35","name":"203k"},{"id":"83","name":"Conventional"}]}
Possible Error Codes:
E001, E003
98
Get Intended Use
This API call is used to get Intended Use for the authenticated client.
Method Request URI Test Environment URL
POST /getintendeduse https://stage.appraisalscope.com/index.php/api/resapi/getintendeduse
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Job Type job_type Yes Validate job type and get commercial or not
Response Parameters: Name Value Details Notes
Success success For the API call status success = true [Everything went well.] success = false [Something went wrong.] Return a failure error code and error msg.
Result result
• id
• name
• id: Intended Use
• name: Name of Intended Use associated with the id
Example Response Data:
{"success":true,"result":[{"id":"1","name":"Refinance"},{"id":"2","name":"Purchase"}, {"id":"3","name":"Ascertain
Market Value"},{"id":"31","name":"Other"}, {"id":"34","name":"Other"}]}
Possible Error Codes:
E001, E002, E003
99
Get Investor
This API call retrieves all investors ordered by name of investor.
Method Request URI Test Environment URL
POST /getinvestorlist https://stage.appraisalscope.com/index.php/api/resapi/getinvestorlist
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Response Parameters: Name Value Details Notes
Success success For the API call status success = true [Everything went well.] success = false [Something went wrong.] Return a failure error code and error msg.
Result result
• user_id
• first_name
• last_name
• user_company_name
• contact_name
• user_email
Result variable contains list of investors with their details.
Example Response Data:
{"success":true,"result":
[{"user_id":"506862","first_name":"Test","last_name":"Investor","user_company_name":"Test
Investor","contact_name":"Test Investor","user_email":"[email protected]"}]}
Possible Error Codes:
E001, E003
100
Get Users
This API call retrieves all users available for the authenticated clients.
Method Request URI Test Environment URL
POST /getUsers https://stage.appraisalscope.com/index.php/api/resapi/getusers
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Response Parameters: Name Value Details Notes
Success success For the API call status success = true [Everything went well.] success = false [Something went wrong.] Return a failure error code and error msg.
Result result
• id
• name
• user_type
• internal_id
Result variable contains list of investors with their details.
Example Response Data:
{ "success": true, "result": [ { "id": "512546", "name": "5536-1 5536-1", "user_type": "Processor", "internal_id": "123" }, { "id": "512537", "name": "Jason May", "user_type": "Manager", "internal_id": "456" } ] }
Possible Error Codes:
E003
101
Get AMC Preference
This API call retrieves the AMC preferences for an authenticated client.
Method Request URI Test Environment URL
POST /getamcpreference https://stage.appraisalscope.com/index.php/api/resapi/getamcpreference
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Response Parameters: Name Value Details Notes
Success success For the API call status success = true [Everything went well.] success = false [Something went wrong.] Return a failure error code and error msg.
Result result
• id
• name
Result variable contains a list of amc’s with their user id and names.
Example Response Data:
{"success":true,"result":{"available":[{"user_id":"331","name":"Carl Adams"},
{"user_id":"4381880","name":"DataQuick Lending Solutions, Inc. 1"}, {"user_id":"4383352","name":"Accurity
"},{"user_id":"4390266","name":"LRES "}, {"user_id":"4391909","name":"VC Management, LLC (Demonstration
Site) "}, {"user_id":"4393157","name":"LCI Appraisal Management "}, {"user_id":"4393179","name":"Appraisal
Scope Test Developer AMC "}, {"user_id":"4393208","name":"Appraisal Hub "},{"user_id":"4393261","name":"Lion
AMC "}, {"user_id":"4393276","name":"Adam VP AMC "},{"user_id":"4393354","name":"Appraisal Scope Stage -
Test AMC "}],"excluded":[{"user_id":"4376781","name":"Test AMC ab"}, {"user_id":"4393192","name":"Demo
"}],"preferred":[]}}
Possible Error Codes:
E003
102
Get Property Type
This API call retrieves the property type for an authenticated client.
Method Request URI Test Environment URL
POST /getamcpreference https://stage.appraisalscope.com/index.php/api/resapi/getamcpreference
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Response Parameters: Name Value Details Notes
Success success For the API call status success = true [Everything went well.] success = false [Something went wrong.] Return a failure error code and error msg.
Result result
• id
• name
• property_type : Name of the Property Type
• is_default : indicates if the Property Type is default or not
Example Response Data:
{"success":true,"result":{"available":[{"user_id":"331","name":"Carl Adams"},
{"user_id":"4381880","name":"DataQuick Lending Solutions, Inc. 1"}, {"user_id":"4383352","name":"Accurity
"},{"user_id":"4390266","name":"LRES "}, {"user_id":"4391909","name":"VC Management, LLC (Demonstration
Site) "}, {"user_id":"4393157","name":"LCI Appraisal Management "}, {"user_id":"4393179","name":"Appraisal
Scope Test Developer AMC "}, {"user_id":"4393208","name":"Appraisal Hub "},{"user_id":"4393261","name":"Lion
AMC "}, {"user_id":"4393276","name":"Adam VP AMC "},{"user_id":"4393354","name":"Appraisal Scope Stage -
Test AMC "}],"excluded":[{"user_id":"4376781","name":"Test AMC ab"}, {"user_id":"4393192","name":"Demo
"}],"preferred":[]}}
Possible Error Codes:
E001, E003
103
Get Additional Document Type
This API call can be used to get additional document types from the sub-platform.
Method Request URI Test Environment URL
POST /get_additional_document_types https://stage.appraisalscope.com/index.php/api/resapi/get_additional_document_types
Request Parameters: Name Field Name Required Details
API Key api_key Yes Use the API Key received from the dologin response
Response Parameters: Name Value Details Notes
Success success For the API call status success = true [Everything went well.] success = false [Something went wrong.] Return a failure error code and error msg.
Result result
• id
• name
• property_type : Name of the Property Type
• is_default : indicates if the Property Type is default or not
Example Response Data:
{"success":true,"result":{"available":[{"user_id":"331","name":"Carl Adams"},
{"user_id":"4381880","name":"DataQuick Lending Solutions, Inc. 1"}, {"user_id":"4383352","name":"Accurity
"},{"user_id":"4390266","name":"LRES "}, {"user_id":"4391909","name":"VC Management, LLC (Demonstration
Site) "}, {"user_id":"4393157","name":"LCI Appraisal Management "}, {"user_id":"4393179","name":"Appraisal
Scope Test Developer AMC "}, {"user_id":"4393208","name":"Appraisal Hub "},{"user_id":"4393261","name":"Lion
AMC "}, {"user_id":"4393276","name":"Adam VP AMC "},{"user_id":"4393354","name":"Appraisal Scope Stage -
Test AMC "}],"excluded":[{"user_id":"4376781","name":"Test AMC ab"}, {"user_id":"4393192","name":"Demo
"}],"preferred":[]}}
Possible Error Codes:
E001, E003
104
Update User Password
This API call can be used to update the user’s password.
Method Request URI Test Environment URL
POST /updatePassword https://stage.appraisalscope.com/index.php/api/resapi/updatePassword
Request Parameters: Name Field Name Required Details
Username username Yes Username for update password
Old Password
old password Yes Old password for update password
New Password
new password Yes New password for update password
Response Parameters: Name Value Details Notes
Success success For the API call status success = true [Everything went well.] success = false [Something went wrong.] Return a failure error code and error msg.
Result Result Success or failure message
Example Response Data:
{"success":true,"result":"Password updated successfully"}
Possible Error Codes:
E001, E002, E006, E031, E032
105
PHP Code Sample:
Calling Restful API via CURL:
$data = array("username" => "XX", "password" => "XX"); $data_string = json_encode($data); $ch = curl_init('https://stage.appraisalscope.com/index.php/api/resapi/dologin'); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2); //Attached the path to .CRT file curl_setopt($ch, CURLOPT_CAINFO, getcwd() ."/AddTrustExternalCARoot.crt"); curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'Content¬Length: ' . strlen($data_string)) ); $result = curl_exec($ch); echo $result;