ValuePad API Documentation

All the endpoints are available on https://stage.valuepad.com/api/v2.0

Authentication

Not all endpoints are publicly available. In order to access private endpoints you will need a token. Tokens are unique for a user and has to be included in the header of a request like this: 

Token: S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM
Normally, tokens are removed from the system once they are expired. Therefore, you will have to refresh the token before it gets expired. The token as well as the expiration date can be found in Session Object.

Session Object can be created via this endpoint. You will have to provide user's credentials in order to be able to create it. You will also have to keep an eye on the expiration date and refresh the session (aka token) via this endpoint before it gets expired.

Include

Due to the fact that some objects such as Order Object, Appraiser Object and etc. are too large the server provides them partially. In order to retrieve needed missing fields, you have to specify them in the header of the request, so that the server knows what fields to provide along with the default ones in the response.

For example, say you want to login as an appraiser, and you use the POST /sessions endpoint to create Session Object. The object has the "user" field which is supposed to contain Appraiser Object. However, due to the statement above, the server will provide just few fields describing the user such as "id", "username", "firstName", "lastName" and etc. In order to tell the server to give additional fields such as "qualifications" , "address1" , "city", "state", "zip" and etc. you have to specify them in the header like this: 

Include: user.qualifications,user.address1,user.city,user.state,user.city,user.zip
Note: All the fields which are not included by default are marked with "*" in the documentation.

Sorting

Some endpoints support sorting of resources by certain fields. By what fields the resources can be sorted will be specified in places where endpoints are actually described. However, the way the sorting direction is set is common for all endpoints. Therefore, if you need to set the sorting direction it's enough to append to the field the following ":asc" or ":desc". This will tell the server to sort the resources in either "ASC" or "DESC" direction respectively.

For example: 

/appraisers/824/customers?orderBy=name:desc
this will tell the server to sort the customer resources by name in "DESC" direction.

You can also sort the resources by multiple fields. In order to achieve that you have to specify the fields in the query like this: 

/appraisers/824/orders?orderBy=orderedAt:desc,fileNumber:asc
this will tell the server to sort the order resources by order date in "DESC" direction, and by the file number in "ASC" direction.

Uploading Documents

Uploading documents to the ValuePad system is a two step process. The process is as follows:

  1. When uploading a document to our system, we use 
    multipart/form-data
    for our file uploads. So if you were to put this in HTML it would look like this 
    <input type="file" name="document" />
    . This is a standard document uploading method and does not require `Base64` encoding. If you would like to see an example using postman, please click here.

  2. Once you have completed uploading the document from step one, you will now need to attach that document to the order. These endpoints will require the "ID" as well as the "Token" from the file you uploaded in step one. Below are the endpoints that you can use to attach the corresponding documents:

    • To attach an Appraisal Report to an order you will need to use the following endpoint here.
    • To attach any Additional Documents (such as Sales contract), you will need to use the following endpoint here.

Webhooks

Webhooks allow you to listen to events triggered on ValuePad. When one of those events is triggered, we will send you a POST request with details about the event. The URL where the request will be sent is taken from the "pushUrl" field in the settings. Therefore, in order to receive notifications from ValuePad you will have to provide the URL by patching the settings via this endpoint.

Authorization

You can authorize requests coming from ValuePad by comparing the secret tokens included in the header of the request with the secret tokens assigned to you at the moment of registration. You can find your secret tokens in Amc Object. As for the secret tokens submitted by ValuePad, you should refer to the `X-Customer-Secret1` and `X-Customer-Secret2` fields in the header of the request.

Events

order:award When an order is awarded by a customer

Properties:

Name Type Reference/Value
type string order
event string award
order int N/A

Example:

{
    "type": "order",
    "event": "award",
    "order": 241
}

order:bid-request When a bid request is received

Properties:

Name Type Reference/Value
type string order
event string bid-request
order int N/A

Example:

{
    "type": "order",
    "event": "bid-request",
    "order": 241
}

order:change-additional-status When a customer changes an additional status

Properties:

Name Type Reference/Value
type string order
event string change-additional-status
order int N/A
oldAdditionalStatus int N/A
oldAdditionalStatusComment string N/A
newAdditionalStatus int N/A
newAdditionalStatusComment string N/A

Example:

{
    "type": "order",
    "event": "change-additional-status",
    "order": 422,
    "oldAdditionalStatus": 98,
    "oldAdditionalStatusComment": "Old Status",
    "newAdditionalStatus": 72,
    "newAdditionalStatusComment": "New Status"
}

order:create-additional-document When a customer attaches a new additional document to an order

Properties:

Name Type Reference/Value
type string order
event string create-additional-document
order int N/A
additionalDocument int N/A

Example:

{
    "type": "order",
    "event": "create-additional-document",
    "order": 82,
    "additionalDocument": 24
}

order:create-document When a customer attaches a new document to an order

Properties:

Name Type Reference/Value
type string order
event string create-document
order int N/A
document int N/A

Example:

{
    "type": "order",
    "event": "create-document",
    "order": 241,
    "document": 219
}

order:create-log When a new log is created due to actions taken in the scope of an order

Properties:

Name Type Reference/Value
type string order
event string create-log
order int N/A
log int N/A

Example:

{
    "type": "order",
    "event": "create-log",
    "order": 82,
    "log": 24
}

order:create When a customer assigns an order

Properties:

Name Type Reference/Value
type string order
event string create
order int N/A

Example:

{
    "type": "order",
    "event": "create",
    "order": 82
}

order:delete-additional-document When a customer removes an additional document from an order

Properties:

Name Type Reference/Value
type string order
event string delete-additional-document
order int N/A
additionalDocument int N/A

Example:

{
    "type": "order",
    "event": "delete-additional-document",
    "order": 82,
    "additionalDocument": 24
}

order:delete-document When a customer removes a document from an order

Properties:

Name Type Reference/Value
type string order
event string delete-document
order int N/A
document int N/A

Example:

{
    "type": "order",
    "event": "delete-document",
    "order": 82,
    "document": 24
}

order:delete When a customer removes/cancels an order

Properties:

Name Type Reference/Value
type string order
event string delete
order int N/A

Example:

{
    "type": "order",
    "event": "delete",
    "order": 82
}

order:reconsideration-request When a customer sends a reconsideration request

Properties:

Name Type Reference/Value
type string order
event string reconsideration-request
order int N/A
reconsideration int N/A

Example:

{
    "type": "order",
    "event": "reconsideration-request",
    "order": 82,
    "reconsideration": 552
}

order:revision-request When a customer sends a revision request

Properties:

Name Type Reference/Value
type string order
event string revision-request
order int N/A
revision int N/A

Example:

{
    "type": "order",
    "event": "revision-request",
    "order": 82,
    "revision": 552
}

order:send-message When a customer sends a message

Properties:

Name Type Reference/Value
type string order
event string send-message
order int N/A
message int N/A

Example:

{
    "type": "order",
    "event": "send-message",
    "order": 82,
    "message": 552
}

order:update-document When a customer uploads/removes secondary documents in an order

Properties:

Name Type Reference/Value
type string order
event string update-document
order int N/A
document int N/A

Example:

{
    "type": "order",
    "event": "update-document",
    "order": 241,
    "document": 219
}

order:update When a customer updates order details

Properties:

Name Type Reference/Value
type string order
event string update
order int N/A

Example:

{
    "type": "order",
    "event": "update",
    "order": 82
}

order:update-process-status When a customer puts an order into a different process status

Properties:

Name Type Reference/Value
type string order
event string update-process-status
order int N/A
oldProcessStatus enum Process Status Enum
newProcessStatus enum Process Status Enum
estimatedCompletionDate
(when "newProcessStatus" is either "inspection-completed" or "inspection-scheduled") 		datetime N/A
completedAt
(when "newProcessStatus" is "inspection-completed") 		datetime N/A
scheduledAt
(when "newProcessStatus" is "inspection-scheduled") 		datetime N/A

Example:

{
    "type": "order",
    "event": "update-process-status",
    "order": 241,
    "oldProcessStatus": "new",
    "newProcessStatus": "accepted",
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "completedAt": "2016-04-21T07:51:59+00:00",
    "scheduledAt": "2016-04-21T07:51:59+00:00"
}

order:update-payment-info When a customer updates the payment method on an order

Properties:

Name Type Reference/Value
type string order
event string update-payment-info
order int 12

Example:

{
    "type": "order",
    "event": "update-payment-info",
    "order": 12
}

order:charge When auto-billing is enabled and a card was charged

Properties:

Name Type Reference/Value
type string order
event string charge
order int 12
transactionId
(When the charge is successful) 		string 123123
code
(When the charge fails) 		string E002
message
(When the charge fails) 		string Error message

Example:

{
    "type": "order",
    "event": "charge",
    "order": 12,
    "transactionId": "123123",
    "code": "E002",
    "message": "Error message"
}

HTTP Endpoints

PATCH /amcs/{amcId} Updates an AMC

Request

Name Type Reference
body object AMC Persistable

Example:

{
    "username": "johnhancock",
    "password": "12345",
    "status": "approved",
    "companyName": "ABC Company",
    "email": "john.hancock@gmail.com",
    "address1": "1234 Some Street",
    "address2": "Suite 200",
    "city": "Baltimore",
    "state": "MD",
    "zip": "21209",
    "phone": "(410)123-4567",
    "fax": "(410)123-4567",
    "lenders": "ABC Lender"
}

Response

Code: 204

GET /amcs/{amcId}/customers Gets all related customers

Request

Parameters

Name Type Reference
orderBy enum name

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Customer Object

Example:

{
    "data": [
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "name": "ABC Company",
            "companyType": "bank-lender"
        }
    ]
}

GET /amcs/{amcId}/customers/{customerId}/additional-documents/types Gets all type of additional documents

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Order Additional Document Type Object

Example:

{
    "data": [
        {
            "id": 131,
            "title": "Invoice"
        }
    ]
}

GET /amcs/{amcId}/customers/{customerId}/additional-statuses Gets additional statuses defined by a customer

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Additional Status Object

Example:

{
    "data": [
        {
            "id": 131,
            "title": "Waiting for client",
            "comment": "Some text"
        }
    ]
}

DELETE /amcs/{amcId}/customers/{customerId}/fees Deletes fees

Request

Parameters

Name Type Reference
ids int[] N/A

Response

Code: 204

GET /amcs/{amcId}/customers/{customerId}/fees Gets all fees

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Customer Job Type Fee Object

Example:

{
    "data": [
        {
            "id": 49,
            "jobType": {
                "id": 131,
                "title": "URAR(303)",
                "isCommercial": false,
                "local": {
                    "id": 131,
                    "title": "URAR(303)"
                },
                "isPayable": true
            },
            "amount": 49.99
        }
    ]
}

POST /amcs/{amcId}/customers/{customerId}/fees Creates a fee

Request

Name Type Reference
body mixed N/A
object Customer Job Type Fee Persistable
- OR -
object N/A
- bulk object[] Customer Job Type Fee Persistable

Example:

[
    "** --------------- Example #1 --------------- **",
    {
        "jobType": 49,
        "amount": 49.99
    },
    "** --------------- Example #2 --------------- **",
    {
        "bulk": [
            {
                "jobType": 49,
                "amount": 49.99
            }
        ]
    }
]

Response

Code: 200

Name Type Reference
body mixed N/A
object Customer Job Type Fee Object
- OR -
object N/A
- data object[] Customer Job Type Fee Object

Example:

[
    "** --------------- Example #1 --------------- **",
    {
        "id": 49,
        "jobType": {
            "id": 131,
            "title": "URAR(303)",
            "isCommercial": false,
            "local": {
                "id": 131,
                "title": "URAR(303)"
            },
            "isPayable": true
        },
        "amount": 49.99
    },
    "** --------------- Example #2 --------------- **",
    {
        "data": [
            {
                "id": 49,
                "jobType": {
                    "id": 131,
                    "title": "URAR(303)",
                    "isCommercial": false,
                    "local": {
                        "id": 131,
                        "title": "URAR(303)"
                    },
                    "isPayable": true
                },
                "amount": 49.99
            }
        ]
    }
]

PATCH /amcs/{amcId}/customers/{customerId}/fees Updates fees

Request

Name Type Reference
body object N/A
- bulk object[] N/A
- - id int N/A
- - amount float N/A

Example:

{
    "bulk": [
        {
            "id": 512,
            "amount": 124.99
        }
    ]
}

Response

Code: 204

PUT /amcs/{amcId}/customers/{customerId}/fees/apply-default-location-fees Applies the default location fees for the specified customer

Response

Code: 204

PATCH /amcs/{amcId}/customers/{customerId}/fees/{feeId} Updates a fee

Request

Name Type Reference
body object Customer Job Type Fee Persistable

Example:

{
    "jobType": 49,
    "amount": 49.99
}

Response

Code: 204

GET /amcs/{amcId}/customers/{customerId}/fees/{jobTypeId}/states Gets all fees by state

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By State Object

Example:

{
    "data": [
        {
            "state": {
                "code": "CA",
                "name": "California"
            },
            "amount": 49.99
        }
    ]
}

PUT /amcs/{amcId}/customers/{customerId}/fees/{jobTypeId}/states Saves fees by state

Request

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By State Persistable

Example:

{
    "data": [
        {
            "state": "MD",
            "amount": 49.99,
            "applyStateAmountToAllCounties": false,
            "applyStateAmountToAllZips": true
        }
    ]
}

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By State Object

Example:

{
    "data": [
        {
            "state": {
                "code": "CA",
                "name": "California"
            },
            "amount": 49.99
        }
    ]
}

PATCH /amcs/{amcId}/customers/{customerId}/fees/{jobTypeId}/states/{stateCode} Updates a specific fee by state

Request

Name Type Reference
body object AMC Job Type Fee By State Persistable

Example:

{
    "state": "MD",
    "amount": 49.99,
    "applyStateAmountToAllCounties": false,
    "applyStateAmountToAllZips": true
}

Response

Code: 204

GET /amcs/{amcId}/customers/{customerId}/fees/{jobTypeId}/states/{stateCode}/counties Gets all fees by county

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By County Object

Example:

{
    "data": [
        {
            "county": {
                "id": 42,
                "title": "BRISTOL BAY"
            },
            "amount": 49.99
        }
    ]
}

PUT /amcs/{amcId}/customers/{customerId}/fees/{jobTypeId}/states/{stateCode}/counties Saves fees by county

Request

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By County Persistable

Example:

{
    "data": [
        {
            "county": 49,
            "amount": 49.99
        }
    ]
}

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By County Object

Example:

{
    "data": [
        {
            "county": {
                "id": 42,
                "title": "BRISTOL BAY"
            },
            "amount": 49.99
        }
    ]
}

PUT /amcs/{amcId}/customers/{customerId}/fees/{jobTypeId}/states/{stateCode}/zips Saves fees by zip

Request

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By Zip Persistable

Example:

{
    "data": [
        {
            "zip": "21209",
            "amount": 49.99
        }
    ]
}

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By Zip Object

Example:

{
    "data": [
        {
            "zip": "21209",
            "amount": 49.99
        }
    ]
}

GET /amcs/{amcId}/customers/{customerId}/fees/{jobTypeId}/states/{stateCode}/zips Gets all fees by zip

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By Zip Object

Example:

{
    "data": [
        {
            "zip": "21209",
            "amount": 49.99
        }
    ]
}

GET /amcs/{amcId}/customers/{customerId}/job-types Gets all job types of a specific customer

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Customer Job Type Object

Example:

{
    "data": [
        {
            "id": 131,
            "title": "URAR(303)",
            "isCommercial": false,
            "local": {
                "id": 131,
                "title": "URAR(303)"
            },
            "isPayable": true
        }
    ]
}

PATCH /amcs/{amcId}/customers/{customerId}/job-types/{jobTypeId} Updates a job type of a specific customer

Request

Name Type Reference
body object Customer Job Type Persistable

Example:

{
    "title": "1004R",
    "isCommercial": true,
    "local": 49,
    "isPayable": false
}

Response

Code: 204

GET /amcs/{amcId}/fees Gets all fees

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee Object

Example:

{
    "data": [
        {
            "jobType": {
                "id": 131,
                "title": "URAR(303)"
            },
            "qualifier": "state",
            "amount": 49.99
        }
    ]
}

PUT /amcs/{amcId}/fees Saves fees

Request

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee Persistable

Example:

{
    "data": [
        {
            "jobType": 21,
            "qualifier": "state",
            "amount": 49.99
        }
    ]
}

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee Object

Example:

{
    "data": [
        {
            "jobType": {
                "id": 131,
                "title": "URAR(303)"
            },
            "qualifier": "state",
            "amount": 49.99
        }
    ]
}

GET /amcs/{amcId}/fees/totals Gets number of job types with fees set per customer + default

Response

Code: 200

Name Type Reference
body object N/A
- data object[] N/A
- - customer
(the value is NULL when fees are default) 		object Customer Object
- - enabled int N/A

Example:

{
    "data": [
        {
            "customer": {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "name": "ABC Company",
                "companyType": "bank-lender"
            },
            "enabled": 24
        }
    ]
}

GET /amcs/{amcId}/fees/{jobTypeId}/states Gets all fees by state

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By State Object

Example:

{
    "data": [
        {
            "state": {
                "code": "CA",
                "name": "California"
            },
            "amount": 49.99
        }
    ]
}

PUT /amcs/{amcId}/fees/{jobTypeId}/states Saves fees by state

Request

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By State Persistable

Example:

{
    "data": [
        {
            "state": "MD",
            "amount": 49.99,
            "applyStateAmountToAllCounties": false,
            "applyStateAmountToAllZips": true
        }
    ]
}

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By State Object

Example:

{
    "data": [
        {
            "state": {
                "code": "CA",
                "name": "California"
            },
            "amount": 49.99
        }
    ]
}

PATCH /amcs/{amcId}/fees/{jobTypeId}/states/{stateCode} Updates a specific fee by state

Request

Name Type Reference
body object AMC Job Type Fee By State Persistable

Example:

{
    "state": "MD",
    "amount": 49.99,
    "applyStateAmountToAllCounties": false,
    "applyStateAmountToAllZips": true
}

Response

Code: 204

GET /amcs/{amcId}/fees/{jobTypeId}/states/{stateCode}/counties Gets all fees by county

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By County Object

Example:

{
    "data": [
        {
            "county": {
                "id": 42,
                "title": "BRISTOL BAY"
            },
            "amount": 49.99
        }
    ]
}

PUT /amcs/{amcId}/fees/{jobTypeId}/states/{stateCode}/counties Saves fees by county

Request

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By County Persistable

Example:

{
    "data": [
        {
            "county": 49,
            "amount": 49.99
        }
    ]
}

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By County Object

Example:

{
    "data": [
        {
            "county": {
                "id": 42,
                "title": "BRISTOL BAY"
            },
            "amount": 49.99
        }
    ]
}

GET /amcs/{amcId}/fees/{jobTypeId}/states/{stateCode}/zips Gets all fees by zip

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By Zip Object

Example:

{
    "data": [
        {
            "zip": "21209",
            "amount": 49.99
        }
    ]
}

PUT /amcs/{amcId}/fees/{jobTypeId}/states/{stateCode}/zips Saves fees by zip

Request

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By Zip Persistable

Example:

{
    "data": [
        {
            "zip": "21209",
            "amount": 49.99
        }
    ]
}

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Job Type Fee By Zip Object

Example:

{
    "data": [
        {
            "zip": "21209",
            "amount": 49.99
        }
    ]
}

GET /amcs/{amcId}/invoices Gets all invoices

Request

Parameters

Name Type Reference
filter.isPaid bool N/A
orderBy enum createdAt, from, to, isPaid, amount
page int N/A
perPage int N/A

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC Invoice Object
- meta object N/A
- - pagination object Pagination Object

Example:

{
    "data": [
        {
            "id": 49,
            "isPaid": true,
            "items": [
                {
                    "id": 49,
                    "fileNumber": "1234",
                    "loanNumber": "4567",
                    "address": "1234 Some Street",
                    "jobType": "1004 URAR",
                    "borrowerName": "John Hancock",
                    "amount": "49.99",
                    "orderedAt": "2016-04-20T07:51:59+00:00",
                    "completedAt": "2016-04-21T07:51:59+00:00"
                }
            ],
            "document": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "amount": 49.99,
            "from": "2016-04-21T07:51:59+00:00",
            "to": "2016-04-22T07:51:59+00:00",
            "createdAt": "2016-04-20T07:51:59+00:00"
        }
    ],
    "meta": {
        "pagination": {
            "total": 1000,
            "perPage": 10,
            "page": 31,
            "totalPages": 100
        }
    }
}

POST /amcs/{amcId}/invoices/{invoiceId}/pay Pays an invoice

Request

Name Type Reference
body object N/A
- means enum Payment Means Enum

Example:

{
    "means": "credit-card"
}

Response

Code: 204

GET /amcs/{amcId}/licenses Gets all licenses

Response

Code: 200

Name Type Reference
body object N/A
- data object[] AMC License Object

Example:

{
    "data": [
        {
            "id": 49,
            "number": "23423432",
            "expiresAt": "2016-04-21T07:51:59+00:00",
            "document": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "state": {
                "code": "CA",
                "name": "California"
            },
            "coverage": [
                {
                    "county": {
                        "id": 42,
                        "title": "BRISTOL BAY"
                    },
                    "zips": [
                        "94132",
                        "94108"
                    ]
                }
            ],
            "alias": {
                "companyName": "DEF Company",
                "address1": "5678 X Avenue",
                "address2": "Y Building",
                "city": "Los Angeles",
                "state": {
                    "code": "CA",
                    "name": "California"
                },
                "zip": "90210",
                "phone": "(888)807-2111",
                "fax": "(888)807-2112",
                "email": "def@company.biz"
            }
        }
    ]
}

POST /amcs/{amcId}/licenses Creates a new license

Request

Name Type Reference
body object AMC License Persistable

Example:

{
    "number": "24323235",
    "state": "MD",
    "expiresAt": "2016-04-21T07:51:59+00:00",
    "document": [
        "** --------------- Example #1 --------------- **",
        21,
        "** --------------- Example #2 --------------- **",
        {
            "id": 10,
            "token": "58IKsPHGJNDwUnOOjHJtPT6ZlSv14hwkPEhAKbGMhiZ1tcZuPSlqnhh4Z88LWKgl"
        }
    ],
    "coverage": [
        {
            "county": 49,
            "zips": [
                "21209",
                "21804"
            ]
        }
    ],
    "alias": {
        "companyName": "DEF Company",
        "address1": "5678 X Avenue",
        "address2": "Y Building",
        "city": "Los Angeles",
        "state": "CA",
        "zip": "90210",
        "phone": "(888)807-2111",
        "fax": "(888)807-2112",
        "email": "def@company.biz"
    }
}

Response

Code: 200

Name Type Reference
body object AMC License Object

Example:

{
    "id": 49,
    "number": "23423432",
    "expiresAt": "2016-04-21T07:51:59+00:00",
    "document": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "state": {
        "code": "CA",
        "name": "California"
    },
    "coverage": [
        {
            "county": {
                "id": 42,
                "title": "BRISTOL BAY"
            },
            "zips": [
                "94132",
                "94108"
            ]
        }
    ],
    "alias": {
        "companyName": "DEF Company",
        "address1": "5678 X Avenue",
        "address2": "Y Building",
        "city": "Los Angeles",
        "state": {
            "code": "CA",
            "name": "California"
        },
        "zip": "90210",
        "phone": "(888)807-2111",
        "fax": "(888)807-2112",
        "email": "def@company.biz"
    }
}

PATCH /amcs/{amcId}/licenses/{licenseId} Updates a license

Request

Name Type Reference
body object AMC License Persistable

Example:

{
    "number": "24323235",
    "state": "MD",
    "expiresAt": "2016-04-21T07:51:59+00:00",
    "document": [
        "** --------------- Example #1 --------------- **",
        21,
        "** --------------- Example #2 --------------- **",
        {
            "id": 10,
            "token": "58IKsPHGJNDwUnOOjHJtPT6ZlSv14hwkPEhAKbGMhiZ1tcZuPSlqnhh4Z88LWKgl"
        }
    ],
    "coverage": [
        {
            "county": 49,
            "zips": [
                "21209",
                "21804"
            ]
        }
    ],
    "alias": {
        "companyName": "DEF Company",
        "address1": "5678 X Avenue",
        "address2": "Y Building",
        "city": "Los Angeles",
        "state": "CA",
        "zip": "90210",
        "phone": "(888)807-2111",
        "fax": "(888)807-2112",
        "email": "def@company.biz"
    }
}

Response

Code: 204

GET /amcs/{amcId}/licenses/{licenseId} Gets a license

Response

Code: 200

Name Type Reference
body object AMC License Object

Example:

{
    "id": 49,
    "number": "23423432",
    "expiresAt": "2016-04-21T07:51:59+00:00",
    "document": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "state": {
        "code": "CA",
        "name": "California"
    },
    "coverage": [
        {
            "county": {
                "id": 42,
                "title": "BRISTOL BAY"
            },
            "zips": [
                "94132",
                "94108"
            ]
        }
    ],
    "alias": {
        "companyName": "DEF Company",
        "address1": "5678 X Avenue",
        "address2": "Y Building",
        "city": "Los Angeles",
        "state": {
            "code": "CA",
            "name": "California"
        },
        "zip": "90210",
        "phone": "(888)807-2111",
        "fax": "(888)807-2112",
        "email": "def@company.biz"
    }
}

DELETE /amcs/{amcId}/licenses/{licenseId} Deletes a license

Response

Code: 204

GET /amcs/{amcId}/logs Gets all logs

Request

Parameters

Name Type Reference
filter.initiator bool N/A
orderBy enum createdAt
page int N/A
perPage int N/A

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Log Object
- meta object N/A
- - pagination object Pagination Object

Example:

{
    "data": [
        {
            "id": 49,
            "order": {
                "id": 5512,
                "fileNumber": "EFG41292",
                "asAppraisalId": "123456",
                "assignee": [
                    "** --------------- Example #1 --------------- **",
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "firstName": "Hancock",
                        "lastName": "Hancock",
                        "email": "john.hancock@gmail.com",
                        "type": "appraiser"
                    },
                    "** --------------- Example #2 --------------- **",
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "status": "approved",
                        "companyName": "ABC Company",
                        "email": "john.hancock@gmail.com",
                        "address1": "1234 Some Street",
                        "address2": "Suite 200",
                        "city": "Baltimore",
                        "state": {
                            "code": "CA",
                            "name": "California"
                        },
                        "zip": "21209",
                        "phone": "(410)123-4567",
                        "fax": "(410)123-4567",
                        "lenders": "ABC Lender",
                        "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                        "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                        "type": "amc"
                    }
                ],
                "company": {
                    "id": 83,
                    "name": "Best Appraisers Co.",
                    "firstName": "John",
                    "lastName": "White",
                    "email": "appraisers@company.com",
                    "phone": "(505) 242-2221",
                    "fax": "(505) 242-5522",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "zip": "94333",
                    "assignmentZip": "76901",
                    "state": {
                        "code": "CA",
                        "name": "California"
                    },
                    "w9": {
                        "id": 242,
                        "name": "test.pdf",
                        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                        "size": 14512415,
                        "format": "pdf",
                        "uploadedAt": "2016-04-21T07:51:59+00:00",
                        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                    },
                    "taxId": "00-0000000",
                    "type": "c-corporation",
                    "otherType": "Other company type",
                    "eo": {
                        "document": {
                            "id": 242,
                            "name": "test.pdf",
                            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                            "size": 14512415,
                            "format": "pdf",
                            "uploadedAt": "2016-04-21T07:51:59+00:00",
                            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                        },
                        "claimAmount": 2999.01,
                        "aggregateAmount": 2999.01,
                        "expiresAt": "2016-04-21T07:51:59+00:00",
                        "carrier": "AT&T",
                        "deductible": 442.99
                    },
                    "ach": {
                        "bankName": "ABC Bank",
                        "accountType": "checking",
                        "accountNumber": "1234567890",
                        "routing": "123456789"
                    }
                },
                "loanAmount": 33.01,
                "lienPosition": "first",
                "valueQualifiers": [
                    "as-is",
                    "subject-to-completed"
                ],
                "subAssignees": [
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "firstName": "Hancock",
                        "lastName": "Hancock",
                        "email": "john.hancock@gmail.com"
                    }
                ],
                "paymentMethod": null,
                "hasCreditCardInfo": false,
                "clientFee": 30.12,
                "orderedBy": {
                    "id": 131,
                    "firstName": "John",
                    "lastName": "Week",
                    "email": "appraiser@gmail.com",
                    "phone": "(410)123-4567",
                    "role": "processor",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": "76901",
                    "branchName": "Branching Branch"
                },
                "submittedBy": {
                    "id": 131,
                    "firstName": "John",
                    "lastName": "Week",
                    "email": "appraiser@gmail.com",
                    "phone": "(410)123-4567",
                    "role": "investor",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": "76901",
                    "branchName": "Branching Branch"
                }
            },
            "user": [
                "** --------------- Example #1 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "name": "ABC Company",
                    "companyType": "bank-lender",
                    "type": "customer"
                },
                "** --------------- Example #2 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com",
                    "type": "appraiser"
                }
            ],
            "action": "create-order",
            "actionLabel": "Created Order",
            "message": "Your customer has created an order!",
            "extra": {
                "user": "John Hancock"
            },
            "createdAt": "2016-04-21T07:51:59+00:00"
        }
    ],
    "meta": {
        "pagination": {
            "total": 1000,
            "perPage": 10,
            "page": 31,
            "totalPages": 100
        }
    }
}

GET /amcs/{amcId}/logs/{logId} Gets a single log entry

Response

Code: 200

Name Type Reference
body object Log Object

Example:

{
    "id": 49,
    "order": {
        "id": 5512,
        "fileNumber": "EFG41292",
        "asAppraisalId": "123456",
        "assignee": [
            "** --------------- Example #1 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com",
                "type": "appraiser"
            },
            "** --------------- Example #2 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "status": "approved",
                "companyName": "ABC Company",
                "email": "john.hancock@gmail.com",
                "address1": "1234 Some Street",
                "address2": "Suite 200",
                "city": "Baltimore",
                "state": {
                    "code": "CA",
                    "name": "California"
                },
                "zip": "21209",
                "phone": "(410)123-4567",
                "fax": "(410)123-4567",
                "lenders": "ABC Lender",
                "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                "type": "amc"
            }
        ],
        "company": {
            "id": 83,
            "name": "Best Appraisers Co.",
            "firstName": "John",
            "lastName": "White",
            "email": "appraisers@company.com",
            "phone": "(505) 242-2221",
            "fax": "(505) 242-5522",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "zip": "94333",
            "assignmentZip": "76901",
            "state": {
                "code": "CA",
                "name": "California"
            },
            "w9": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "taxId": "00-0000000",
            "type": "c-corporation",
            "otherType": "Other company type",
            "eo": {
                "document": {
                    "id": 242,
                    "name": "test.pdf",
                    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                    "size": 14512415,
                    "format": "pdf",
                    "uploadedAt": "2016-04-21T07:51:59+00:00",
                    "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                },
                "claimAmount": 2999.01,
                "aggregateAmount": 2999.01,
                "expiresAt": "2016-04-21T07:51:59+00:00",
                "carrier": "AT&T",
                "deductible": 442.99
            },
            "ach": {
                "bankName": "ABC Bank",
                "accountType": "checking",
                "accountNumber": "1234567890",
                "routing": "123456789"
            }
        },
        "loanAmount": 33.01,
        "lienPosition": "first",
        "valueQualifiers": [
            "as-is",
            "subject-to-completed"
        ],
        "subAssignees": [
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com"
            }
        ],
        "paymentMethod": null,
        "hasCreditCardInfo": false,
        "clientFee": 30.12,
        "orderedBy": {
            "id": 131,
            "firstName": "John",
            "lastName": "Week",
            "email": "appraiser@gmail.com",
            "phone": "(410)123-4567",
            "role": "processor",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "state": "CA",
            "zip": "76901",
            "branchName": "Branching Branch"
        },
        "submittedBy": {
            "id": 131,
            "firstName": "John",
            "lastName": "Week",
            "email": "appraiser@gmail.com",
            "phone": "(410)123-4567",
            "role": "investor",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "state": "CA",
            "zip": "76901",
            "branchName": "Branching Branch"
        }
    },
    "user": [
        "** --------------- Example #1 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "name": "ABC Company",
            "companyType": "bank-lender",
            "type": "customer"
        },
        "** --------------- Example #2 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com",
            "type": "appraiser"
        }
    ],
    "action": "create-order",
    "actionLabel": "Created Order",
    "message": "Your customer has created an order!",
    "extra": {
        "user": "John Hancock"
    },
    "createdAt": "2016-04-21T07:51:59+00:00"
}

GET /amcs/{amcId}/messages Gets all messages

Request

Parameters

Name Type Reference
filter.isRead bool N/A
orderBy enum createdAt
page int N/A
perPage int N/A

Response

Code: 200

Name Type Reference
body object N/A
- data mixed[] N/A
object Customer Message Object
- OR -
object Message Object

Example:

{
    "data": [
        {
            "id": 49,
            "isRead": false,
            "sender": [
                "** --------------- Example #1 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "name": "ABC Company",
                    "companyType": "bank-lender",
                    "type": "customer"
                },
                "** --------------- Example #2 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com",
                    "type": "appraiser"
                }
            ],
            "content": "This is a sample message.",
            "order": {
                "id": 5512,
                "fileNumber": "EFG41292",
                "asAppraisalId": "123456",
                "assignee": [
                    "** --------------- Example #1 --------------- **",
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "firstName": "Hancock",
                        "lastName": "Hancock",
                        "email": "john.hancock@gmail.com",
                        "type": "appraiser"
                    },
                    "** --------------- Example #2 --------------- **",
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "status": "approved",
                        "companyName": "ABC Company",
                        "email": "john.hancock@gmail.com",
                        "address1": "1234 Some Street",
                        "address2": "Suite 200",
                        "city": "Baltimore",
                        "state": {
                            "code": "CA",
                            "name": "California"
                        },
                        "zip": "21209",
                        "phone": "(410)123-4567",
                        "fax": "(410)123-4567",
                        "lenders": "ABC Lender",
                        "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                        "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                        "type": "amc"
                    }
                ],
                "company": {
                    "id": 83,
                    "name": "Best Appraisers Co.",
                    "firstName": "John",
                    "lastName": "White",
                    "email": "appraisers@company.com",
                    "phone": "(505) 242-2221",
                    "fax": "(505) 242-5522",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "zip": "94333",
                    "assignmentZip": "76901",
                    "state": {
                        "code": "CA",
                        "name": "California"
                    },
                    "w9": {
                        "id": 242,
                        "name": "test.pdf",
                        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                        "size": 14512415,
                        "format": "pdf",
                        "uploadedAt": "2016-04-21T07:51:59+00:00",
                        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                    },
                    "taxId": "00-0000000",
                    "type": "c-corporation",
                    "otherType": "Other company type",
                    "eo": {
                        "document": {
                            "id": 242,
                            "name": "test.pdf",
                            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                            "size": 14512415,
                            "format": "pdf",
                            "uploadedAt": "2016-04-21T07:51:59+00:00",
                            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                        },
                        "claimAmount": 2999.01,
                        "aggregateAmount": 2999.01,
                        "expiresAt": "2016-04-21T07:51:59+00:00",
                        "carrier": "AT&T",
                        "deductible": 442.99
                    },
                    "ach": {
                        "bankName": "ABC Bank",
                        "accountType": "checking",
                        "accountNumber": "1234567890",
                        "routing": "123456789"
                    }
                },
                "loanAmount": 33.01,
                "lienPosition": "first",
                "valueQualifiers": [
                    "as-is",
                    "subject-to-completed"
                ],
                "subAssignees": [
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "firstName": "Hancock",
                        "lastName": "Hancock",
                        "email": "john.hancock@gmail.com"
                    }
                ],
                "paymentMethod": null,
                "hasCreditCardInfo": false,
                "clientFee": 30.12,
                "orderedBy": {
                    "id": 131,
                    "firstName": "John",
                    "lastName": "Week",
                    "email": "appraiser@gmail.com",
                    "phone": "(410)123-4567",
                    "role": "processor",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": "76901",
                    "branchName": "Branching Branch"
                },
                "submittedBy": {
                    "id": 131,
                    "firstName": "John",
                    "lastName": "Week",
                    "email": "appraiser@gmail.com",
                    "phone": "(410)123-4567",
                    "role": "investor",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": "76901",
                    "branchName": "Branching Branch"
                }
            },
            "createdAt": "2016-04-21T07:51:59+00:00",
            "employee": "John Hancock"
        },
        {
            "id": 49,
            "isRead": false,
            "sender": [
                "** --------------- Example #1 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "name": "ABC Company",
                    "companyType": "bank-lender",
                    "type": "customer"
                },
                "** --------------- Example #2 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com",
                    "type": "appraiser"
                }
            ],
            "content": "This is a sample message.",
            "order": {
                "id": 5512,
                "fileNumber": "EFG41292",
                "asAppraisalId": "123456",
                "assignee": [
                    "** --------------- Example #1 --------------- **",
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "firstName": "Hancock",
                        "lastName": "Hancock",
                        "email": "john.hancock@gmail.com",
                        "type": "appraiser"
                    },
                    "** --------------- Example #2 --------------- **",
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "status": "approved",
                        "companyName": "ABC Company",
                        "email": "john.hancock@gmail.com",
                        "address1": "1234 Some Street",
                        "address2": "Suite 200",
                        "city": "Baltimore",
                        "state": {
                            "code": "CA",
                            "name": "California"
                        },
                        "zip": "21209",
                        "phone": "(410)123-4567",
                        "fax": "(410)123-4567",
                        "lenders": "ABC Lender",
                        "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                        "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                        "type": "amc"
                    }
                ],
                "company": {
                    "id": 83,
                    "name": "Best Appraisers Co.",
                    "firstName": "John",
                    "lastName": "White",
                    "email": "appraisers@company.com",
                    "phone": "(505) 242-2221",
                    "fax": "(505) 242-5522",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "zip": "94333",
                    "assignmentZip": "76901",
                    "state": {
                        "code": "CA",
                        "name": "California"
                    },
                    "w9": {
                        "id": 242,
                        "name": "test.pdf",
                        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                        "size": 14512415,
                        "format": "pdf",
                        "uploadedAt": "2016-04-21T07:51:59+00:00",
                        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                    },
                    "taxId": "00-0000000",
                    "type": "c-corporation",
                    "otherType": "Other company type",
                    "eo": {
                        "document": {
                            "id": 242,
                            "name": "test.pdf",
                            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                            "size": 14512415,
                            "format": "pdf",
                            "uploadedAt": "2016-04-21T07:51:59+00:00",
                            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                        },
                        "claimAmount": 2999.01,
                        "aggregateAmount": 2999.01,
                        "expiresAt": "2016-04-21T07:51:59+00:00",
                        "carrier": "AT&T",
                        "deductible": 442.99
                    },
                    "ach": {
                        "bankName": "ABC Bank",
                        "accountType": "checking",
                        "accountNumber": "1234567890",
                        "routing": "123456789"
                    }
                },
                "loanAmount": 33.01,
                "lienPosition": "first",
                "valueQualifiers": [
                    "as-is",
                    "subject-to-completed"
                ],
                "subAssignees": [
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "firstName": "Hancock",
                        "lastName": "Hancock",
                        "email": "john.hancock@gmail.com"
                    }
                ],
                "paymentMethod": null,
                "hasCreditCardInfo": false,
                "clientFee": 30.12,
                "orderedBy": {
                    "id": 131,
                    "firstName": "John",
                    "lastName": "Week",
                    "email": "appraiser@gmail.com",
                    "phone": "(410)123-4567",
                    "role": "processor",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": "76901",
                    "branchName": "Branching Branch"
                },
                "submittedBy": {
                    "id": 131,
                    "firstName": "John",
                    "lastName": "Week",
                    "email": "appraiser@gmail.com",
                    "phone": "(410)123-4567",
                    "role": "investor",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": "76901",
                    "branchName": "Branching Branch"
                }
            },
            "createdAt": "2016-04-21T07:51:59+00:00"
        }
    ]
}

POST /amcs/{amcId}/messages/mark-all-as-read Marks all messages as read

Response

Code: 204

POST /amcs/{amcId}/messages/mark-as-read Marks multiple messages as read

Request

Name Type Reference
body object N/A
- messages int[] N/A

Example:

{
    "messages": [
        120,
        51,
        122
    ]
}

Response

Code: 204

GET /amcs/{amcId}/messages/total Counts unread messages

Response

Code: 200

Name Type Reference
body object N/A
- total int N/A
- unread int N/A

Example:

{
    "total": 100,
    "unread": 52
}

GET /amcs/{amcId}/messages/{messageId} Get a message

Response

Code: 200

Name Type Reference
body mixed N/A
object Message Object
- OR -
object Customer Message Object

Example:

[
    "** --------------- Example #1 --------------- **",
    {
        "id": 49,
        "isRead": false,
        "sender": [
            "** --------------- Example #1 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "name": "ABC Company",
                "companyType": "bank-lender",
                "type": "customer"
            },
            "** --------------- Example #2 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com",
                "type": "appraiser"
            }
        ],
        "content": "This is a sample message.",
        "order": {
            "id": 5512,
            "fileNumber": "EFG41292",
            "asAppraisalId": "123456",
            "assignee": [
                "** --------------- Example #1 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com",
                    "type": "appraiser"
                },
                "** --------------- Example #2 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "status": "approved",
                    "companyName": "ABC Company",
                    "email": "john.hancock@gmail.com",
                    "address1": "1234 Some Street",
                    "address2": "Suite 200",
                    "city": "Baltimore",
                    "state": {
                        "code": "CA",
                        "name": "California"
                    },
                    "zip": "21209",
                    "phone": "(410)123-4567",
                    "fax": "(410)123-4567",
                    "lenders": "ABC Lender",
                    "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                    "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                    "type": "amc"
                }
            ],
            "company": {
                "id": 83,
                "name": "Best Appraisers Co.",
                "firstName": "John",
                "lastName": "White",
                "email": "appraisers@company.com",
                "phone": "(505) 242-2221",
                "fax": "(505) 242-5522",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "zip": "94333",
                "assignmentZip": "76901",
                "state": {
                    "code": "CA",
                    "name": "California"
                },
                "w9": {
                    "id": 242,
                    "name": "test.pdf",
                    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                    "size": 14512415,
                    "format": "pdf",
                    "uploadedAt": "2016-04-21T07:51:59+00:00",
                    "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                },
                "taxId": "00-0000000",
                "type": "c-corporation",
                "otherType": "Other company type",
                "eo": {
                    "document": {
                        "id": 242,
                        "name": "test.pdf",
                        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                        "size": 14512415,
                        "format": "pdf",
                        "uploadedAt": "2016-04-21T07:51:59+00:00",
                        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                    },
                    "claimAmount": 2999.01,
                    "aggregateAmount": 2999.01,
                    "expiresAt": "2016-04-21T07:51:59+00:00",
                    "carrier": "AT&T",
                    "deductible": 442.99
                },
                "ach": {
                    "bankName": "ABC Bank",
                    "accountType": "checking",
                    "accountNumber": "1234567890",
                    "routing": "123456789"
                }
            },
            "loanAmount": 33.01,
            "lienPosition": "first",
            "valueQualifiers": [
                "as-is",
                "subject-to-completed"
            ],
            "subAssignees": [
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com"
                }
            ],
            "paymentMethod": null,
            "hasCreditCardInfo": false,
            "clientFee": 30.12,
            "orderedBy": {
                "id": 131,
                "firstName": "John",
                "lastName": "Week",
                "email": "appraiser@gmail.com",
                "phone": "(410)123-4567",
                "role": "processor",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "state": "CA",
                "zip": "76901",
                "branchName": "Branching Branch"
            },
            "submittedBy": {
                "id": 131,
                "firstName": "John",
                "lastName": "Week",
                "email": "appraiser@gmail.com",
                "phone": "(410)123-4567",
                "role": "investor",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "state": "CA",
                "zip": "76901",
                "branchName": "Branching Branch"
            }
        },
        "createdAt": "2016-04-21T07:51:59+00:00"
    },
    "** --------------- Example #2 --------------- **",
    {
        "id": 49,
        "isRead": false,
        "sender": [
            "** --------------- Example #1 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "name": "ABC Company",
                "companyType": "bank-lender",
                "type": "customer"
            },
            "** --------------- Example #2 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com",
                "type": "appraiser"
            }
        ],
        "content": "This is a sample message.",
        "order": {
            "id": 5512,
            "fileNumber": "EFG41292",
            "asAppraisalId": "123456",
            "assignee": [
                "** --------------- Example #1 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com",
                    "type": "appraiser"
                },
                "** --------------- Example #2 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "status": "approved",
                    "companyName": "ABC Company",
                    "email": "john.hancock@gmail.com",
                    "address1": "1234 Some Street",
                    "address2": "Suite 200",
                    "city": "Baltimore",
                    "state": {
                        "code": "CA",
                        "name": "California"
                    },
                    "zip": "21209",
                    "phone": "(410)123-4567",
                    "fax": "(410)123-4567",
                    "lenders": "ABC Lender",
                    "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                    "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                    "type": "amc"
                }
            ],
            "company": {
                "id": 83,
                "name": "Best Appraisers Co.",
                "firstName": "John",
                "lastName": "White",
                "email": "appraisers@company.com",
                "phone": "(505) 242-2221",
                "fax": "(505) 242-5522",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "zip": "94333",
                "assignmentZip": "76901",
                "state": {
                    "code": "CA",
                    "name": "California"
                },
                "w9": {
                    "id": 242,
                    "name": "test.pdf",
                    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                    "size": 14512415,
                    "format": "pdf",
                    "uploadedAt": "2016-04-21T07:51:59+00:00",
                    "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                },
                "taxId": "00-0000000",
                "type": "c-corporation",
                "otherType": "Other company type",
                "eo": {
                    "document": {
                        "id": 242,
                        "name": "test.pdf",
                        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                        "size": 14512415,
                        "format": "pdf",
                        "uploadedAt": "2016-04-21T07:51:59+00:00",
                        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                    },
                    "claimAmount": 2999.01,
                    "aggregateAmount": 2999.01,
                    "expiresAt": "2016-04-21T07:51:59+00:00",
                    "carrier": "AT&T",
                    "deductible": 442.99
                },
                "ach": {
                    "bankName": "ABC Bank",
                    "accountType": "checking",
                    "accountNumber": "1234567890",
                    "routing": "123456789"
                }
            },
            "loanAmount": 33.01,
            "lienPosition": "first",
            "valueQualifiers": [
                "as-is",
                "subject-to-completed"
            ],
            "subAssignees": [
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com"
                }
            ],
            "paymentMethod": null,
            "hasCreditCardInfo": false,
            "clientFee": 30.12,
            "orderedBy": {
                "id": 131,
                "firstName": "John",
                "lastName": "Week",
                "email": "appraiser@gmail.com",
                "phone": "(410)123-4567",
                "role": "processor",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "state": "CA",
                "zip": "76901",
                "branchName": "Branching Branch"
            },
            "submittedBy": {
                "id": 131,
                "firstName": "John",
                "lastName": "Week",
                "email": "appraiser@gmail.com",
                "phone": "(410)123-4567",
                "role": "investor",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "state": "CA",
                "zip": "76901",
                "branchName": "Branching Branch"
            }
        },
        "createdAt": "2016-04-21T07:51:59+00:00",
        "employee": "John Hancock"
    }
]

POST /amcs/{amcId}/messages/{messageId}/mark-as-read Marks a message as read

Response

Code: 204

GET /amcs/{amcId}/orders Gets all orders

Request

Parameters

Name Type Reference
filter.acceptedAt date N/A
filter.company int N/A
filter.completedAt date N/A
filter.completedAt.day date N/A
filter.completedAt.from date N/A
filter.completedAt.month int N/A
filter.completedAt.to date N/A
filter.completedAt.year int N/A
filter.due enum today, tomorrow, next-7-days
filter.dueDate date N/A
filter.estimatedCompletionDate date N/A
filter.fileNumber string N/A
filter.inspectionCompletedAt date N/A
filter.inspectionScheduledAt date N/A
filter.isPaid bool N/A
filter.orderedAt date N/A
filter.orderedAt.day date N/A
filter.orderedAt.from date N/A
filter.orderedAt.month int N/A
filter.orderedAt.to date N/A
filter.orderedAt.year int N/A
filter.paidAt date N/A
filter.paidAt.day date N/A
filter.paidAt.from date N/A
filter.paidAt.month int N/A
filter.paidAt.to date N/A
filter.paidAt.year int N/A
filter.processStatus enum[] Process Status Enum
filter.property.state string N/A
filter.property.zip string N/A
filter.putOnHoldAt date N/A
filter.revisionReceivedAt date N/A
orderBy enum clientName, client.name, borrowerName, processStatus, fileNumber, loanNumber, orderedAt, dueDate, acceptedAt, inspectionCompletedAt, inspectionScheduledAt, estimatedCompletionDate, putOnHoldAt, completedAt, revisionReceivedAt, property.address, property.state.code, property.state.name, property.city, property.zip, customer.name
page int N/A
perPage int N/A
query string N/A
search.borrowerName string N/A
search.client.name string N/A
search.clientName string N/A
search.customer.name string N/A
search.fileNumber string N/A
search.loanNumber string N/A
search.property.address string N/A
search.property.city string N/A
search.property.zip string N/A

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Order Object
- meta object N/A
- - pagination object Pagination Object

Example:

{
    "data": [
        {
            "id": 5512,
            "fileNumber": "EFG41292",
            "asAppraisalId": "123456",
            "assignee": [
                "** --------------- Example #1 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com",
                    "type": "appraiser"
                },
                "** --------------- Example #2 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "status": "approved",
                    "companyName": "ABC Company",
                    "email": "john.hancock@gmail.com",
                    "address1": "1234 Some Street",
                    "address2": "Suite 200",
                    "city": "Baltimore",
                    "state": {
                        "code": "CA",
                        "name": "California"
                    },
                    "zip": "21209",
                    "phone": "(410)123-4567",
                    "fax": "(410)123-4567",
                    "lenders": "ABC Lender",
                    "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                    "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                    "type": "amc"
                }
            ],
            "company": {
                "id": 83,
                "name": "Best Appraisers Co.",
                "firstName": "John",
                "lastName": "White",
                "email": "appraisers@company.com",
                "phone": "(505) 242-2221",
                "fax": "(505) 242-5522",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "zip": "94333",
                "assignmentZip": "76901",
                "state": {
                    "code": "CA",
                    "name": "California"
                },
                "w9": {
                    "id": 242,
                    "name": "test.pdf",
                    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                    "size": 14512415,
                    "format": "pdf",
                    "uploadedAt": "2016-04-21T07:51:59+00:00",
                    "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                },
                "taxId": "00-0000000",
                "type": "c-corporation",
                "otherType": "Other company type",
                "eo": {
                    "document": {
                        "id": 242,
                        "name": "test.pdf",
                        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                        "size": 14512415,
                        "format": "pdf",
                        "uploadedAt": "2016-04-21T07:51:59+00:00",
                        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                    },
                    "claimAmount": 2999.01,
                    "aggregateAmount": 2999.01,
                    "expiresAt": "2016-04-21T07:51:59+00:00",
                    "carrier": "AT&T",
                    "deductible": 442.99
                },
                "ach": {
                    "bankName": "ABC Bank",
                    "accountType": "checking",
                    "accountNumber": "1234567890",
                    "routing": "123456789"
                }
            },
            "loanAmount": 33.01,
            "lienPosition": "first",
            "valueQualifiers": [
                "as-is",
                "subject-to-completed"
            ],
            "subAssignees": [
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com"
                }
            ],
            "paymentMethod": null,
            "hasCreditCardInfo": false,
            "clientFee": 30.12,
            "orderedBy": {
                "id": 131,
                "firstName": "John",
                "lastName": "Week",
                "email": "appraiser@gmail.com",
                "phone": "(410)123-4567",
                "role": "processor",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "state": "CA",
                "zip": "76901",
                "branchName": "Branching Branch"
            },
            "submittedBy": {
                "id": 131,
                "firstName": "John",
                "lastName": "Week",
                "email": "appraiser@gmail.com",
                "phone": "(410)123-4567",
                "role": "investor",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "state": "CA",
                "zip": "76901",
                "branchName": "Branching Branch"
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 1000,
            "perPage": 10,
            "page": 31,
            "totalPages": 100
        }
    }
}

GET /amcs/{amcId}/orders/accounting Gets orders for accounting purposes

Request

Parameters

Name Type Reference
filter.acceptedAt date N/A
filter.company int N/A
filter.completedAt date N/A
filter.completedAt.day date N/A
filter.completedAt.from date N/A
filter.completedAt.month int N/A
filter.completedAt.to date N/A
filter.completedAt.year int N/A
filter.due enum today, tomorrow, next-7-days
filter.dueDate date N/A
filter.estimatedCompletionDate date N/A
filter.fileNumber string N/A
filter.inspectionCompletedAt date N/A
filter.inspectionScheduledAt date N/A
filter.isPaid bool N/A
filter.orderedAt date N/A
filter.orderedAt.day date N/A
filter.orderedAt.from date N/A
filter.orderedAt.month int N/A
filter.orderedAt.to date N/A
filter.orderedAt.year int N/A
filter.paidAt date N/A
filter.paidAt.day date N/A
filter.paidAt.from date N/A
filter.paidAt.month int N/A
filter.paidAt.to date N/A
filter.paidAt.year int N/A
filter.processStatus enum[] Process Status Enum
filter.property.state string N/A
filter.property.zip string N/A
filter.putOnHoldAt date N/A
filter.revisionReceivedAt date N/A
orderBy enum clientName, client.name, borrowerName, processStatus, fileNumber, loanNumber, orderedAt, dueDate, acceptedAt, inspectionCompletedAt, inspectionScheduledAt, estimatedCompletionDate, putOnHoldAt, completedAt, revisionReceivedAt, property.address, property.state.code, property.state.name, property.city, property.zip, customer.name
page int N/A
perPage int N/A
query string N/A
search.borrowerName string N/A
search.client.name string N/A
search.clientName string N/A
search.customer.name string N/A
search.fileNumber string N/A
search.loanNumber string N/A
search.property.address string N/A
search.property.city string N/A
search.property.zip string N/A

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Order Object
- meta object N/A
- - pagination object Pagination Object

Example:

{
    "data": [
        {
            "id": 5512,
            "fileNumber": "EFG41292",
            "asAppraisalId": "123456",
            "assignee": [
                "** --------------- Example #1 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com",
                    "type": "appraiser"
                },
                "** --------------- Example #2 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "status": "approved",
                    "companyName": "ABC Company",
                    "email": "john.hancock@gmail.com",
                    "address1": "1234 Some Street",
                    "address2": "Suite 200",
                    "city": "Baltimore",
                    "state": {
                        "code": "CA",
                        "name": "California"
                    },
                    "zip": "21209",
                    "phone": "(410)123-4567",
                    "fax": "(410)123-4567",
                    "lenders": "ABC Lender",
                    "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                    "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                    "type": "amc"
                }
            ],
            "company": {
                "id": 83,
                "name": "Best Appraisers Co.",
                "firstName": "John",
                "lastName": "White",
                "email": "appraisers@company.com",
                "phone": "(505) 242-2221",
                "fax": "(505) 242-5522",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "zip": "94333",
                "assignmentZip": "76901",
                "state": {
                    "code": "CA",
                    "name": "California"
                },
                "w9": {
                    "id": 242,
                    "name": "test.pdf",
                    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                    "size": 14512415,
                    "format": "pdf",
                    "uploadedAt": "2016-04-21T07:51:59+00:00",
                    "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                },
                "taxId": "00-0000000",
                "type": "c-corporation",
                "otherType": "Other company type",
                "eo": {
                    "document": {
                        "id": 242,
                        "name": "test.pdf",
                        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                        "size": 14512415,
                        "format": "pdf",
                        "uploadedAt": "2016-04-21T07:51:59+00:00",
                        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                    },
                    "claimAmount": 2999.01,
                    "aggregateAmount": 2999.01,
                    "expiresAt": "2016-04-21T07:51:59+00:00",
                    "carrier": "AT&T",
                    "deductible": 442.99
                },
                "ach": {
                    "bankName": "ABC Bank",
                    "accountType": "checking",
                    "accountNumber": "1234567890",
                    "routing": "123456789"
                }
            },
            "loanAmount": 33.01,
            "lienPosition": "first",
            "valueQualifiers": [
                "as-is",
                "subject-to-completed"
            ],
            "subAssignees": [
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com"
                }
            ],
            "paymentMethod": null,
            "hasCreditCardInfo": false,
            "clientFee": 30.12,
            "orderedBy": {
                "id": 131,
                "firstName": "John",
                "lastName": "Week",
                "email": "appraiser@gmail.com",
                "phone": "(410)123-4567",
                "role": "processor",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "state": "CA",
                "zip": "76901",
                "branchName": "Branching Branch"
            },
            "submittedBy": {
                "id": 131,
                "firstName": "John",
                "lastName": "Week",
                "email": "appraiser@gmail.com",
                "phone": "(410)123-4567",
                "role": "investor",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "state": "CA",
                "zip": "76901",
                "branchName": "Branching Branch"
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 1000,
            "perPage": 10,
            "page": 31,
            "totalPages": 100
        }
    }
}

GET /amcs/{amcId}/orders/summary/totals Gets summary

Response

Code: 200

Name Type Reference
body object Order Totals Object

Example:

{
    "paid": {
        "total": 20,
        "fee": 49.99,
        "techFee": 49.99
    },
    "unpaid": {
        "total": 20,
        "fee": 49.99,
        "techFee": 49.99
    }
}

DELETE /amcs/{amcId}/orders/{orderId} Deletes an order

Response

Code: 204

GET /amcs/{amcId}/orders/{orderId} Gets an order

Response

Code: 200

Name Type Reference
body object Order Object

Example:

{
    "id": 5512,
    "fileNumber": "EFG41292",
    "asAppraisalId": "123456",
    "assignee": [
        "** --------------- Example #1 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com",
            "type": "appraiser"
        },
        "** --------------- Example #2 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "status": "approved",
            "companyName": "ABC Company",
            "email": "john.hancock@gmail.com",
            "address1": "1234 Some Street",
            "address2": "Suite 200",
            "city": "Baltimore",
            "state": {
                "code": "CA",
                "name": "California"
            },
            "zip": "21209",
            "phone": "(410)123-4567",
            "fax": "(410)123-4567",
            "lenders": "ABC Lender",
            "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
            "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
            "type": "amc"
        }
    ],
    "company": {
        "id": 83,
        "name": "Best Appraisers Co.",
        "firstName": "John",
        "lastName": "White",
        "email": "appraisers@company.com",
        "phone": "(505) 242-2221",
        "fax": "(505) 242-5522",
        "address1": "422 Long Rd.",
        "address2": "422H Long Rd.",
        "city": "San Francisco",
        "zip": "94333",
        "assignmentZip": "76901",
        "state": {
            "code": "CA",
            "name": "California"
        },
        "w9": {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        },
        "taxId": "00-0000000",
        "type": "c-corporation",
        "otherType": "Other company type",
        "eo": {
            "document": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "claimAmount": 2999.01,
            "aggregateAmount": 2999.01,
            "expiresAt": "2016-04-21T07:51:59+00:00",
            "carrier": "AT&T",
            "deductible": 442.99
        },
        "ach": {
            "bankName": "ABC Bank",
            "accountType": "checking",
            "accountNumber": "1234567890",
            "routing": "123456789"
        }
    },
    "intendedUse": "Purchase",
    "referenceNumber": "ABCD1234",
    "rulesets": [
        {
            "id": 131,
            "level": 2,
            "label": "Client ABC",
            "rules": {
                "requireEnv": true,
                "clientAddress1": "1144 Holloway Ave.",
                "clientAddress2": "1144B Holloway Ave.",
                "clientState": {
                    "code": "CA",
                    "name": "California"
                },
                "clientCity": "San Francisco",
                "clientZip": "94132",
                "clientDisplayedOnReportAddress1": "1144 Holloway Ave.",
                "clientDisplayedOnReportAddress2": "1144B Holloway Ave.",
                "clientDisplayedOnReportState": {
                    "code": "CA",
                    "name": "California"
                },
                "clientDisplayedOnReportCity": "San Francisco",
                "clientDisplayedOnReportZip": "94132",
                "displayFdic": false,
                "dateRestrictionsIncludeTime": true
            }
        }
    ],
    "rules": {
        "requireEnv": true,
        "clientAddress1": "1144 Holloway Ave.",
        "clientAddress2": "1144B Holloway Ave.",
        "clientState": {
            "code": "CA",
            "name": "California"
        },
        "clientCity": "San Francisco",
        "clientZip": "94132",
        "clientDisplayedOnReportAddress1": "1144 Holloway Ave.",
        "clientDisplayedOnReportAddress2": "1144B Holloway Ave.",
        "clientDisplayedOnReportState": {
            "code": "CA",
            "name": "California"
        },
        "clientDisplayedOnReportCity": "San Francisco",
        "clientDisplayedOnReportZip": "94132",
        "displayFdic": false,
        "dateRestrictionsIncludeTime": true
    },
    "clientName": "ABC Bank",
    "clientAddress1": "123 Market Str.",
    "clientAddress2": "123B Market Str.",
    "clientCity": "San Francisco",
    "clientState": {
        "code": "CA",
        "name": "California"
    },
    "clientZip": "92104",
    "client": {
        "id": 131
    },
    "clientDisplayedOnReportName": "ABC Bank",
    "clientDisplayedOnReportAddress1": "123 Market Str.",
    "clientDisplayedOnReportAddress2": "123B Market Str.",
    "clientDisplayedOnReportCity": "San Francisco",
    "clientDisplayedOnReportState": {
        "code": "CA",
        "name": "California"
    },
    "clientDisplayedOnReportZip": "92104",
    "clientDisplayedOnReport": {
        "id": 131
    },
    "customer": {
        "id": 424,
        "username": "johnhancock",
        "displayName": "John Hancock",
        "name": "ABC Company",
        "companyType": "bank-lender"
    },
    "amcLicenseNumber": "ABC1234567",
    "amcLicenseExpiresAt": "2016-04-21T07:51:59+00:00",
    "jobType": {
        "id": 131,
        "title": "URAR(303)",
        "isCommercial": false,
        "local": {
            "id": 131,
            "title": "URAR(303)"
        },
        "isPayable": true
    },
    "additionalJobTypes": [
        {
            "id": 131,
            "title": "URAR(303)",
            "isCommercial": false,
            "local": {
                "id": 131,
                "title": "URAR(303)"
            },
            "isPayable": true
        }
    ],
    "isRush": true,
    "isPaid": true,
    "fee": 13.21,
    "techFee": 13.21,
    "isTechFeePaid": false,
    "purchasePrice": 199.01,
    "fhaNumber": "123456789B",
    "loanNumber": "123456789B",
    "loanType": "123456789B",
    "loanAmount": 33.01,
    "contractDocument": {
        "id": 131,
        "type": {
            "id": 131,
            "title": "Invoice"
        },
        "label": "Invoice",
        "document": {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        },
        "createdAt": "2016-04-21T07:51:59+00:00"
    },
    "contractDate": "2016-04-21T07:51:59+00:00",
    "salesPrice": 42.11,
    "concession": 42.11,
    "concessionUnit": "amount",
    "processStatus": "new",
    "comment": "Some message",
    "additionalStatus": {
        "id": 131,
        "title": "Waiting for client",
        "comment": "Some text"
    },
    "additionalStatusComment": "Some comment here",
    "approachesToBeIncluded": [
        "cost",
        "sales"
    ],
    "dueDate": "2016-04-21T07:51:59+00:00",
    "orderedAt": "2016-04-21T07:51:59+00:00",
    "assignedAt": "2016-04-21T07:51:59+00:00",
    "acceptedAt": "2016-04-21T07:51:59+00:00",
    "putOnHoldAt": "2016-04-21T07:51:59+00:00",
    "revisionReceivedAt": "2016-04-21T07:51:59+00:00",
    "inspectionScheduledAt": "2016-04-21T07:51:59+00:00",
    "inspectionCompletedAt": "2016-04-21T07:51:59+00:00",
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "completedAt": "2016-04-21T07:51:59+00:00",
    "paidAt": "2016-04-21T07:51:59+00:00",
    "fdic": {
        "fin": "42124",
        "taskOrder": "4221",
        "line": 2,
        "contractor": "contractor_1234",
        "assetNumber": "AB1244",
        "assetType": "settlement",
        "assetName": "AB1244",
        "receivershipName": "AB1244"
    },
    "property": {
        "type": "ABC Type",
        "characteristics": [
            "Water Access",
            "Water Front"
        ],
        "approxBuildingSize": 14.3,
        "approxLandSize": 52.12,
        "buildingAge": 21,
        "numberOfStories": 12,
        "numberOfUnits": 56,
        "grossRentalIncome": 42.19,
        "incomeSalesCost": 42.19,
        "valueTypes": [
            "market",
            "insurable"
        ],
        "valueQualifiers": [
            "as-proposed",
            "going-concern"
        ],
        "ownerInterest": "fee-simple",
        "ownerInterests": [
            "fee-simple",
            "duplex"
        ],
        "address1": "144 Market Str.",
        "address2": "144B Market Str.",
        "city": "San Francisco",
        "state": {
            "code": "CA",
            "name": "California"
        },
        "zip": "94132",
        "county": {
            "id": 42,
            "title": "BRISTOL BAY"
        },
        "latitude": "46.9964354",
        "longitude": "28.8570757",
        "occupancy": "tenant",
        "bestPersonToContact": "owner",
        "contacts": [
            {
                "type": "realtor",
                "name": "John",
                "firstName": "Steve",
                "lastName": "Job",
                "middleName": "Mike",
                "displayName": "Mike",
                "homePhone": "(707) 553-1231",
                "cellPhone": "(707) 553-1231",
                "workPhone": "(707) 553-1231",
                "email": "info@valuepad.com",
                "intentProceedDate": "2016-04-20T07:51:59+00:00"
            }
        ],
        "legal": "some text",
        "additionalComments": "some comments"
    },
    "instructionDocuments": [
        {
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "name": "test.pdf",
            "size": 14512415,
            "format": "pdf"
        }
    ],
    "instruction": "Some instruction here",
    "additionalDocuments": [
        {
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "name": "test.pdf",
            "size": 14512415,
            "format": "pdf"
        }
    ],
    "bid": {
        "amount": 49.99,
        "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
        "comments": "Additional comment here.",
        "appraisers": [
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com"
            }
        ]
    },
    "invitation": {
        "amount": 49.99,
        "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
        "comments": "Additional comment here.",
        "appraisers": [
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com"
            }
        ]
    },
    "acceptedConditions": {
        "request": "fee-increase",
        "fee": 49.99,
        "dueDate": "2016-04-21T07:51:59+00:00",
        "explanation": "New conditions.",
        "additionalComments": "Some comments"
    },
    "lienPosition": "first",
    "valueQualifiers": [
        "as-is",
        "subject-to-completed"
    ],
    "subAssignees": [
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com"
        }
    ],
    "paymentMethod": null,
    "hasCreditCardInfo": false,
    "clientFee": 30.12,
    "orderedBy": {
        "id": 131,
        "firstName": "John",
        "lastName": "Week",
        "email": "appraiser@gmail.com",
        "phone": "(410)123-4567",
        "role": "processor",
        "address1": "422 Long Rd.",
        "address2": "422H Long Rd.",
        "city": "San Francisco",
        "state": "CA",
        "zip": "76901",
        "branchName": "Branching Branch"
    },
    "submittedBy": {
        "id": 131,
        "firstName": "John",
        "lastName": "Week",
        "email": "appraiser@gmail.com",
        "phone": "(410)123-4567",
        "role": "investor",
        "address1": "422 Long Rd.",
        "address2": "422H Long Rd.",
        "city": "San Francisco",
        "state": "CA",
        "zip": "76901",
        "branchName": "Branching Branch"
    },
    "amcUsers": {
        "amcOrderedForFirstName": "John",
        "amcOrderedForLastName": "Week",
        "amcOrderedForEmail": "appraiser@gmail.com",
        "amcOrderedForRole": "processor",
        "amcOrderedForPhone": "(410)123-4567",
        "amcOrderedForFax": "(410)123-4567",
        "amcOrderedForBranchName": "Branching Branch",
        "amcSubmittedByFirstName": "John",
        "amcSubmittedByLastName": "Week",
        "amcSubmittedByEmail": "appraiser@gmail.com",
        "amcSubmittedByRole": "appraiser",
        "amcSubmittedByPhone": "(410)123-4567",
        "amcSubmittedByFax": "(410)123-4567",
        "amcSubmittedByBranchName": "Branching Branch"
    }
}

POST /amcs/{amcId}/orders/{orderId}/accept Accepts an order

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/accept-with-conditions Accepts an order with conditions

Request

Name Type Reference
body object Conditions Persistable

Example:

{
    "request": "fee-increase",
    "fee": 49.99,
    "dueDate": "2016-04-21T07:51:59+00:00",
    "explanation": "New conditions."
}

Response

Code: 204

GET /amcs/{amcId}/orders/{orderId}/additional-documents Gets all additional documents

Request

Parameters

Name Type Reference
orderBy enum createdAt

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Order Additional Document Object

Example:

{
    "data": [
        {
            "id": 131,
            "type": {
                "id": 131,
                "title": "Invoice"
            },
            "label": "Invoice",
            "document": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "createdAt": "2016-04-21T07:51:59+00:00"
        }
    ]
}

POST /amcs/{amcId}/orders/{orderId}/additional-documents Creates an additional document

Request

Name Type Reference
body object Order Additional Document Persistable

Example:

{
    "type": 131,
    "label": "Invoice",
    "document": 49
}

Response

Code: 200

Name Type Reference
body object Order Additional Document Object

Example:

{
    "id": 131,
    "type": {
        "id": 131,
        "title": "Invoice"
    },
    "label": "Invoice",
    "document": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "createdAt": "2016-04-21T07:51:59+00:00"
}

GET /amcs/{amcId}/orders/{orderId}/additional-documents/types Gets all type of additional documents

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Order Additional Document Type Object

Example:

{
    "data": [
        {
            "id": 131,
            "title": "Invoice"
        }
    ]
}

GET /amcs/{amcId}/orders/{orderId}/additional-statuses Gets additional statuses for an order

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Additional Status Object

Example:

{
    "data": [
        {
            "id": 131,
            "title": "Waiting for client",
            "comment": "Some text"
        }
    ]
}

POST /amcs/{amcId}/orders/{orderId}/bid Creates a bid

Request

Name Type Reference
body object Bid Persistable

Example:

{
    "amount": 49.99,
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "comments": "Additional comment here.",
    "appraisers": [
        3,
        42
    ]
}

Response

Code: 200

Name Type Reference
body object Bid Object

Example:

{
    "amount": 49.99,
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "comments": "Additional comment here.",
    "appraisers": [
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com"
        }
    ]
}

GET /amcs/{amcId}/orders/{orderId}/bid Gets a bid

Response

Code: 200

Name Type Reference
body object Bid Object

Example:

{
    "amount": 49.99,
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "comments": "Additional comment here.",
    "appraisers": [
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com"
        }
    ]
}

POST /amcs/{amcId}/orders/{orderId}/change-additional-status Change additional status

Request

Name Type Reference
body object Change Additional Status Persistable

Example:

{
    "additionalStatus": 49,
    "comment": "Some text"
}

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/complete-inspection Complete Inspection

Request

Name Type Reference
body object Order Complete Inspection Persistable

Example:

{
    "completedAt": "2016-04-21T07:51:59+00:00",
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "message": {
        "content": "This is my message!"
    }
}

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/decline Declines an order

Request

Name Type Reference
body object N/A
- reason enum Order Decline Reason Enum
- message string N/A

Example:

{
    "reason": "other",
    "message": "Some text"
}

Response

Code: 204

PATCH /amcs/{amcId}/orders/{orderId}/document Updates a document

Request

Name Type Reference
body object N/A
- extra mixed[] N/A
int N/A
- OR -
object Document Identifier Persistable

Example:

{
    "extra": [
        10,
        {
            "id": 10,
            "token": "58IKsPHGJNDwUnOOjHJtPT6ZlSv14hwkPEhAKbGMhiZ1tcZuPSlqnhh4Z88LWKgl"
        }
    ]
}

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/document Creates a document

Request

Name Type Reference
body object Order Document Persistable

Example:

{
    "showToAppraiser": true,
    "primary": [
        "** --------------- Example #1 --------------- **",
        21,
        "** --------------- Example #2 --------------- **",
        {
            "id": 10,
            "token": "58IKsPHGJNDwUnOOjHJtPT6ZlSv14hwkPEhAKbGMhiZ1tcZuPSlqnhh4Z88LWKgl"
        }
    ],
    "primaries": [
        21,
        {
            "id": 10,
            "token": "58IKsPHGJNDwUnOOjHJtPT6ZlSv14hwkPEhAKbGMhiZ1tcZuPSlqnhh4Z88LWKgl"
        }
    ],
    "extra": [
        21,
        {
            "id": 10,
            "token": "58IKsPHGJNDwUnOOjHJtPT6ZlSv14hwkPEhAKbGMhiZ1tcZuPSlqnhh4Z88LWKgl"
        }
    ]
}

Response

Code: 200

Name Type Reference
body object Order Document Object

Example:

{
    "id": 49,
    "showToAppraiser": true,
    "primary": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "primaries": [
        {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        }
    ],
    "extra": [
        {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        }
    ],
    "createdAt": "2016-04-20T07:51:59+00:00"
}

GET /amcs/{amcId}/orders/{orderId}/document Gets a document

Response

Code: 200

Name Type Reference
body object Order Document Object

Example:

{
    "id": 49,
    "showToAppraiser": true,
    "primary": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "primaries": [
        {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        }
    ],
    "extra": [
        {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        }
    ],
    "createdAt": "2016-04-20T07:51:59+00:00"
}

GET /amcs/{amcId}/orders/{orderId}/document/formats Gets all available document formats

Response

Code: 200

Name Type Reference
body object Assignee Order Document Formats Object

Example:

{
    "primary": [
        "pdf",
        "xml"
    ],
    "extra": [
        "aci",
        "env"
    ]
}

PATCH /amcs/{amcId}/orders/{orderId}/fee Updates the fee of an assigned order if allowed to do so by the assignee

Request

Name Type Reference
body object Order Fee Persistable

Example:

{
    "amount": 550.99
}

Response

Code: 204

GET /amcs/{amcId}/orders/{orderId}/logs Gets all logs related to a specific order

Request

Parameters

Name Type Reference
filter.initiator bool N/A
orderBy enum createdAt
page int N/A
perPage int N/A

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Log Object
- meta object N/A
- - pagination object Pagination Object

Example:

{
    "data": [
        {
            "id": 49,
            "order": {
                "id": 5512,
                "fileNumber": "EFG41292",
                "asAppraisalId": "123456",
                "assignee": [
                    "** --------------- Example #1 --------------- **",
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "firstName": "Hancock",
                        "lastName": "Hancock",
                        "email": "john.hancock@gmail.com",
                        "type": "appraiser"
                    },
                    "** --------------- Example #2 --------------- **",
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "status": "approved",
                        "companyName": "ABC Company",
                        "email": "john.hancock@gmail.com",
                        "address1": "1234 Some Street",
                        "address2": "Suite 200",
                        "city": "Baltimore",
                        "state": {
                            "code": "CA",
                            "name": "California"
                        },
                        "zip": "21209",
                        "phone": "(410)123-4567",
                        "fax": "(410)123-4567",
                        "lenders": "ABC Lender",
                        "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                        "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                        "type": "amc"
                    }
                ],
                "company": {
                    "id": 83,
                    "name": "Best Appraisers Co.",
                    "firstName": "John",
                    "lastName": "White",
                    "email": "appraisers@company.com",
                    "phone": "(505) 242-2221",
                    "fax": "(505) 242-5522",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "zip": "94333",
                    "assignmentZip": "76901",
                    "state": {
                        "code": "CA",
                        "name": "California"
                    },
                    "w9": {
                        "id": 242,
                        "name": "test.pdf",
                        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                        "size": 14512415,
                        "format": "pdf",
                        "uploadedAt": "2016-04-21T07:51:59+00:00",
                        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                    },
                    "taxId": "00-0000000",
                    "type": "c-corporation",
                    "otherType": "Other company type",
                    "eo": {
                        "document": {
                            "id": 242,
                            "name": "test.pdf",
                            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                            "size": 14512415,
                            "format": "pdf",
                            "uploadedAt": "2016-04-21T07:51:59+00:00",
                            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                        },
                        "claimAmount": 2999.01,
                        "aggregateAmount": 2999.01,
                        "expiresAt": "2016-04-21T07:51:59+00:00",
                        "carrier": "AT&T",
                        "deductible": 442.99
                    },
                    "ach": {
                        "bankName": "ABC Bank",
                        "accountType": "checking",
                        "accountNumber": "1234567890",
                        "routing": "123456789"
                    }
                },
                "loanAmount": 33.01,
                "lienPosition": "first",
                "valueQualifiers": [
                    "as-is",
                    "subject-to-completed"
                ],
                "subAssignees": [
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "firstName": "Hancock",
                        "lastName": "Hancock",
                        "email": "john.hancock@gmail.com"
                    }
                ],
                "paymentMethod": null,
                "hasCreditCardInfo": false,
                "clientFee": 30.12,
                "orderedBy": {
                    "id": 131,
                    "firstName": "John",
                    "lastName": "Week",
                    "email": "appraiser@gmail.com",
                    "phone": "(410)123-4567",
                    "role": "processor",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": "76901",
                    "branchName": "Branching Branch"
                },
                "submittedBy": {
                    "id": 131,
                    "firstName": "John",
                    "lastName": "Week",
                    "email": "appraiser@gmail.com",
                    "phone": "(410)123-4567",
                    "role": "investor",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": "76901",
                    "branchName": "Branching Branch"
                }
            },
            "user": [
                "** --------------- Example #1 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "name": "ABC Company",
                    "companyType": "bank-lender",
                    "type": "customer"
                },
                "** --------------- Example #2 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com",
                    "type": "appraiser"
                }
            ],
            "action": "create-order",
            "actionLabel": "Created Order",
            "message": "Your customer has created an order!",
            "extra": {
                "user": "John Hancock"
            },
            "createdAt": "2016-04-21T07:51:59+00:00"
        }
    ],
    "meta": {
        "pagination": {
            "total": 1000,
            "perPage": 10,
            "page": 31,
            "totalPages": 100
        }
    }
}

POST /amcs/{amcId}/orders/{orderId}/messages Creates a message

Request

Name Type Reference
body object Message Persistable

Example:

{
    "content": "This is my message!"
}

Response

Code: 200

Name Type Reference
body object Message Object

Example:

{
    "id": 49,
    "isRead": false,
    "sender": [
        "** --------------- Example #1 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "name": "ABC Company",
            "companyType": "bank-lender",
            "type": "customer"
        },
        "** --------------- Example #2 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com",
            "type": "appraiser"
        }
    ],
    "content": "This is a sample message.",
    "order": {
        "id": 5512,
        "fileNumber": "EFG41292",
        "asAppraisalId": "123456",
        "assignee": [
            "** --------------- Example #1 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com",
                "type": "appraiser"
            },
            "** --------------- Example #2 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "status": "approved",
                "companyName": "ABC Company",
                "email": "john.hancock@gmail.com",
                "address1": "1234 Some Street",
                "address2": "Suite 200",
                "city": "Baltimore",
                "state": {
                    "code": "CA",
                    "name": "California"
                },
                "zip": "21209",
                "phone": "(410)123-4567",
                "fax": "(410)123-4567",
                "lenders": "ABC Lender",
                "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                "type": "amc"
            }
        ],
        "company": {
            "id": 83,
            "name": "Best Appraisers Co.",
            "firstName": "John",
            "lastName": "White",
            "email": "appraisers@company.com",
            "phone": "(505) 242-2221",
            "fax": "(505) 242-5522",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "zip": "94333",
            "assignmentZip": "76901",
            "state": {
                "code": "CA",
                "name": "California"
            },
            "w9": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "taxId": "00-0000000",
            "type": "c-corporation",
            "otherType": "Other company type",
            "eo": {
                "document": {
                    "id": 242,
                    "name": "test.pdf",
                    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                    "size": 14512415,
                    "format": "pdf",
                    "uploadedAt": "2016-04-21T07:51:59+00:00",
                    "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                },
                "claimAmount": 2999.01,
                "aggregateAmount": 2999.01,
                "expiresAt": "2016-04-21T07:51:59+00:00",
                "carrier": "AT&T",
                "deductible": 442.99
            },
            "ach": {
                "bankName": "ABC Bank",
                "accountType": "checking",
                "accountNumber": "1234567890",
                "routing": "123456789"
            }
        },
        "loanAmount": 33.01,
        "lienPosition": "first",
        "valueQualifiers": [
            "as-is",
            "subject-to-completed"
        ],
        "subAssignees": [
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com"
            }
        ],
        "paymentMethod": null,
        "hasCreditCardInfo": false,
        "clientFee": 30.12,
        "orderedBy": {
            "id": 131,
            "firstName": "John",
            "lastName": "Week",
            "email": "appraiser@gmail.com",
            "phone": "(410)123-4567",
            "role": "processor",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "state": "CA",
            "zip": "76901",
            "branchName": "Branching Branch"
        },
        "submittedBy": {
            "id": 131,
            "firstName": "John",
            "lastName": "Week",
            "email": "appraiser@gmail.com",
            "phone": "(410)123-4567",
            "role": "investor",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "state": "CA",
            "zip": "76901",
            "branchName": "Branching Branch"
        }
    },
    "createdAt": "2016-04-21T07:51:59+00:00"
}

GET /amcs/{amcId}/orders/{orderId}/messages Gets messages

Request

Parameters

Name Type Reference
filter.isRead bool N/A
orderBy enum createdAt
page int N/A
perPage int N/A

Response

Code: 200

Name Type Reference
body object N/A
- data mixed[] N/A
object Message Object
- OR -
object Customer Message Object
- meta object N/A
- - pagination object Pagination Object

Example:

{
    "data": [
        {
            "id": 49,
            "isRead": false,
            "sender": [
                "** --------------- Example #1 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "name": "ABC Company",
                    "companyType": "bank-lender",
                    "type": "customer"
                },
                "** --------------- Example #2 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com",
                    "type": "appraiser"
                }
            ],
            "content": "This is a sample message.",
            "order": {
                "id": 5512,
                "fileNumber": "EFG41292",
                "asAppraisalId": "123456",
                "assignee": [
                    "** --------------- Example #1 --------------- **",
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "firstName": "Hancock",
                        "lastName": "Hancock",
                        "email": "john.hancock@gmail.com",
                        "type": "appraiser"
                    },
                    "** --------------- Example #2 --------------- **",
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "status": "approved",
                        "companyName": "ABC Company",
                        "email": "john.hancock@gmail.com",
                        "address1": "1234 Some Street",
                        "address2": "Suite 200",
                        "city": "Baltimore",
                        "state": {
                            "code": "CA",
                            "name": "California"
                        },
                        "zip": "21209",
                        "phone": "(410)123-4567",
                        "fax": "(410)123-4567",
                        "lenders": "ABC Lender",
                        "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                        "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                        "type": "amc"
                    }
                ],
                "company": {
                    "id": 83,
                    "name": "Best Appraisers Co.",
                    "firstName": "John",
                    "lastName": "White",
                    "email": "appraisers@company.com",
                    "phone": "(505) 242-2221",
                    "fax": "(505) 242-5522",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "zip": "94333",
                    "assignmentZip": "76901",
                    "state": {
                        "code": "CA",
                        "name": "California"
                    },
                    "w9": {
                        "id": 242,
                        "name": "test.pdf",
                        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                        "size": 14512415,
                        "format": "pdf",
                        "uploadedAt": "2016-04-21T07:51:59+00:00",
                        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                    },
                    "taxId": "00-0000000",
                    "type": "c-corporation",
                    "otherType": "Other company type",
                    "eo": {
                        "document": {
                            "id": 242,
                            "name": "test.pdf",
                            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                            "size": 14512415,
                            "format": "pdf",
                            "uploadedAt": "2016-04-21T07:51:59+00:00",
                            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                        },
                        "claimAmount": 2999.01,
                        "aggregateAmount": 2999.01,
                        "expiresAt": "2016-04-21T07:51:59+00:00",
                        "carrier": "AT&T",
                        "deductible": 442.99
                    },
                    "ach": {
                        "bankName": "ABC Bank",
                        "accountType": "checking",
                        "accountNumber": "1234567890",
                        "routing": "123456789"
                    }
                },
                "loanAmount": 33.01,
                "lienPosition": "first",
                "valueQualifiers": [
                    "as-is",
                    "subject-to-completed"
                ],
                "subAssignees": [
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "firstName": "Hancock",
                        "lastName": "Hancock",
                        "email": "john.hancock@gmail.com"
                    }
                ],
                "paymentMethod": null,
                "hasCreditCardInfo": false,
                "clientFee": 30.12,
                "orderedBy": {
                    "id": 131,
                    "firstName": "John",
                    "lastName": "Week",
                    "email": "appraiser@gmail.com",
                    "phone": "(410)123-4567",
                    "role": "processor",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": "76901",
                    "branchName": "Branching Branch"
                },
                "submittedBy": {
                    "id": 131,
                    "firstName": "John",
                    "lastName": "Week",
                    "email": "appraiser@gmail.com",
                    "phone": "(410)123-4567",
                    "role": "investor",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": "76901",
                    "branchName": "Branching Branch"
                }
            },
            "createdAt": "2016-04-21T07:51:59+00:00"
        },
        {
            "id": 49,
            "isRead": false,
            "sender": [
                "** --------------- Example #1 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "name": "ABC Company",
                    "companyType": "bank-lender",
                    "type": "customer"
                },
                "** --------------- Example #2 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com",
                    "type": "appraiser"
                }
            ],
            "content": "This is a sample message.",
            "order": {
                "id": 5512,
                "fileNumber": "EFG41292",
                "asAppraisalId": "123456",
                "assignee": [
                    "** --------------- Example #1 --------------- **",
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "firstName": "Hancock",
                        "lastName": "Hancock",
                        "email": "john.hancock@gmail.com",
                        "type": "appraiser"
                    },
                    "** --------------- Example #2 --------------- **",
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "status": "approved",
                        "companyName": "ABC Company",
                        "email": "john.hancock@gmail.com",
                        "address1": "1234 Some Street",
                        "address2": "Suite 200",
                        "city": "Baltimore",
                        "state": {
                            "code": "CA",
                            "name": "California"
                        },
                        "zip": "21209",
                        "phone": "(410)123-4567",
                        "fax": "(410)123-4567",
                        "lenders": "ABC Lender",
                        "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                        "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                        "type": "amc"
                    }
                ],
                "company": {
                    "id": 83,
                    "name": "Best Appraisers Co.",
                    "firstName": "John",
                    "lastName": "White",
                    "email": "appraisers@company.com",
                    "phone": "(505) 242-2221",
                    "fax": "(505) 242-5522",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "zip": "94333",
                    "assignmentZip": "76901",
                    "state": {
                        "code": "CA",
                        "name": "California"
                    },
                    "w9": {
                        "id": 242,
                        "name": "test.pdf",
                        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                        "size": 14512415,
                        "format": "pdf",
                        "uploadedAt": "2016-04-21T07:51:59+00:00",
                        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                    },
                    "taxId": "00-0000000",
                    "type": "c-corporation",
                    "otherType": "Other company type",
                    "eo": {
                        "document": {
                            "id": 242,
                            "name": "test.pdf",
                            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                            "size": 14512415,
                            "format": "pdf",
                            "uploadedAt": "2016-04-21T07:51:59+00:00",
                            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                        },
                        "claimAmount": 2999.01,
                        "aggregateAmount": 2999.01,
                        "expiresAt": "2016-04-21T07:51:59+00:00",
                        "carrier": "AT&T",
                        "deductible": 442.99
                    },
                    "ach": {
                        "bankName": "ABC Bank",
                        "accountType": "checking",
                        "accountNumber": "1234567890",
                        "routing": "123456789"
                    }
                },
                "loanAmount": 33.01,
                "lienPosition": "first",
                "valueQualifiers": [
                    "as-is",
                    "subject-to-completed"
                ],
                "subAssignees": [
                    {
                        "id": 424,
                        "username": "johnhancock",
                        "displayName": "John Hancock",
                        "firstName": "Hancock",
                        "lastName": "Hancock",
                        "email": "john.hancock@gmail.com"
                    }
                ],
                "paymentMethod": null,
                "hasCreditCardInfo": false,
                "clientFee": 30.12,
                "orderedBy": {
                    "id": 131,
                    "firstName": "John",
                    "lastName": "Week",
                    "email": "appraiser@gmail.com",
                    "phone": "(410)123-4567",
                    "role": "processor",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": "76901",
                    "branchName": "Branching Branch"
                },
                "submittedBy": {
                    "id": 131,
                    "firstName": "John",
                    "lastName": "Week",
                    "email": "appraiser@gmail.com",
                    "phone": "(410)123-4567",
                    "role": "investor",
                    "address1": "422 Long Rd.",
                    "address2": "422H Long Rd.",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": "76901",
                    "branchName": "Branching Branch"
                }
            },
            "createdAt": "2016-04-21T07:51:59+00:00",
            "employee": "John Hancock"
        }
    ],
    "meta": {
        "pagination": {
            "total": 1000,
            "perPage": 10,
            "page": 31,
            "totalPages": 100
        }
    }
}

POST /amcs/{amcId}/orders/{orderId}/payment/authorize Pre-auth a credit card

Request

Name Type Reference
body object N/A
- amount float N/A

Example:

{
    "amount": 100
}

Response

Code: 200

POST /amcs/{amcId}/orders/{orderId}/payment/charge Pre-auth a credit card

Request

Name Type Reference
body object N/A
- amount float N/A
- invoiceNumber string N/A

Example:

{
    "amount": 100,
    "invoiceNumber": "ABC123"
}

Response

Code: 200

Name Type Reference
body object N/A
- transactionId string N/A

Example:

{
    "transactionId": "4565789189"
}

GET /amcs/{amcId}/orders/{orderId}/receipts Gets all receipt documents

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Order Sure Receipt Object

Example:

{
    "data": [
        {
            "id": 131,
            "document": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "createdAt": "2016-04-21T07:51:59+00:00"
        }
    ]
}

POST /amcs/{amcId}/orders/{orderId}/receipts Creates a receipt document

Request

Name Type Reference
body object Order Sure Receipt Persistable

Example:

{
    "document": [
        "** --------------- Example #1 --------------- **",
        144,
        "** --------------- Example #2 --------------- **",
        {
            "id": 10,
            "token": "58IKsPHGJNDwUnOOjHJtPT6ZlSv14hwkPEhAKbGMhiZ1tcZuPSlqnhh4Z88LWKgl"
        }
    ]
}

Response

Code: 200

Name Type Reference
body object Order Sure Receipt Object

Example:

{
    "id": 131,
    "document": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "createdAt": "2016-04-21T07:51:59+00:00"
}

GET /amcs/{amcId}/orders/{orderId}/reconsiderations Gets all reconsiderations

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Order Reconsideration Object

Example:

{
    "data": [
        {
            "id": 49,
            "comment": "Needs Reconsideration",
            "document": {
                "id": 131,
                "type": {
                    "id": 131,
                    "title": "Invoice"
                },
                "label": "Invoice",
                "document": {
                    "id": 242,
                    "name": "test.pdf",
                    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                    "size": 14512415,
                    "format": "pdf",
                    "uploadedAt": "2016-04-21T07:51:59+00:00",
                    "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                },
                "createdAt": "2016-04-21T07:51:59+00:00"
            },
            "documents": [
                {
                    "id": 131,
                    "type": {
                        "id": 131,
                        "title": "Invoice"
                    },
                    "label": "Invoice",
                    "document": {
                        "id": 242,
                        "name": "test.pdf",
                        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                        "size": 14512415,
                        "format": "pdf",
                        "uploadedAt": "2016-04-21T07:51:59+00:00",
                        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                    },
                    "createdAt": "2016-04-21T07:51:59+00:00"
                }
            ],
            "comparables": {
                "address": "1234 Some Street",
                "salesPrice": 49.99,
                "closedDate": "2016-04-20T07:51:59+00:00",
                "livingArea": "500",
                "siteSize": "300",
                "actualAge": "20",
                "distanceToSubject": "400",
                "sourceData": "MLS",
                "comment": "Review this comparable"
            },
            "createdAt": "2016-04-20T07:51:59+00:00"
        }
    ]
}

GET /amcs/{amcId}/orders/{orderId}/reconsiderations/{reconsiderationId} Get a reconsideration

Response

Code: 200

Name Type Reference
body object Order Reconsideration Object

Example:

{
    "id": 49,
    "comment": "Needs Reconsideration",
    "document": {
        "id": 131,
        "type": {
            "id": 131,
            "title": "Invoice"
        },
        "label": "Invoice",
        "document": {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        },
        "createdAt": "2016-04-21T07:51:59+00:00"
    },
    "documents": [
        {
            "id": 131,
            "type": {
                "id": 131,
                "title": "Invoice"
            },
            "label": "Invoice",
            "document": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "createdAt": "2016-04-21T07:51:59+00:00"
        }
    ],
    "comparables": {
        "address": "1234 Some Street",
        "salesPrice": 49.99,
        "closedDate": "2016-04-20T07:51:59+00:00",
        "livingArea": "500",
        "siteSize": "300",
        "actualAge": "20",
        "distanceToSubject": "400",
        "sourceData": "MLS",
        "comment": "Review this comparable"
    },
    "createdAt": "2016-04-20T07:51:59+00:00"
}

GET /amcs/{amcId}/orders/{orderId}/revisions Gets all revisions

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Order Revision Object

Example:

{
    "data": [
        {
            "id": 49,
            "checklist": [
                "one",
                "two"
            ],
            "message": "Needs a revision.",
            "createdAt": "2016-04-20T07:51:59+00:00"
        }
    ]
}

GET /amcs/{amcId}/orders/{orderId}/revisions/{revisionId} Get a revision

Response

Code: 200

Name Type Reference
body object Order Revision Object

Example:

{
    "id": 49,
    "checklist": [
        "one",
        "two"
    ],
    "message": "Needs a revision.",
    "createdAt": "2016-04-20T07:51:59+00:00"
}

POST /amcs/{amcId}/orders/{orderId}/schedule-inspection Schedule Inspection

Request

Name Type Reference
body object Order Schedule Inspection Persistable

Example:

{
    "scheduledAt": "2016-04-21T07:51:59+00:00",
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "message": {
        "content": "This is my message!"
    }
}

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/workflow/accepted Puts an order into the "accepted" process status

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/workflow/completed Puts an order into the "completed" process status

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/workflow/inspection-completed Puts an order into the "inspection-completed" process status

Request

Name Type Reference
body object Order Complete Inspection Persistable

Example:

{
    "completedAt": "2016-04-21T07:51:59+00:00",
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "message": {
        "content": "This is my message!"
    }
}

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/workflow/inspection-scheduled Puts an order into the "inspection-scheduled" process status

Request

Name Type Reference
body object Order Schedule Inspection Persistable

Example:

{
    "scheduledAt": "2016-04-21T07:51:59+00:00",
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "message": {
        "content": "This is my message!"
    }
}

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/workflow/late Puts an order into the "late" process status

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/workflow/new Puts an order into the "new" process status

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/workflow/on-hold Puts an order into the "on-hold" process status

Request

Name Type Reference
body object N/A
- explanation string N/A

Example:

{
    "explanation": "Waiting for the specification"
}

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/workflow/ready-for-review Puts an order into the "ready-for-review" process status

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/workflow/request-for-bid Puts an order into the "request-for-bid" process status

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/workflow/resume Puts an order back into the previous process status

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/workflow/reviewed Puts an order into the "reviewed" process status

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/workflow/revision-in-review Puts an order into the "revision-in-review" process status

Response

Code: 204

POST /amcs/{amcId}/orders/{orderId}/workflow/revision-pending Puts an order into the "revision-pending" process status

Response

Code: 204

GET /amcs/{amcId}/payment/bank-account Gets the bank account information

Response

Code: 200

Name Type Reference
body object Bank Account Object

Example:

{
    "accountType": "checking",
    "routingNumber": "123456789",
    "accountNumber": "1234567890",
    "nameOnAccount": "John Hancock",
    "bankName": "ABC Bank",
    "address": "124 Market Str.",
    "city": "San Francisco",
    "zip": "94102",
    "state": {
        "code": "CA",
        "name": "California"
    }
}

PUT /amcs/{amcId}/payment/bank-account Updates the bank account information

Request

Name Type Reference
body object Bank Account Persistable

Example:

{
    "accountType": "checking",
    "routingNumber": "123456789",
    "accountNumber": "1234567890",
    "nameOnAccount": "John Hancock",
    "bankName": "ABC Bank",
    "address": "124 Market Str.",
    "city": "San Francisco",
    "zip": "94102",
    "state": "OR"
}

Response

Code: 200

Name Type Reference
body object Bank Account Object

Example:

{
    "accountType": "checking",
    "routingNumber": "123456789",
    "accountNumber": "1234567890",
    "nameOnAccount": "John Hancock",
    "bankName": "ABC Bank",
    "address": "124 Market Str.",
    "city": "San Francisco",
    "zip": "94102",
    "state": {
        "code": "CA",
        "name": "California"
    }
}

GET /amcs/{amcId}/queues/counters Gets counters for queues

Response

Code: 200

Name Type Reference
body object N/A
- new int N/A
- accepted int N/A
- inspectionScheduled int N/A
- inspectionCompleted int N/A
- onHold int N/A
- late int N/A
- readyForReview int N/A
- completed int N/A
- revision int N/A
- due int N/A
- open int N/A
- all int N/A

Example:

{
    "new": 200,
    "accepted": 23,
    "inspectionScheduled": 94,
    "inspectionCompleted": 122,
    "onHold": 75,
    "late": 931,
    "readyForReview": 36,
    "completed": 56,
    "revision": 932,
    "due": 521,
    "open": 21,
    "all": 2982
}

GET /amcs/{amcId}/queues/{name} Gets all orders

Request

Parameters

Name Type Reference
filter.acceptedAt date N/A
filter.company int N/A
filter.completedAt date N/A
filter.completedAt.day date N/A
filter.completedAt.from date N/A
filter.completedAt.month int N/A
filter.completedAt.to date N/A
filter.completedAt.year int N/A
filter.due enum today, tomorrow, next-7-days
filter.dueDate date N/A
filter.estimatedCompletionDate date N/A
filter.fileNumber string N/A
filter.inspectionCompletedAt date N/A
filter.inspectionScheduledAt date N/A
filter.isPaid bool N/A
filter.orderedAt date N/A
filter.orderedAt.day date N/A
filter.orderedAt.from date N/A
filter.orderedAt.month int N/A
filter.orderedAt.to date N/A
filter.orderedAt.year int N/A
filter.paidAt date N/A
filter.paidAt.day date N/A
filter.paidAt.from date N/A
filter.paidAt.month int N/A
filter.paidAt.to date N/A
filter.paidAt.year int N/A
filter.processStatus enum[] Process Status Enum
filter.property.state string N/A
filter.property.zip string N/A
filter.putOnHoldAt date N/A
filter.revisionReceivedAt date N/A
orderBy enum clientName, client.name, borrowerName, processStatus, fileNumber, loanNumber, orderedAt, dueDate, acceptedAt, inspectionCompletedAt, inspectionScheduledAt, estimatedCompletionDate, putOnHoldAt, completedAt, revisionReceivedAt, property.address, property.state.code, property.state.name, property.city, property.zip, customer.name
page int N/A
perPage int N/A
query string N/A
search.borrowerName string N/A
search.client.name string N/A
search.clientName string N/A
search.customer.name string N/A
search.fileNumber string N/A
search.loanNumber string N/A
search.property.address string N/A
search.property.city string N/A
search.property.zip string N/A

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Order Object
- meta object N/A
- - pagination object Pagination Object

Example:

{
    "data": [
        {
            "id": 5512,
            "fileNumber": "EFG41292",
            "asAppraisalId": "123456",
            "assignee": [
                "** --------------- Example #1 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com",
                    "type": "appraiser"
                },
                "** --------------- Example #2 --------------- **",
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "status": "approved",
                    "companyName": "ABC Company",
                    "email": "john.hancock@gmail.com",
                    "address1": "1234 Some Street",
                    "address2": "Suite 200",
                    "city": "Baltimore",
                    "state": {
                        "code": "CA",
                        "name": "California"
                    },
                    "zip": "21209",
                    "phone": "(410)123-4567",
                    "fax": "(410)123-4567",
                    "lenders": "ABC Lender",
                    "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                    "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                    "type": "amc"
                }
            ],
            "company": {
                "id": 83,
                "name": "Best Appraisers Co.",
                "firstName": "John",
                "lastName": "White",
                "email": "appraisers@company.com",
                "phone": "(505) 242-2221",
                "fax": "(505) 242-5522",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "zip": "94333",
                "assignmentZip": "76901",
                "state": {
                    "code": "CA",
                    "name": "California"
                },
                "w9": {
                    "id": 242,
                    "name": "test.pdf",
                    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                    "size": 14512415,
                    "format": "pdf",
                    "uploadedAt": "2016-04-21T07:51:59+00:00",
                    "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                },
                "taxId": "00-0000000",
                "type": "c-corporation",
                "otherType": "Other company type",
                "eo": {
                    "document": {
                        "id": 242,
                        "name": "test.pdf",
                        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                        "size": 14512415,
                        "format": "pdf",
                        "uploadedAt": "2016-04-21T07:51:59+00:00",
                        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                    },
                    "claimAmount": 2999.01,
                    "aggregateAmount": 2999.01,
                    "expiresAt": "2016-04-21T07:51:59+00:00",
                    "carrier": "AT&T",
                    "deductible": 442.99
                },
                "ach": {
                    "bankName": "ABC Bank",
                    "accountType": "checking",
                    "accountNumber": "1234567890",
                    "routing": "123456789"
                }
            },
            "loanAmount": 33.01,
            "lienPosition": "first",
            "valueQualifiers": [
                "as-is",
                "subject-to-completed"
            ],
            "subAssignees": [
                {
                    "id": 424,
                    "username": "johnhancock",
                    "displayName": "John Hancock",
                    "firstName": "Hancock",
                    "lastName": "Hancock",
                    "email": "john.hancock@gmail.com"
                }
            ],
            "paymentMethod": null,
            "hasCreditCardInfo": false,
            "clientFee": 30.12,
            "orderedBy": {
                "id": 131,
                "firstName": "John",
                "lastName": "Week",
                "email": "appraiser@gmail.com",
                "phone": "(410)123-4567",
                "role": "processor",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "state": "CA",
                "zip": "76901",
                "branchName": "Branching Branch"
            },
            "submittedBy": {
                "id": 131,
                "firstName": "John",
                "lastName": "Week",
                "email": "appraiser@gmail.com",
                "phone": "(410)123-4567",
                "role": "investor",
                "address1": "422 Long Rd.",
                "address2": "422H Long Rd.",
                "city": "San Francisco",
                "state": "CA",
                "zip": "76901",
                "branchName": "Branching Branch"
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 1000,
            "perPage": 10,
            "page": 31,
            "totalPages": 100
        }
    }
}

GET /amcs/{amcId}/settings Gets settings

Response

Code: 200

Name Type Reference
body object N/A
- pushUrl string N/A

Example:

{
    "pushUrl": "https:\/\/stage.valuepad.com\/valuepad-pushes"
}

PATCH /amcs/{amcId}/settings Updates settings

Request

Name Type Reference
body object N/A
- pushUrl string N/A

Example:

{
    "pushUrl": "https:\/\/stage.valuepad.com\/valuepad-pushes"
}

Response

Code: 204

GET /appraisers Gets all appraisers

Request

Parameters

Name Type Reference
filter.jobTypes int[] N/A
filter.licenses.certifications enum[] Certification Enum
filter.licenses.coverage.county int N/A
filter.licenses.coverage.zips string N/A
filter.licenses.state string N/A
filter.qualifications.coopQualified bool N/A
filter.qualifications.deskReviewQualified bool N/A
filter.qualifications.envCapable bool N/A
filter.qualifications.fieldReviewQualified bool N/A
filter.qualifications.jumboQualified bool N/A
filter.qualifications.loan203KQualified bool N/A
filter.qualifications.newConstructionQualified bool N/A
filter.qualifications.primaryLicense.certifications enum[] Certification Enum
filter.qualifications.relocationQualified bool N/A
filter.qualifications.reoQualified bool N/A
filter.qualifications.usdaQualified bool N/A
filter.qualifications.vaQualified bool N/A
filter.qualifications.yearsLicensed int N/A
page int N/A
perPage int N/A
search.companyName string N/A
search.firstName string N/A
search.fullName string N/A
search.lastName string N/A
search.qualifications.primaryLicense.isFhaApproved bool N/A
search.qualifications.primaryLicense.number string N/A
search.state string N/A
search.zip string N/A

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Appraiser Object
- meta object N/A
- - pagination object Pagination Object

Example:

{
    "data": [
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com"
        }
    ],
    "meta": {
        "pagination": {
            "total": 1000,
            "perPage": 10,
            "page": 31,
            "totalPages": 100
        }
    }
}

GET /appraisers/{appraiserId} Gets an appraiser

Response

Code: 200

Name Type Reference
body object Appraiser Object

Example:

{
    "id": 424,
    "username": "johnhancock",
    "displayName": "John Hancock",
    "firstName": "Hancock",
    "lastName": "Hancock",
    "email": "john.hancock@gmail.com",
    "status": null,
    "isRegistered": true,
    "showInitialDisplay": false,
    "availability": {
        "isOnVacation": true,
        "from": "2016-04-21T07:51:59+00:00",
        "to": "2016-04-26T07:51:59+00:00",
        "message": "Will be back after vacation!"
    },
    "companyName": "Appraisal ABC",
    "businessTypes": [
        "certified-minority",
        "hub-zone-small-business",
        "small-business"
    ],
    "companyType": "c-corporation",
    "otherCompanyType": "Large Business",
    "taxIdentificationNumber": "442-22-5522",
    "w9": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "languages": [
        {
            "code": "en",
            "name": "English"
        }
    ],
    "licenses": [
        {
            "id": 52,
            "isPrimary": true,
            "number": "AAABBB2345",
            "certifications": [],
            "isFhaApproved": false,
            "isCommercial": true,
            "expiresAt": "2016-04-21T07:51:59+00:00",
            "document": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "state": {
                "code": "CA",
                "name": "California"
            },
            "coverage": [
                {
                    "county": {
                        "id": 42,
                        "title": "BRISTOL BAY"
                    },
                    "zips": [
                        "94132",
                        "94108"
                    ]
                }
            ]
        }
    ],
    "address1": "342 Edison Str.",
    "address2": "342A Edison Str.",
    "city": "New York",
    "state": {
        "code": "CA",
        "name": "California"
    },
    "zip": "91202",
    "assignmentAddress1": "342 Edison Str.",
    "assignmentAddress2": "342A Edison Str.",
    "assignmentCity": "New York",
    "assignmentState": {
        "code": "CA",
        "name": "California"
    },
    "assignmentZip": "91202",
    "phone": "(707) 553-2422",
    "cell": "(707) 553-2422",
    "fax": "(707) 553-2422",
    "qualifications": {
        "primaryLicense": {
            "id": 52,
            "isPrimary": true,
            "number": "AAABBB2345",
            "certifications": [],
            "isFhaApproved": false,
            "isCommercial": true,
            "expiresAt": "2016-04-21T07:51:59+00:00",
            "document": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "state": {
                "code": "CA",
                "name": "California"
            },
            "coverage": [
                {
                    "county": {
                        "id": 42,
                        "title": "BRISTOL BAY"
                    },
                    "zips": [
                        "94132",
                        "94108"
                    ]
                }
            ]
        },
        "yearsLicensed": 20,
        "certifiedAt": {
            "month": 10,
            "year": 2001
        },
        "vaQualified": false,
        "fhaQualified": false,
        "relocationQualified": true,
        "usdaQualified": true,
        "coopQualified": true,
        "jumboQualified": true,
        "newConstructionQualified": false,
        "newConstructionExperienceInYears": 2,
        "numberOfNewConstructionCompleted": 6,
        "isNewConstructionCourseCompleted": true,
        "isFamiliarWithFullScopeInNewConstruction": false,
        "loan203KQualified": false,
        "manufacturedHomeQualified": true,
        "reoQualified": true,
        "deskReviewQualified": false,
        "fieldReviewQualified": false,
        "envCapable": false,
        "commercialQualified": false,
        "commercialExpertise": [
            "land",
            "multi-family",
            "office"
        ],
        "otherCommercialExpertise": "skyscraper",
        "resume": {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        }
    },
    "eo": {
        "document": {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        },
        "claimAmount": 2999.01,
        "aggregateAmount": 2999.01,
        "expiresAt": "2016-04-21T07:51:59+00:00",
        "carrier": "AT&T",
        "deductible": 442.99,
        "question1": true,
        "question1Explanation": "Some comment",
        "question1Document": {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        },
        "question2": true,
        "question2Explanation": "Some comment",
        "question3": true,
        "question3Explanation": "Some comment",
        "question4": true,
        "question4Explanation": "Some comment",
        "question5": true,
        "question5Explanation": "Some comment",
        "question6": true,
        "question6Explanation": "Some comment",
        "question7": false,
        "question7Explanation": "Some comment"
    },
    "sampleReports": [
        {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        }
    ],
    "signature": "chuck",
    "signedAt": "2016-04-21T07:51:59+00:00"
}

GET /asc Gets all appraisers from the asc database

Request

Parameters

Name Type Reference
filter.isTied bool N/A
filter.state string N/A
page int N/A
perPage int N/A
search.licenseNumber string N/A

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Asc Appraiser Object
- meta object N/A
- - pagination object Pagination Object

Example:

{
    "data": [
        {
            "id": 49,
            "firstName": "John",
            "lastName": "Hancock",
            "licenseState": {
                "code": "CA",
                "name": "California"
            },
            "licenseNumber": "ABC-123",
            "licenseExpiresAt": "2016-04-21T07:51:59+00:00",
            "certifications": [
                "licensed",
                "certified-general"
            ],
            "companyName": "ABC Company",
            "address": "1234 Some Street",
            "state": {
                "code": "CA",
                "name": "California"
            },
            "zip": "21209",
            "phone": "(410)123-4567",
            "appraiser": {
                "id": 49
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 1000,
            "perPage": 10,
            "page": 31,
            "totalPages": 100
        }
    }
}

GET /customers/{customerId}/settings Gets settings

Response

Code: 200

Name Type Reference
body object Customer Settings Object

Example:

{
    "pushUrl": "https:\/\/stage.valuepad.com\/valuepad-pushes",
    "daysPriorInspectionDate": 2,
    "daysPriorEstimatedCompletionDate": 3,
    "preventViolationOfDateRestrictions": "warning",
    "disallowChangeJobTypeFees": false,
    "showClientToAppraiser": true,
    "showDocumentsToAppraiser": false,
    "canAppraiserChangeJobTypeFees": true,
    "isSmsEnabled": true,
    "unacceptedReminder": 2,
    "showClientFeeToAppraiser": false,
    "shareOrderedForDetailsWithAmc": false
}

POST /documents Creates a document

Request

Name Type Reference
body object Document Persistable

Example:

{
    "document": null
}

Response

Code: 200

Name Type Reference
body object Document Object

Example:

{
    "id": 242,
    "name": "test.pdf",
    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
    "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
    "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
    "size": 14512415,
    "format": "pdf",
    "uploadedAt": "2016-04-21T07:51:59+00:00",
    "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
}

POST /help/feature-requests Create an issue

Request

Name Type Reference
body object N/A
- description string N/A

Example:

{
    "description": "I got an idea"
}

Response

Code: 204

POST /help/hints Requests username(s) and reset password(s) for account(s) related to the provided email address

Request

Name Type Reference
body object N/A
- email string N/A

Example:

{
    "email": "jackie.chan@gmail.com"
}

Response

Code: 204

POST /help/issues Create an issue

Request

Name Type Reference
body object N/A
- description string N/A

Example:

{
    "description": "I got an issue"
}

Response

Code: 204

GET /job-types Gets all job types

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Job Type Object
- meta object N/A
- - pagination object Pagination Object

Example:

{
    "data": [
        {
            "id": 131,
            "title": "URAR(303)"
        }
    ],
    "meta": {
        "pagination": {
            "total": 1000,
            "perPage": 10,
            "page": 31,
            "totalPages": 100
        }
    }
}

GET /languages Gets all languages

Response

Code: 200

Name Type Reference
body object N/A
- data object[] Language Object

Example:

{
    "data": [
        {
            "code": "en",
            "name": "English"
        }
    ]
}

GET /location/states Gets all states

Response

Code: 200

Name Type Reference
body object N/A
- data object[] State Object

Example:

{
    "data": [
        {
            "code": "CA",
            "name": "California"
        }
    ]
}

GET /location/states/{stateCode}/counties Gets all counties for a specific state

Request

Parameters

Name Type Reference
filter.counties string N/A

Response

Code: 200

Name Type Reference
body object N/A
- data object[] County Object

Example:

{
    "data": [
        {
            "id": 42,
            "title": "BRISTOL BAY"
        }
    ]
}

GET /location/states/{stateCode}/counties/{countyId} Gets a county

Response

Code: 200

Name Type Reference
body object County Object

Example:

{
    "id": 42,
    "title": "BRISTOL BAY",
    "state": {
        "code": "CA",
        "name": "California"
    },
    "zips": [
        "94132",
        "94102"
    ]
}

GET /location/states/{stateCode}/zips Gets all zips for a specified state

Response

Code: 200

Name Type Reference
body object N/A
- data string[] N/A

Example:

{
    "data": [
        "45242",
        "77316"
    ]
}

POST /password/change Change the password with the token

Request

Name Type Reference
body object N/A
- token string N/A
- password string N/A

Example:

{
    "token": "421552fwfw",
    "password": "my_new_password"
}

Response

Code: 200

POST /password/reset Send an email to reset the password

Request

Name Type Reference
body object N/A
- username string N/A

Example:

{
    "username": "john52"
}

Response

Code: 200

POST /sessions Re-generate a new session and retrieve it

Request

Name Type Reference
body object N/A
- username string N/A
- password string N/A

Example:

{
    "username": "my_username",
    "password": "my_password"
}

Response

Code: 200

Name Type Reference
body object Session Object

Example:

{
    "id": 49,
    "token": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
    "user": [
        "** --------------- Example #1 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "name": "ABC Company",
            "companyType": "bank-lender",
            "type": "customer"
        },
        "** --------------- Example #2 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com",
            "type": "appraiser"
        },
        "** --------------- Example #3 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "status": "approved",
            "companyName": "ABC Company",
            "email": "john.hancock@gmail.com",
            "address1": "1234 Some Street",
            "address2": "Suite 200",
            "city": "Baltimore",
            "state": {
                "code": "CA",
                "name": "California"
            },
            "zip": "21209",
            "phone": "(410)123-4567",
            "fax": "(410)123-4567",
            "lenders": "ABC Lender",
            "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
            "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
            "type": "amc"
        }
    ],
    "createdAt": "2016-04-20T07:51:59+00:00",
    "expireAt": "2016-04-21T07:51:59+00:00"
}

POST /sessions/auto-login-tokens Generates an auto-login token

Response

Code: 200

GET /sessions/{sessionId} Gets a session by id

Response

Code: 200

DELETE /sessions/{sessionId} Deletes a session by id

Response

Code: 204

POST /sessions/{sessionId}/refresh Refreshes a session

Request

Name Type Reference
body object N/A
- user int N/A

Example:

{
    "user": 51
}

Response

Code: 200

Name Type Reference
body object N/A
- token string N/A

Example:

{
    "token": "12token5632"
}

DELETE /sessions?user={userId} Deletes all sessions by user id

Response

Code: 204

POST /users/{userId}/devices Registers a device

Request

Name Type Reference
body object Device Persistable

Example:

{
    "token": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
    "platform": "ios"
}

Response

Code: 200

Name Type Reference
body object Device Object

Example:

{
    "id": 242,
    "token": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
    "platform": "ios",
    "user": {
        "id": 424,
        "username": "johnhancock",
        "displayName": "John Hancock",
        "type": "appraiser"
    }
}

DELETE /users/{userId}/devices/{deviceId} Unregisters a device

Response

Code: 204

GET /users/{username} Check username availability

Response

Code: 200

Standard Objects

Here you will find all of the standard objects available.

ACH Object

Properties:

Name Type Reference
bankName string N/A
accountType enum ACH Account Type Enum
accountNumber string N/A
routing string N/A

Example:

{
    "bankName": "ABC Bank",
    "accountType": "checking",
    "accountNumber": "1234567890",
    "routing": "123456789"
}

AMC Invoice Item Object

Properties:

Name Type Reference
id int N/A
fileNumber string N/A
loanNumber string N/A
address string N/A
jobType string N/A
borrowerName string N/A
amount string N/A
orderedAt datetime N/A
completedAt datetime N/A

Example:

{
    "id": 49,
    "fileNumber": "1234",
    "loanNumber": "4567",
    "address": "1234 Some Street",
    "jobType": "1004 URAR",
    "borrowerName": "John Hancock",
    "amount": "49.99",
    "orderedAt": "2016-04-20T07:51:59+00:00",
    "completedAt": "2016-04-21T07:51:59+00:00"
}

AMC Invoice Object

Properties:

Name Type Reference
id int N/A
isPaid bool N/A
items object[] AMC Invoice Item Object
document object Document Object
amount float N/A
from datetime N/A
to datetime N/A
createdAt datetime N/A

Example:

{
    "id": 49,
    "isPaid": true,
    "items": [
        {
            "id": 49,
            "fileNumber": "1234",
            "loanNumber": "4567",
            "address": "1234 Some Street",
            "jobType": "1004 URAR",
            "borrowerName": "John Hancock",
            "amount": "49.99",
            "orderedAt": "2016-04-20T07:51:59+00:00",
            "completedAt": "2016-04-21T07:51:59+00:00"
        }
    ],
    "document": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "amount": 49.99,
    "from": "2016-04-21T07:51:59+00:00",
    "to": "2016-04-22T07:51:59+00:00",
    "createdAt": "2016-04-20T07:51:59+00:00"
}

AMC Job Type Fee By County Object

Properties:

Name Type Reference
county object County Object
amount float N/A

Example:

{
    "county": {
        "id": 42,
        "title": "BRISTOL BAY"
    },
    "amount": 49.99
}

AMC Job Type Fee By County Persistable

Properties:

Name Type Reference
county int N/A
amount float N/A

Example:

{
    "county": 49,
    "amount": 49.99
}

AMC Job Type Fee By State Object

Properties:

Name Type Reference
state object State Object
amount float N/A

Example:

{
    "state": {
        "code": "CA",
        "name": "California"
    },
    "amount": 49.99
}

AMC Job Type Fee By State Persistable

Properties:

Name Type Reference
state string N/A
amount float N/A
applyStateAmountToAllCounties bool N/A
applyStateAmountToAllZips bool N/A

Example:

{
    "state": "MD",
    "amount": 49.99,
    "applyStateAmountToAllCounties": false,
    "applyStateAmountToAllZips": true
}

AMC Job Type Fee By Zip Object

Properties:

Name Type Reference
zip string N/A
amount float N/A

Example:

{
    "zip": "21209",
    "amount": 49.99
}

AMC Job Type Fee By Zip Persistable

Properties:

Name Type Reference
zip string N/A
amount float N/A

Example:

{
    "zip": "21209",
    "amount": 49.99
}

AMC Job Type Fee Object

Properties:

Name Type Reference
jobType object Job Type Object
qualifier enum AMC Job Type Fee Qualifier Enum
amount float N/A

Example:

{
    "jobType": {
        "id": 131,
        "title": "URAR(303)"
    },
    "qualifier": "state",
    "amount": 49.99
}

AMC Job Type Fee Persistable

Properties:

Name Type Reference
jobType int N/A
qualifier enum AMC Job Type Fee Qualifier Enum
amount float N/A

Example:

{
    "jobType": 21,
    "qualifier": "state",
    "amount": 49.99
}

AMC License Object

Properties:

Name Type Reference
id int N/A
number string N/A
expiresAt datetime N/A
document object Document Object
state object State Object
coverage object[] N/A
- county object County Object
- zips string[] N/A
alias object N/A
- companyName string N/A
- address1 string N/A
- address2 string N/A
- city string N/A
- state object State Object
- zip string N/A
- phone string N/A
- fax string N/A
- email string N/A

Example:

{
    "id": 49,
    "number": "23423432",
    "expiresAt": "2016-04-21T07:51:59+00:00",
    "document": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "state": {
        "code": "CA",
        "name": "California"
    },
    "coverage": [
        {
            "county": {
                "id": 42,
                "title": "BRISTOL BAY"
            },
            "zips": [
                "94132",
                "94108"
            ]
        }
    ],
    "alias": {
        "companyName": "DEF Company",
        "address1": "5678 X Avenue",
        "address2": "Y Building",
        "city": "Los Angeles",
        "state": {
            "code": "CA",
            "name": "California"
        },
        "zip": "90210",
        "phone": "(888)807-2111",
        "fax": "(888)807-2112",
        "email": "def@company.biz"
    }
}

AMC License Persistable

Properties:

Name Type Reference
number string N/A
state string N/A
expiresAt datetime N/A
document mixed N/A
int N/A
- OR -
object Document Identifier Persistable
coverage object[] N/A
- county int N/A
- zips string[] N/A
alias object N/A
- companyName string N/A
- address1 string N/A
- address2 string N/A
- city string N/A
- state string N/A
- zip string N/A
- phone string N/A
- fax string N/A
- email string N/A

Example:

{
    "number": "24323235",
    "state": "MD",
    "expiresAt": "2016-04-21T07:51:59+00:00",
    "document": [
        "** --------------- Example #1 --------------- **",
        21,
        "** --------------- Example #2 --------------- **",
        {
            "id": 10,
            "token": "58IKsPHGJNDwUnOOjHJtPT6ZlSv14hwkPEhAKbGMhiZ1tcZuPSlqnhh4Z88LWKgl"
        }
    ],
    "coverage": [
        {
            "county": 49,
            "zips": [
                "21209",
                "21804"
            ]
        }
    ],
    "alias": {
        "companyName": "DEF Company",
        "address1": "5678 X Avenue",
        "address2": "Y Building",
        "city": "Los Angeles",
        "state": "CA",
        "zip": "90210",
        "phone": "(888)807-2111",
        "fax": "(888)807-2112",
        "email": "def@company.biz"
    }
}

AMC Object

Parent: User Object

Properties:

Name Type Reference
status enum User Status Enum
companyName string N/A
email string N/A
address1 string N/A
address2 string N/A
city string N/A
state object State Object
zip string N/A
phone string N/A
fax string N/A
lenders string N/A
secret1 string N/A
secret2 string N/A

Example:

{
    "id": 424,
    "username": "johnhancock",
    "displayName": "John Hancock",
    "status": "approved",
    "companyName": "ABC Company",
    "email": "john.hancock@gmail.com",
    "address1": "1234 Some Street",
    "address2": "Suite 200",
    "city": "Baltimore",
    "state": {
        "code": "CA",
        "name": "California"
    },
    "zip": "21209",
    "phone": "(410)123-4567",
    "fax": "(410)123-4567",
    "lenders": "ABC Lender",
    "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
    "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL"
}

AMC Persistable

Parent: User Persistable

Properties:

Name Type Reference
status enum User Status Enum
companyName string N/A
email string N/A
address1 string N/A
address2 string N/A
city string N/A
state string N/A
zip string N/A
phone string N/A
fax string N/A
lenders string N/A

Example:

{
    "username": "johnhancock",
    "password": "12345",
    "status": "approved",
    "companyName": "ABC Company",
    "email": "john.hancock@gmail.com",
    "address1": "1234 Some Street",
    "address2": "Suite 200",
    "city": "Baltimore",
    "state": "MD",
    "zip": "21209",
    "phone": "(410)123-4567",
    "fax": "(410)123-4567",
    "lenders": "ABC Lender"
}

Additional Status Object

Properties:

Name Type Reference
id int N/A
title string N/A
comment string N/A

Example:

{
    "id": 131,
    "title": "Waiting for client",
    "comment": "Some text"
}

Appraiser Object

Parent: User Object

Properties:

Name Type Reference
firstName string N/A
lastName string N/A
email string N/A
status* enum User Status Enum
isRegistered* bool N/A
showInitialDisplay* bool N/A
availability* object Availability Object
companyName* string N/A
businessTypes* enum[] Business Type Enum
companyType* enum Company Type Enum
otherCompanyType* string N/A
taxIdentificationNumber*
(either ssn or tax id formats) 		string N/A
w9* object Document Object
languages* object[] Language Object
licenses* object[] License Object
address1* string N/A
address2* string N/A
city* string N/A
state* object State Object
zip* string N/A
assignmentAddress1* string N/A
assignmentAddress2* string N/A
assignmentCity* string N/A
assignmentState* object State Object
assignmentZip* string N/A
phone* string N/A
cell* string N/A
fax* string N/A
qualifications* object N/A
- primaryLicense object License Object
- yearsLicensed int N/A
- certifiedAt object N/A
- - month int N/A
- - year int N/A
- vaQualified bool N/A
- fhaQualified bool N/A
- relocationQualified bool N/A
- usdaQualified bool N/A
- coopQualified bool N/A
- jumboQualified bool N/A
- newConstructionQualified bool N/A
- newConstructionExperienceInYears int N/A
- numberOfNewConstructionCompleted int N/A
- isNewConstructionCourseCompleted bool N/A
- isFamiliarWithFullScopeInNewConstruction bool N/A
- loan203KQualified bool N/A
- manufacturedHomeQualified bool N/A
- reoQualified bool N/A
- deskReviewQualified bool N/A
- fieldReviewQualified bool N/A
- envCapable bool N/A
- commercialQualified bool N/A
- commercialExpertise enum[] Commercial Expertise Enum
- otherCommercialExpertise string N/A
- resume object Document Object
eo* object (extends Eo Object) N/A
- question1
(Within the last ten (10) years, have you been the subject of any disciplinary or corrective action by an appraisal organization, state licensing board or other regulatory body of a governmental entity as a result of your) 		bool N/A
- question1Explanation string N/A
- question1Document object Document Object
- question2
(Have you been notified of any investigation or review open at this time by any appraisal organization, state licensing board or other regulatory body of a governmental entity?) 		bool N/A
- question2Explanation string N/A
- question3
(Have you ever been convicted of a felony, or arrested, indicted, or charged with felonious misconduct? If yes, please provide a written narrative of events.) 		bool N/A
- question3Explanation string N/A
- question4
(In the last ten (10) years, have any lawsuits or claims (including notice of a potential claim) been made or filed against you? This includes lawsuits or claims, regardless if they were tendered to an insurance company for coverage.) 		bool N/A
- question4Explanation string N/A
- question5
(Are you aware of any circumstances that may lead to the filing of a lawsuit or claim against you?) 		bool N/A
- question5Explanation string N/A
- question6
(To your knowledge are you or any Appraiser associated with the firm included on any government agency, Fannie Mae, Freddie Mac or Lender Exclusionary List?) 		bool N/A
- question6Explanation string N/A
- question7
(Have you had any disciplinary actions against you or your company from a state or federal licensing board as it relates to your appraisal license(s) or appraisals performed?) 		bool N/A
- question7Explanation string N/A
sampleReports* object[] Document Object
signature* string N/A
signedAt* datetime N/A

Example:

{
    "id": 424,
    "username": "johnhancock",
    "displayName": "John Hancock",
    "firstName": "Hancock",
    "lastName": "Hancock",
    "email": "john.hancock@gmail.com",
    "status": null,
    "isRegistered": true,
    "showInitialDisplay": false,
    "availability": {
        "isOnVacation": true,
        "from": "2016-04-21T07:51:59+00:00",
        "to": "2016-04-26T07:51:59+00:00",
        "message": "Will be back after vacation!"
    },
    "companyName": "Appraisal ABC",
    "businessTypes": [
        "certified-minority",
        "hub-zone-small-business",
        "small-business"
    ],
    "companyType": "c-corporation",
    "otherCompanyType": "Large Business",
    "taxIdentificationNumber": "442-22-5522",
    "w9": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "languages": [
        {
            "code": "en",
            "name": "English"
        }
    ],
    "licenses": [
        {
            "id": 52,
            "isPrimary": true,
            "number": "AAABBB2345",
            "certifications": [],
            "isFhaApproved": false,
            "isCommercial": true,
            "expiresAt": "2016-04-21T07:51:59+00:00",
            "document": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "state": {
                "code": "CA",
                "name": "California"
            },
            "coverage": [
                {
                    "county": {
                        "id": 42,
                        "title": "BRISTOL BAY"
                    },
                    "zips": [
                        "94132",
                        "94108"
                    ]
                }
            ]
        }
    ],
    "address1": "342 Edison Str.",
    "address2": "342A Edison Str.",
    "city": "New York",
    "state": {
        "code": "CA",
        "name": "California"
    },
    "zip": "91202",
    "assignmentAddress1": "342 Edison Str.",
    "assignmentAddress2": "342A Edison Str.",
    "assignmentCity": "New York",
    "assignmentState": {
        "code": "CA",
        "name": "California"
    },
    "assignmentZip": "91202",
    "phone": "(707) 553-2422",
    "cell": "(707) 553-2422",
    "fax": "(707) 553-2422",
    "qualifications": {
        "primaryLicense": {
            "id": 52,
            "isPrimary": true,
            "number": "AAABBB2345",
            "certifications": [],
            "isFhaApproved": false,
            "isCommercial": true,
            "expiresAt": "2016-04-21T07:51:59+00:00",
            "document": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "state": {
                "code": "CA",
                "name": "California"
            },
            "coverage": [
                {
                    "county": {
                        "id": 42,
                        "title": "BRISTOL BAY"
                    },
                    "zips": [
                        "94132",
                        "94108"
                    ]
                }
            ]
        },
        "yearsLicensed": 20,
        "certifiedAt": {
            "month": 10,
            "year": 2001
        },
        "vaQualified": false,
        "fhaQualified": false,
        "relocationQualified": true,
        "usdaQualified": true,
        "coopQualified": true,
        "jumboQualified": true,
        "newConstructionQualified": false,
        "newConstructionExperienceInYears": 2,
        "numberOfNewConstructionCompleted": 6,
        "isNewConstructionCourseCompleted": true,
        "isFamiliarWithFullScopeInNewConstruction": false,
        "loan203KQualified": false,
        "manufacturedHomeQualified": true,
        "reoQualified": true,
        "deskReviewQualified": false,
        "fieldReviewQualified": false,
        "envCapable": false,
        "commercialQualified": false,
        "commercialExpertise": [
            "land",
            "multi-family",
            "office"
        ],
        "otherCommercialExpertise": "skyscraper",
        "resume": {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        }
    },
    "eo": {
        "document": {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        },
        "claimAmount": 2999.01,
        "aggregateAmount": 2999.01,
        "expiresAt": "2016-04-21T07:51:59+00:00",
        "carrier": "AT&T",
        "deductible": 442.99,
        "question1": true,
        "question1Explanation": "Some comment",
        "question1Document": {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        },
        "question2": true,
        "question2Explanation": "Some comment",
        "question3": true,
        "question3Explanation": "Some comment",
        "question4": true,
        "question4Explanation": "Some comment",
        "question5": true,
        "question5Explanation": "Some comment",
        "question6": true,
        "question6Explanation": "Some comment",
        "question7": false,
        "question7Explanation": "Some comment"
    },
    "sampleReports": [
        {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        }
    ],
    "signature": "chuck",
    "signedAt": "2016-04-21T07:51:59+00:00"
}

Asc Appraiser Object

Properties:

Name Type Reference
id int N/A
firstName string N/A
lastName string N/A
licenseState object State Object
licenseNumber string N/A
licenseExpiresAt datetime N/A
certifications enum[] Certification Enum
companyName string N/A
address string N/A
state object State Object
zip string N/A
phone string N/A
appraiser object N/A
- id int N/A

Example:

{
    "id": 49,
    "firstName": "John",
    "lastName": "Hancock",
    "licenseState": {
        "code": "CA",
        "name": "California"
    },
    "licenseNumber": "ABC-123",
    "licenseExpiresAt": "2016-04-21T07:51:59+00:00",
    "certifications": [
        "licensed",
        "certified-general"
    ],
    "companyName": "ABC Company",
    "address": "1234 Some Street",
    "state": {
        "code": "CA",
        "name": "California"
    },
    "zip": "21209",
    "phone": "(410)123-4567",
    "appraiser": {
        "id": 49
    }
}

Assignee Order Document Formats Object

Properties:

Name Type Reference
primary enum[] Order Document Format Enum
extra enum[] Order Document Extra Format Enum

Example:

{
    "primary": [
        "pdf",
        "xml"
    ],
    "extra": [
        "aci",
        "env"
    ]
}

Availability Object

Properties:

Name Type Reference
isOnVacation bool N/A
from datetime N/A
to datetime N/A
message string N/A

Example:

{
    "isOnVacation": true,
    "from": "2016-04-21T07:51:59+00:00",
    "to": "2016-04-26T07:51:59+00:00",
    "message": "Will be back after vacation!"
}

Bank Account Object

Properties:

Name Type Reference
accountType enum Bank Account Type Enum
routingNumber string N/A
accountNumber string N/A
nameOnAccount string N/A
bankName string N/A
address string N/A
city string N/A
zip string N/A
state object State Object

Example:

{
    "accountType": "checking",
    "routingNumber": "123456789",
    "accountNumber": "1234567890",
    "nameOnAccount": "John Hancock",
    "bankName": "ABC Bank",
    "address": "124 Market Str.",
    "city": "San Francisco",
    "zip": "94102",
    "state": {
        "code": "CA",
        "name": "California"
    }
}

Bank Account Persistable

Properties:

Name Type Reference
accountType enum Bank Account Type Enum
routingNumber string N/A
accountNumber string N/A
nameOnAccount string N/A
bankName string N/A
address string N/A
city string N/A
zip string N/A
state string N/A

Example:

{
    "accountType": "checking",
    "routingNumber": "123456789",
    "accountNumber": "1234567890",
    "nameOnAccount": "John Hancock",
    "bankName": "ABC Bank",
    "address": "124 Market Str.",
    "city": "San Francisco",
    "zip": "94102",
    "state": "OR"
}

Bid Object

Properties:

Name Type Reference
amount float N/A
estimatedCompletionDate datetime N/A
comments string N/A
appraisers object[] Appraiser Object

Example:

{
    "amount": 49.99,
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "comments": "Additional comment here.",
    "appraisers": [
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com"
        }
    ]
}

Bid Persistable

Properties:

Name Type Reference
amount float N/A
estimatedCompletionDate datetime N/A
comments string N/A
appraisers int[] N/A

Example:

{
    "amount": 49.99,
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "comments": "Additional comment here.",
    "appraisers": [
        3,
        42
    ]
}

Change Additional Status Persistable

Properties:

Name Type Reference
additionalStatus int N/A
comment string N/A

Example:

{
    "additionalStatus": 49,
    "comment": "Some text"
}

Client Object

Properties:

Name Type Reference
id int N/A
address1* string N/A
address2* string N/A
city* string N/A
state* object State Object
zip* string N/A

Example:

{
    "id": 131,
    "address1": "342 Edison Str.",
    "address2": "342A Edison Str.",
    "city": "New York",
    "state": {
        "code": "CA",
        "name": "California"
    },
    "zip": "91202"
}

Client User Object

Properties:

Name Type Reference
id int N/A
firstName string N/A
lastName string N/A
email string N/A
phone string N/A
role string N/A
address1 string N/A
address2 string N/A
city string N/A
state string N/A
zip string N/A
branchName string N/A

Example:

{
    "id": 131,
    "firstName": "John",
    "lastName": "Week",
    "email": "appraiser@gmail.com",
    "phone": "(410)123-4567",
    "role": "processor",
    "address1": "422 Long Rd.",
    "address2": "422H Long Rd.",
    "city": "San Francisco",
    "state": "CA",
    "zip": "76901",
    "branchName": "Branching Branch"
}

Company Object

Properties:

Name Type Reference
id int N/A
name string N/A
firstName string N/A
lastName string N/A
email string N/A
phone string N/A
fax string N/A
address1 string N/A
address2 string N/A
city string N/A
zip string N/A
assignmentZip string N/A
state object State Object
w9 object Document Object
taxId string N/A
type enum Company Type Enum
otherType string N/A
eo object Eo Object
ach object ACH Object
staff object Staff Object

Example:

{
    "id": 83,
    "name": "Best Appraisers Co.",
    "firstName": "John",
    "lastName": "White",
    "email": "appraisers@company.com",
    "phone": "(505) 242-2221",
    "fax": "(505) 242-5522",
    "address1": "422 Long Rd.",
    "address2": "422H Long Rd.",
    "city": "San Francisco",
    "zip": "94333",
    "assignmentZip": "76901",
    "state": {
        "code": "CA",
        "name": "California"
    },
    "w9": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "taxId": "00-0000000",
    "type": "c-corporation",
    "otherType": "Other company type",
    "eo": {
        "document": {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        },
        "claimAmount": 2999.01,
        "aggregateAmount": 2999.01,
        "expiresAt": "2016-04-21T07:51:59+00:00",
        "carrier": "AT&T",
        "deductible": 442.99
    },
    "ach": {
        "bankName": "ABC Bank",
        "accountType": "checking",
        "accountNumber": "1234567890",
        "routing": "123456789"
    }
}

Conditions Object

Properties:

Name Type Reference
request enum Conditions Request Enum
fee float N/A
dueDate datetime N/A
explanation string N/A

Example:

{
    "request": "fee-increase",
    "fee": 49.99,
    "dueDate": "2016-04-21T07:51:59+00:00",
    "explanation": "New conditions."
}

Conditions Persistable

Properties:

Name Type Reference
request enum Conditions Request Enum
fee float N/A
dueDate datetime N/A
explanation string N/A

Example:

{
    "request": "fee-increase",
    "fee": 49.99,
    "dueDate": "2016-04-21T07:51:59+00:00",
    "explanation": "New conditions."
}

County Object

Properties:

Name Type Reference
id int N/A
title string N/A
state* object State Object
zips* string[] N/A

Example:

{
    "id": 42,
    "title": "BRISTOL BAY",
    "state": {
        "code": "CA",
        "name": "California"
    },
    "zips": [
        "94132",
        "94102"
    ]
}

Customer Job Type Fee Object

Properties:

Name Type Reference
id int N/A
jobType object Customer Job Type Object
amount float N/A

Example:

{
    "id": 49,
    "jobType": {
        "id": 131,
        "title": "URAR(303)",
        "isCommercial": false,
        "local": {
            "id": 131,
            "title": "URAR(303)"
        },
        "isPayable": true
    },
    "amount": 49.99
}

Customer Job Type Fee Persistable

Properties:

Name Type Reference
jobType int N/A
amount float N/A

Example:

{
    "jobType": 49,
    "amount": 49.99
}

Customer Job Type Object

Properties:

Name Type Reference
id int N/A
title string N/A
isCommercial bool N/A
local object Job Type Object
isPayable bool N/A

Example:

{
    "id": 131,
    "title": "URAR(303)",
    "isCommercial": false,
    "local": {
        "id": 131,
        "title": "URAR(303)"
    },
    "isPayable": true
}

Customer Job Type Persistable

Properties:

Name Type Reference
title string N/A
isCommercial bool N/A
local int N/A
isPayable bool N/A

Example:

{
    "title": "1004R",
    "isCommercial": true,
    "local": 49,
    "isPayable": false
}

Customer Message Object

Parent: Message Object

Properties:

Name Type Reference
employee string N/A

Example:

{
    "id": 49,
    "isRead": false,
    "sender": [
        "** --------------- Example #1 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "name": "ABC Company",
            "companyType": "bank-lender",
            "type": "customer"
        },
        "** --------------- Example #2 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com",
            "type": "appraiser"
        }
    ],
    "content": "This is a sample message.",
    "order": {
        "id": 5512,
        "fileNumber": "EFG41292",
        "asAppraisalId": "123456",
        "assignee": [
            "** --------------- Example #1 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com",
                "type": "appraiser"
            },
            "** --------------- Example #2 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "status": "approved",
                "companyName": "ABC Company",
                "email": "john.hancock@gmail.com",
                "address1": "1234 Some Street",
                "address2": "Suite 200",
                "city": "Baltimore",
                "state": {
                    "code": "CA",
                    "name": "California"
                },
                "zip": "21209",
                "phone": "(410)123-4567",
                "fax": "(410)123-4567",
                "lenders": "ABC Lender",
                "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                "type": "amc"
            }
        ],
        "company": {
            "id": 83,
            "name": "Best Appraisers Co.",
            "firstName": "John",
            "lastName": "White",
            "email": "appraisers@company.com",
            "phone": "(505) 242-2221",
            "fax": "(505) 242-5522",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "zip": "94333",
            "assignmentZip": "76901",
            "state": {
                "code": "CA",
                "name": "California"
            },
            "w9": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "taxId": "00-0000000",
            "type": "c-corporation",
            "otherType": "Other company type",
            "eo": {
                "document": {
                    "id": 242,
                    "name": "test.pdf",
                    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                    "size": 14512415,
                    "format": "pdf",
                    "uploadedAt": "2016-04-21T07:51:59+00:00",
                    "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                },
                "claimAmount": 2999.01,
                "aggregateAmount": 2999.01,
                "expiresAt": "2016-04-21T07:51:59+00:00",
                "carrier": "AT&T",
                "deductible": 442.99
            },
            "ach": {
                "bankName": "ABC Bank",
                "accountType": "checking",
                "accountNumber": "1234567890",
                "routing": "123456789"
            }
        },
        "loanAmount": 33.01,
        "lienPosition": "first",
        "valueQualifiers": [
            "as-is",
            "subject-to-completed"
        ],
        "subAssignees": [
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com"
            }
        ],
        "paymentMethod": null,
        "hasCreditCardInfo": false,
        "clientFee": 30.12,
        "orderedBy": {
            "id": 131,
            "firstName": "John",
            "lastName": "Week",
            "email": "appraiser@gmail.com",
            "phone": "(410)123-4567",
            "role": "processor",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "state": "CA",
            "zip": "76901",
            "branchName": "Branching Branch"
        },
        "submittedBy": {
            "id": 131,
            "firstName": "John",
            "lastName": "Week",
            "email": "appraiser@gmail.com",
            "phone": "(410)123-4567",
            "role": "investor",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "state": "CA",
            "zip": "76901",
            "branchName": "Branching Branch"
        }
    },
    "createdAt": "2016-04-21T07:51:59+00:00",
    "employee": "John Hancock"
}

Customer Object

Parent: User Object

Properties:

Name Type Reference
name string N/A
companyType enum Customer Company Type Enum
phone* string N/A
settings* object Customer Settings Object
secret1* string N/A
secret2* string N/A

Example:

{
    "id": 424,
    "username": "johnhancock",
    "displayName": "John Hancock",
    "name": "ABC Company",
    "companyType": "bank-lender",
    "phone": "(410)123-4567",
    "settings": {
        "pushUrl": "https:\/\/stage.valuepad.com\/valuepad-pushes",
        "daysPriorInspectionDate": 2,
        "daysPriorEstimatedCompletionDate": 3,
        "preventViolationOfDateRestrictions": "warning",
        "disallowChangeJobTypeFees": false,
        "showClientToAppraiser": true,
        "showDocumentsToAppraiser": false,
        "canAppraiserChangeJobTypeFees": true,
        "isSmsEnabled": true,
        "unacceptedReminder": 2,
        "showClientFeeToAppraiser": false,
        "shareOrderedForDetailsWithAmc": false
    },
    "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
    "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL"
}

Customer Settings Object

Properties:

Name Type Reference
pushUrl string N/A
daysPriorInspectionDate int N/A
daysPriorEstimatedCompletionDate int N/A
preventViolationOfDateRestrictions enum Criticality Enum
disallowChangeJobTypeFees bool N/A
showClientToAppraiser bool N/A
showDocumentsToAppraiser bool N/A
canAppraiserChangeJobTypeFees bool N/A
isSmsEnabled bool N/A
unacceptedReminder
(Hours after assigned date) 		int N/A
showClientFeeToAppraiser bool N/A
shareOrderedForDetailsWithAmc bool N/A

Example:

{
    "pushUrl": "https:\/\/stage.valuepad.com\/valuepad-pushes",
    "daysPriorInspectionDate": 2,
    "daysPriorEstimatedCompletionDate": 3,
    "preventViolationOfDateRestrictions": "warning",
    "disallowChangeJobTypeFees": false,
    "showClientToAppraiser": true,
    "showDocumentsToAppraiser": false,
    "canAppraiserChangeJobTypeFees": true,
    "isSmsEnabled": true,
    "unacceptedReminder": 2,
    "showClientFeeToAppraiser": false,
    "shareOrderedForDetailsWithAmc": false
}

Device Object

Properties:

Name Type Reference
id int N/A
token string N/A
platform enum Device Platform Enum
user object (extends User Object) N/A
- type enum User Type Enum

Example:

{
    "id": 242,
    "token": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
    "platform": "ios",
    "user": {
        "id": 424,
        "username": "johnhancock",
        "displayName": "John Hancock",
        "type": "appraiser"
    }
}

Device Persistable

Properties:

Name Type Reference
token string N/A
platform enum Device Platform Enum

Example:

{
    "token": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
    "platform": "ios"
}

Document Identifier Persistable

Properties:

Name Type Reference
id int N/A
token string N/A

Example:

{
    "id": 10,
    "token": "58IKsPHGJNDwUnOOjHJtPT6ZlSv14hwkPEhAKbGMhiZ1tcZuPSlqnhh4Z88LWKgl"
}

Document Object

Properties:

Name Type Reference
id int N/A
name string N/A
url string N/A
urlEncoded string N/A
urlSecure string N/A
size int N/A
format enum Document Format Enum
uploadedAt datetime N/A
token string N/A

Example:

{
    "id": 242,
    "name": "test.pdf",
    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
    "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
    "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
    "size": 14512415,
    "format": "pdf",
    "uploadedAt": "2016-04-21T07:51:59+00:00",
    "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
}

Document Persistable

Properties:

Name Type Reference
document file N/A

Example:

{
    "document": null
}

Eo Object

Properties:

Name Type Reference
document object Document Object
claimAmount float N/A
aggregateAmount float N/A
expiresAt datetime N/A
carrier string N/A
deductible float N/A

Example:

{
    "document": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "claimAmount": 2999.01,
    "aggregateAmount": 2999.01,
    "expiresAt": "2016-04-21T07:51:59+00:00",
    "carrier": "AT&T",
    "deductible": 442.99
}

External Order Document Object

Properties:

Name Type Reference
url string N/A
name string N/A
size int N/A
format enum Document Format Enum

Example:

{
    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
    "name": "test.pdf",
    "size": 14512415,
    "format": "pdf"
}

Extra Object

Properties:

Name Type Reference
user string N/A

Example:

{
    "user": "John Hancock"
}

Job Type Object

Properties:

Name Type Reference
id int N/A
title string N/A

Example:

{
    "id": 131,
    "title": "URAR(303)"
}

Language Object

Properties:

Name Type Reference
code string N/A
name string N/A

Example:

{
    "code": "en",
    "name": "English"
}

License Object

Properties:

Name Type Reference
id int N/A
isPrimary bool N/A
number string N/A
certifications enum[] Certification Enum
isFhaApproved bool N/A
isCommercial bool N/A
expiresAt datetime N/A
document object Document Object
state object State Object
coverage object[] N/A
- county object County Object
- zips string[] N/A

Example:

{
    "id": 52,
    "isPrimary": true,
    "number": "AAABBB2345",
    "certifications": [],
    "isFhaApproved": false,
    "isCommercial": true,
    "expiresAt": "2016-04-21T07:51:59+00:00",
    "document": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "state": {
        "code": "CA",
        "name": "California"
    },
    "coverage": [
        {
            "county": {
                "id": 42,
                "title": "BRISTOL BAY"
            },
            "zips": [
                "94132",
                "94108"
            ]
        }
    ]
}

Log Object

Properties:

Name Type Reference
id int N/A
order object Order Object
user mixed N/A
object (extends Customer Object) N/A
- type enum User Type Enum
- OR -
object (extends Appraiser Object) N/A
- type enum User Type Enum
action enum Log Action Enum
actionLabel string N/A
message string N/A
extra object Extra Object
createdAt datetime N/A

Example:

{
    "id": 49,
    "order": {
        "id": 5512,
        "fileNumber": "EFG41292",
        "asAppraisalId": "123456",
        "assignee": [
            "** --------------- Example #1 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com",
                "type": "appraiser"
            },
            "** --------------- Example #2 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "status": "approved",
                "companyName": "ABC Company",
                "email": "john.hancock@gmail.com",
                "address1": "1234 Some Street",
                "address2": "Suite 200",
                "city": "Baltimore",
                "state": {
                    "code": "CA",
                    "name": "California"
                },
                "zip": "21209",
                "phone": "(410)123-4567",
                "fax": "(410)123-4567",
                "lenders": "ABC Lender",
                "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                "type": "amc"
            }
        ],
        "company": {
            "id": 83,
            "name": "Best Appraisers Co.",
            "firstName": "John",
            "lastName": "White",
            "email": "appraisers@company.com",
            "phone": "(505) 242-2221",
            "fax": "(505) 242-5522",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "zip": "94333",
            "assignmentZip": "76901",
            "state": {
                "code": "CA",
                "name": "California"
            },
            "w9": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "taxId": "00-0000000",
            "type": "c-corporation",
            "otherType": "Other company type",
            "eo": {
                "document": {
                    "id": 242,
                    "name": "test.pdf",
                    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                    "size": 14512415,
                    "format": "pdf",
                    "uploadedAt": "2016-04-21T07:51:59+00:00",
                    "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                },
                "claimAmount": 2999.01,
                "aggregateAmount": 2999.01,
                "expiresAt": "2016-04-21T07:51:59+00:00",
                "carrier": "AT&T",
                "deductible": 442.99
            },
            "ach": {
                "bankName": "ABC Bank",
                "accountType": "checking",
                "accountNumber": "1234567890",
                "routing": "123456789"
            }
        },
        "loanAmount": 33.01,
        "lienPosition": "first",
        "valueQualifiers": [
            "as-is",
            "subject-to-completed"
        ],
        "subAssignees": [
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com"
            }
        ],
        "paymentMethod": null,
        "hasCreditCardInfo": false,
        "clientFee": 30.12,
        "orderedBy": {
            "id": 131,
            "firstName": "John",
            "lastName": "Week",
            "email": "appraiser@gmail.com",
            "phone": "(410)123-4567",
            "role": "processor",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "state": "CA",
            "zip": "76901",
            "branchName": "Branching Branch"
        },
        "submittedBy": {
            "id": 131,
            "firstName": "John",
            "lastName": "Week",
            "email": "appraiser@gmail.com",
            "phone": "(410)123-4567",
            "role": "investor",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "state": "CA",
            "zip": "76901",
            "branchName": "Branching Branch"
        }
    },
    "user": [
        "** --------------- Example #1 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "name": "ABC Company",
            "companyType": "bank-lender",
            "type": "customer"
        },
        "** --------------- Example #2 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com",
            "type": "appraiser"
        }
    ],
    "action": "create-order",
    "actionLabel": "Created Order",
    "message": "Your customer has created an order!",
    "extra": {
        "user": "John Hancock"
    },
    "createdAt": "2016-04-21T07:51:59+00:00"
}

Message Object

Properties:

Name Type Reference
id int N/A
isRead bool N/A
sender mixed N/A
object (extends Customer Object) N/A
- type enum User Type Enum
- OR -
object (extends Appraiser Object) N/A
- type enum User Type Enum
content string N/A
order object Order Object
createdAt datetime N/A

Example:

{
    "id": 49,
    "isRead": false,
    "sender": [
        "** --------------- Example #1 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "name": "ABC Company",
            "companyType": "bank-lender",
            "type": "customer"
        },
        "** --------------- Example #2 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com",
            "type": "appraiser"
        }
    ],
    "content": "This is a sample message.",
    "order": {
        "id": 5512,
        "fileNumber": "EFG41292",
        "asAppraisalId": "123456",
        "assignee": [
            "** --------------- Example #1 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com",
                "type": "appraiser"
            },
            "** --------------- Example #2 --------------- **",
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "status": "approved",
                "companyName": "ABC Company",
                "email": "john.hancock@gmail.com",
                "address1": "1234 Some Street",
                "address2": "Suite 200",
                "city": "Baltimore",
                "state": {
                    "code": "CA",
                    "name": "California"
                },
                "zip": "21209",
                "phone": "(410)123-4567",
                "fax": "(410)123-4567",
                "lenders": "ABC Lender",
                "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
                "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
                "type": "amc"
            }
        ],
        "company": {
            "id": 83,
            "name": "Best Appraisers Co.",
            "firstName": "John",
            "lastName": "White",
            "email": "appraisers@company.com",
            "phone": "(505) 242-2221",
            "fax": "(505) 242-5522",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "zip": "94333",
            "assignmentZip": "76901",
            "state": {
                "code": "CA",
                "name": "California"
            },
            "w9": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "taxId": "00-0000000",
            "type": "c-corporation",
            "otherType": "Other company type",
            "eo": {
                "document": {
                    "id": 242,
                    "name": "test.pdf",
                    "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                    "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                    "size": 14512415,
                    "format": "pdf",
                    "uploadedAt": "2016-04-21T07:51:59+00:00",
                    "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
                },
                "claimAmount": 2999.01,
                "aggregateAmount": 2999.01,
                "expiresAt": "2016-04-21T07:51:59+00:00",
                "carrier": "AT&T",
                "deductible": 442.99
            },
            "ach": {
                "bankName": "ABC Bank",
                "accountType": "checking",
                "accountNumber": "1234567890",
                "routing": "123456789"
            }
        },
        "loanAmount": 33.01,
        "lienPosition": "first",
        "valueQualifiers": [
            "as-is",
            "subject-to-completed"
        ],
        "subAssignees": [
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com"
            }
        ],
        "paymentMethod": null,
        "hasCreditCardInfo": false,
        "clientFee": 30.12,
        "orderedBy": {
            "id": 131,
            "firstName": "John",
            "lastName": "Week",
            "email": "appraiser@gmail.com",
            "phone": "(410)123-4567",
            "role": "processor",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "state": "CA",
            "zip": "76901",
            "branchName": "Branching Branch"
        },
        "submittedBy": {
            "id": 131,
            "firstName": "John",
            "lastName": "Week",
            "email": "appraiser@gmail.com",
            "phone": "(410)123-4567",
            "role": "investor",
            "address1": "422 Long Rd.",
            "address2": "422H Long Rd.",
            "city": "San Francisco",
            "state": "CA",
            "zip": "76901",
            "branchName": "Branching Branch"
        }
    },
    "createdAt": "2016-04-21T07:51:59+00:00"
}

Message Persistable

Properties:

Name Type Reference
content string N/A

Example:

{
    "content": "This is my message!"
}

Order Additional Document Object

Properties:

Name Type Reference
id int N/A
type object Order Additional Document Type Object
label string N/A
document object Document Object
createdAt datetime N/A

Example:

{
    "id": 131,
    "type": {
        "id": 131,
        "title": "Invoice"
    },
    "label": "Invoice",
    "document": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "createdAt": "2016-04-21T07:51:59+00:00"
}

Order Additional Document Persistable

Properties:

Name Type Reference
type int N/A
label string N/A
document int N/A

Example:

{
    "type": 131,
    "label": "Invoice",
    "document": 49
}

Order Additional Document Type Object

Properties:

Name Type Reference
id int N/A
title string N/A

Example:

{
    "id": 131,
    "title": "Invoice"
}

Order Complete Inspection Persistable

Properties:

Name Type Reference
completedAt datetime N/A
estimatedCompletionDate datetime N/A
message
(Required if the assignee is an appraiser and an estimated completion date has been set previously) 		object Message Persistable

Example:

{
    "completedAt": "2016-04-21T07:51:59+00:00",
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "message": {
        "content": "This is my message!"
    }
}

Order Document Object

Properties:

Name Type Reference
id int N/A
showToAppraiser bool N/A
primary object Document Object
primaries object[] Document Object
extra object[] Document Object
createdAt datetime N/A

Example:

{
    "id": 49,
    "showToAppraiser": true,
    "primary": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "primaries": [
        {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        }
    ],
    "extra": [
        {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        }
    ],
    "createdAt": "2016-04-20T07:51:59+00:00"
}

Order Document Persistable

Properties:

Name Type Reference
showToAppraiser bool N/A
primary mixed N/A
int N/A
- OR -
object Document Identifier Persistable
primaries mixed[] N/A
int N/A
- OR -
object Document Identifier Persistable
extra mixed[] N/A
int N/A
- OR -
object Document Identifier Persistable

Example:

{
    "showToAppraiser": true,
    "primary": [
        "** --------------- Example #1 --------------- **",
        21,
        "** --------------- Example #2 --------------- **",
        {
            "id": 10,
            "token": "58IKsPHGJNDwUnOOjHJtPT6ZlSv14hwkPEhAKbGMhiZ1tcZuPSlqnhh4Z88LWKgl"
        }
    ],
    "primaries": [
        21,
        {
            "id": 10,
            "token": "58IKsPHGJNDwUnOOjHJtPT6ZlSv14hwkPEhAKbGMhiZ1tcZuPSlqnhh4Z88LWKgl"
        }
    ],
    "extra": [
        21,
        {
            "id": 10,
            "token": "58IKsPHGJNDwUnOOjHJtPT6ZlSv14hwkPEhAKbGMhiZ1tcZuPSlqnhh4Z88LWKgl"
        }
    ]
}

Order Fee Persistable

Properties:

Name Type Reference
amount float N/A

Example:

{
    "amount": 550.99
}

Order Object

Properties:

Name Type Reference
id int N/A
fileNumber string N/A
asAppraisalId string N/A
assignee mixed N/A
object (extends Appraiser Object) N/A
- type enum User Type Enum
- OR -
object (extends AMC Object) N/A
- type enum User Type Enum
company object Company Object
intendedUse* string N/A
referenceNumber* string N/A
rulesets* object[] Ruleset Object
rules*
(all rules merged from all rulesets) 		object Ruleset Rules Object
clientName* string N/A
clientAddress1* string N/A
clientAddress2* string N/A
clientCity* string N/A
clientState* object State Object
clientZip* string N/A
client* object Client Object
clientDisplayedOnReportName* string N/A
clientDisplayedOnReportAddress1* string N/A
clientDisplayedOnReportAddress2* string N/A
clientDisplayedOnReportCity* string N/A
clientDisplayedOnReportState* object State Object
clientDisplayedOnReportZip* string N/A
clientDisplayedOnReport* object Client Object
customer* object Customer Object
amcLicenseNumber* string N/A
amcLicenseExpiresAt* datetime N/A
jobType* object Customer Job Type Object
additionalJobTypes* object[] Customer Job Type Object
isRush* bool N/A
isPaid* bool N/A
fee* float N/A
techFee* float N/A
isTechFeePaid* bool N/A
purchasePrice* float N/A
fhaNumber* string N/A
loanNumber* string N/A
loanType* string N/A
loanAmount float N/A
contractDocument* object Order Additional Document Object
contractDate* datetime N/A
salesPrice* float N/A
concession* float N/A
concessionUnit* enum Concession Unit Enum
processStatus* enum Process Status Enum
comment* string N/A
additionalStatus* object Additional Status Object
additionalStatusComment* string N/A
approachesToBeIncluded* enum[] Property Approaches To Be Included Enum
dueDate* datetime N/A
orderedAt* datetime N/A
assignedAt* datetime N/A
acceptedAt* datetime N/A
putOnHoldAt* datetime N/A
revisionReceivedAt* datetime N/A
inspectionScheduledAt* datetime N/A
inspectionCompletedAt* datetime N/A
estimatedCompletionDate* datetime N/A
completedAt* datetime N/A
paidAt* datetime N/A
fdic*
(Could be missing based on a respective ruleset) 		object N/A
- fin string N/A
- taskOrder string N/A
- line int N/A
- contractor string N/A
- assetNumber string N/A
- assetType enum FDIC Asset Type
- assetName string N/A
- receivershipName string N/A
property* object N/A
- type string N/A
- characteristics string[] N/A
- approxBuildingSize float N/A
- approxLandSize float N/A
- buildingAge int N/A
- numberOfStories int N/A
- numberOfUnits int N/A
- grossRentalIncome float N/A
- incomeSalesCost float N/A
- valueTypes enum[] Property Value Type Enum
- valueQualifiers enum[] Property Value Qualifier Enum
- ownerInterest
(deprecated, use "ownerInterests" instead) 		enum Property Owner Interest Enum
- ownerInterests enum[] Property Owner Interest Enum
- address1 string N/A
- address2 string N/A
- city string N/A
- state object State Object
- zip string N/A
- county object County Object
- latitude string N/A
- longitude string N/A
- occupancy enum Property Occupancy Enum
- bestPersonToContact enum Property Best Person To Contact Enum
- contacts object[] Property Contact Object
- legal string N/A
- additionalComments string N/A
instructionDocuments* object[] External Order Document Object
instruction* string N/A
additionalDocuments* object[] External Order Document Object
bid* object Bid Object
invitation*
(Not valid for AMC users) 		object Bid Object
acceptedConditions* object (extends Conditions Object) N/A
- additionalComments string N/A
lienPosition enum Lien Position Enum
valueQualifiers enum[] Value Qualifier Enum
subAssignees object[] Appraiser Object
paymentMethod enum Order Payment Method Enum
hasCreditCardInfo bool N/A
clientFee float N/A
orderedBy object Client User Object
submittedBy object Submitted By User Object
amcUsers* object N/A
- amcOrderedForFirstName string N/A
- amcOrderedForLastName string N/A
- amcOrderedForEmail string N/A
- amcOrderedForRole string N/A
- amcOrderedForPhone string N/A
- amcOrderedForFax string N/A
- amcOrderedForBranchName string N/A
- amcSubmittedByFirstName string N/A
- amcSubmittedByLastName string N/A
- amcSubmittedByEmail string N/A
- amcSubmittedByRole string N/A
- amcSubmittedByPhone string N/A
- amcSubmittedByFax string N/A
- amcSubmittedByBranchName string N/A

Example:

{
    "id": 5512,
    "fileNumber": "EFG41292",
    "asAppraisalId": "123456",
    "assignee": [
        "** --------------- Example #1 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com",
            "type": "appraiser"
        },
        "** --------------- Example #2 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "status": "approved",
            "companyName": "ABC Company",
            "email": "john.hancock@gmail.com",
            "address1": "1234 Some Street",
            "address2": "Suite 200",
            "city": "Baltimore",
            "state": {
                "code": "CA",
                "name": "California"
            },
            "zip": "21209",
            "phone": "(410)123-4567",
            "fax": "(410)123-4567",
            "lenders": "ABC Lender",
            "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
            "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
            "type": "amc"
        }
    ],
    "company": {
        "id": 83,
        "name": "Best Appraisers Co.",
        "firstName": "John",
        "lastName": "White",
        "email": "appraisers@company.com",
        "phone": "(505) 242-2221",
        "fax": "(505) 242-5522",
        "address1": "422 Long Rd.",
        "address2": "422H Long Rd.",
        "city": "San Francisco",
        "zip": "94333",
        "assignmentZip": "76901",
        "state": {
            "code": "CA",
            "name": "California"
        },
        "w9": {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        },
        "taxId": "00-0000000",
        "type": "c-corporation",
        "otherType": "Other company type",
        "eo": {
            "document": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "claimAmount": 2999.01,
            "aggregateAmount": 2999.01,
            "expiresAt": "2016-04-21T07:51:59+00:00",
            "carrier": "AT&T",
            "deductible": 442.99
        },
        "ach": {
            "bankName": "ABC Bank",
            "accountType": "checking",
            "accountNumber": "1234567890",
            "routing": "123456789"
        }
    },
    "intendedUse": "Purchase",
    "referenceNumber": "ABCD1234",
    "rulesets": [
        {
            "id": 131,
            "level": 2,
            "label": "Client ABC",
            "rules": {
                "requireEnv": true,
                "clientAddress1": "1144 Holloway Ave.",
                "clientAddress2": "1144B Holloway Ave.",
                "clientState": {
                    "code": "CA",
                    "name": "California"
                },
                "clientCity": "San Francisco",
                "clientZip": "94132",
                "clientDisplayedOnReportAddress1": "1144 Holloway Ave.",
                "clientDisplayedOnReportAddress2": "1144B Holloway Ave.",
                "clientDisplayedOnReportState": {
                    "code": "CA",
                    "name": "California"
                },
                "clientDisplayedOnReportCity": "San Francisco",
                "clientDisplayedOnReportZip": "94132",
                "displayFdic": false,
                "dateRestrictionsIncludeTime": true
            }
        }
    ],
    "rules": {
        "requireEnv": true,
        "clientAddress1": "1144 Holloway Ave.",
        "clientAddress2": "1144B Holloway Ave.",
        "clientState": {
            "code": "CA",
            "name": "California"
        },
        "clientCity": "San Francisco",
        "clientZip": "94132",
        "clientDisplayedOnReportAddress1": "1144 Holloway Ave.",
        "clientDisplayedOnReportAddress2": "1144B Holloway Ave.",
        "clientDisplayedOnReportState": {
            "code": "CA",
            "name": "California"
        },
        "clientDisplayedOnReportCity": "San Francisco",
        "clientDisplayedOnReportZip": "94132",
        "displayFdic": false,
        "dateRestrictionsIncludeTime": true
    },
    "clientName": "ABC Bank",
    "clientAddress1": "123 Market Str.",
    "clientAddress2": "123B Market Str.",
    "clientCity": "San Francisco",
    "clientState": {
        "code": "CA",
        "name": "California"
    },
    "clientZip": "92104",
    "client": {
        "id": 131
    },
    "clientDisplayedOnReportName": "ABC Bank",
    "clientDisplayedOnReportAddress1": "123 Market Str.",
    "clientDisplayedOnReportAddress2": "123B Market Str.",
    "clientDisplayedOnReportCity": "San Francisco",
    "clientDisplayedOnReportState": {
        "code": "CA",
        "name": "California"
    },
    "clientDisplayedOnReportZip": "92104",
    "clientDisplayedOnReport": {
        "id": 131
    },
    "customer": {
        "id": 424,
        "username": "johnhancock",
        "displayName": "John Hancock",
        "name": "ABC Company",
        "companyType": "bank-lender"
    },
    "amcLicenseNumber": "ABC1234567",
    "amcLicenseExpiresAt": "2016-04-21T07:51:59+00:00",
    "jobType": {
        "id": 131,
        "title": "URAR(303)",
        "isCommercial": false,
        "local": {
            "id": 131,
            "title": "URAR(303)"
        },
        "isPayable": true
    },
    "additionalJobTypes": [
        {
            "id": 131,
            "title": "URAR(303)",
            "isCommercial": false,
            "local": {
                "id": 131,
                "title": "URAR(303)"
            },
            "isPayable": true
        }
    ],
    "isRush": true,
    "isPaid": true,
    "fee": 13.21,
    "techFee": 13.21,
    "isTechFeePaid": false,
    "purchasePrice": 199.01,
    "fhaNumber": "123456789B",
    "loanNumber": "123456789B",
    "loanType": "123456789B",
    "loanAmount": 33.01,
    "contractDocument": {
        "id": 131,
        "type": {
            "id": 131,
            "title": "Invoice"
        },
        "label": "Invoice",
        "document": {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        },
        "createdAt": "2016-04-21T07:51:59+00:00"
    },
    "contractDate": "2016-04-21T07:51:59+00:00",
    "salesPrice": 42.11,
    "concession": 42.11,
    "concessionUnit": "amount",
    "processStatus": "new",
    "comment": "Some message",
    "additionalStatus": {
        "id": 131,
        "title": "Waiting for client",
        "comment": "Some text"
    },
    "additionalStatusComment": "Some comment here",
    "approachesToBeIncluded": [
        "cost",
        "sales"
    ],
    "dueDate": "2016-04-21T07:51:59+00:00",
    "orderedAt": "2016-04-21T07:51:59+00:00",
    "assignedAt": "2016-04-21T07:51:59+00:00",
    "acceptedAt": "2016-04-21T07:51:59+00:00",
    "putOnHoldAt": "2016-04-21T07:51:59+00:00",
    "revisionReceivedAt": "2016-04-21T07:51:59+00:00",
    "inspectionScheduledAt": "2016-04-21T07:51:59+00:00",
    "inspectionCompletedAt": "2016-04-21T07:51:59+00:00",
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "completedAt": "2016-04-21T07:51:59+00:00",
    "paidAt": "2016-04-21T07:51:59+00:00",
    "fdic": {
        "fin": "42124",
        "taskOrder": "4221",
        "line": 2,
        "contractor": "contractor_1234",
        "assetNumber": "AB1244",
        "assetType": "settlement",
        "assetName": "AB1244",
        "receivershipName": "AB1244"
    },
    "property": {
        "type": "ABC Type",
        "characteristics": [
            "Water Access",
            "Water Front"
        ],
        "approxBuildingSize": 14.3,
        "approxLandSize": 52.12,
        "buildingAge": 21,
        "numberOfStories": 12,
        "numberOfUnits": 56,
        "grossRentalIncome": 42.19,
        "incomeSalesCost": 42.19,
        "valueTypes": [
            "market",
            "insurable"
        ],
        "valueQualifiers": [
            "as-proposed",
            "going-concern"
        ],
        "ownerInterest": "fee-simple",
        "ownerInterests": [
            "fee-simple",
            "duplex"
        ],
        "address1": "144 Market Str.",
        "address2": "144B Market Str.",
        "city": "San Francisco",
        "state": {
            "code": "CA",
            "name": "California"
        },
        "zip": "94132",
        "county": {
            "id": 42,
            "title": "BRISTOL BAY"
        },
        "latitude": "46.9964354",
        "longitude": "28.8570757",
        "occupancy": "tenant",
        "bestPersonToContact": "owner",
        "contacts": [
            {
                "type": "realtor",
                "name": "John",
                "firstName": "Steve",
                "lastName": "Job",
                "middleName": "Mike",
                "displayName": "Mike",
                "homePhone": "(707) 553-1231",
                "cellPhone": "(707) 553-1231",
                "workPhone": "(707) 553-1231",
                "email": "info@valuepad.com",
                "intentProceedDate": "2016-04-20T07:51:59+00:00"
            }
        ],
        "legal": "some text",
        "additionalComments": "some comments"
    },
    "instructionDocuments": [
        {
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "name": "test.pdf",
            "size": 14512415,
            "format": "pdf"
        }
    ],
    "instruction": "Some instruction here",
    "additionalDocuments": [
        {
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "name": "test.pdf",
            "size": 14512415,
            "format": "pdf"
        }
    ],
    "bid": {
        "amount": 49.99,
        "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
        "comments": "Additional comment here.",
        "appraisers": [
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com"
            }
        ]
    },
    "invitation": {
        "amount": 49.99,
        "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
        "comments": "Additional comment here.",
        "appraisers": [
            {
                "id": 424,
                "username": "johnhancock",
                "displayName": "John Hancock",
                "firstName": "Hancock",
                "lastName": "Hancock",
                "email": "john.hancock@gmail.com"
            }
        ]
    },
    "acceptedConditions": {
        "request": "fee-increase",
        "fee": 49.99,
        "dueDate": "2016-04-21T07:51:59+00:00",
        "explanation": "New conditions.",
        "additionalComments": "Some comments"
    },
    "lienPosition": "first",
    "valueQualifiers": [
        "as-is",
        "subject-to-completed"
    ],
    "subAssignees": [
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com"
        }
    ],
    "paymentMethod": null,
    "hasCreditCardInfo": false,
    "clientFee": 30.12,
    "orderedBy": {
        "id": 131,
        "firstName": "John",
        "lastName": "Week",
        "email": "appraiser@gmail.com",
        "phone": "(410)123-4567",
        "role": "processor",
        "address1": "422 Long Rd.",
        "address2": "422H Long Rd.",
        "city": "San Francisco",
        "state": "CA",
        "zip": "76901",
        "branchName": "Branching Branch"
    },
    "submittedBy": {
        "id": 131,
        "firstName": "John",
        "lastName": "Week",
        "email": "appraiser@gmail.com",
        "phone": "(410)123-4567",
        "role": "investor",
        "address1": "422 Long Rd.",
        "address2": "422H Long Rd.",
        "city": "San Francisco",
        "state": "CA",
        "zip": "76901",
        "branchName": "Branching Branch"
    },
    "amcUsers": {
        "amcOrderedForFirstName": "John",
        "amcOrderedForLastName": "Week",
        "amcOrderedForEmail": "appraiser@gmail.com",
        "amcOrderedForRole": "processor",
        "amcOrderedForPhone": "(410)123-4567",
        "amcOrderedForFax": "(410)123-4567",
        "amcOrderedForBranchName": "Branching Branch",
        "amcSubmittedByFirstName": "John",
        "amcSubmittedByLastName": "Week",
        "amcSubmittedByEmail": "appraiser@gmail.com",
        "amcSubmittedByRole": "appraiser",
        "amcSubmittedByPhone": "(410)123-4567",
        "amcSubmittedByFax": "(410)123-4567",
        "amcSubmittedByBranchName": "Branching Branch"
    }
}

Order Reconsideration Object

Properties:

Name Type Reference
id int N/A
comment string N/A
document object Order Additional Document Object
documents object[] Order Additional Document Object
comparables object N/A
- address string N/A
- salesPrice float N/A
- closedDate datetime N/A
- livingArea string N/A
- siteSize string N/A
- actualAge string N/A
- distanceToSubject string N/A
- sourceData string N/A
- comment string N/A
createdAt datetime N/A

Example:

{
    "id": 49,
    "comment": "Needs Reconsideration",
    "document": {
        "id": 131,
        "type": {
            "id": 131,
            "title": "Invoice"
        },
        "label": "Invoice",
        "document": {
            "id": 242,
            "name": "test.pdf",
            "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
            "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
            "size": 14512415,
            "format": "pdf",
            "uploadedAt": "2016-04-21T07:51:59+00:00",
            "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
        },
        "createdAt": "2016-04-21T07:51:59+00:00"
    },
    "documents": [
        {
            "id": 131,
            "type": {
                "id": 131,
                "title": "Invoice"
            },
            "label": "Invoice",
            "document": {
                "id": 242,
                "name": "test.pdf",
                "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
                "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
                "size": 14512415,
                "format": "pdf",
                "uploadedAt": "2016-04-21T07:51:59+00:00",
                "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
            },
            "createdAt": "2016-04-21T07:51:59+00:00"
        }
    ],
    "comparables": {
        "address": "1234 Some Street",
        "salesPrice": 49.99,
        "closedDate": "2016-04-20T07:51:59+00:00",
        "livingArea": "500",
        "siteSize": "300",
        "actualAge": "20",
        "distanceToSubject": "400",
        "sourceData": "MLS",
        "comment": "Review this comparable"
    },
    "createdAt": "2016-04-20T07:51:59+00:00"
}

Order Revision Object

Properties:

Name Type Reference
id int N/A
checklist string[] N/A
message string N/A
createdAt datetime N/A

Example:

{
    "id": 49,
    "checklist": [
        "one",
        "two"
    ],
    "message": "Needs a revision.",
    "createdAt": "2016-04-20T07:51:59+00:00"
}

Order Schedule Inspection Persistable

Properties:

Name Type Reference
scheduledAt datetime N/A
estimatedCompletionDate datetime N/A
message
(Required if the assignee is an appraiser and an estimated completion date has been set previously) 		object Message Persistable

Example:

{
    "scheduledAt": "2016-04-21T07:51:59+00:00",
    "estimatedCompletionDate": "2016-04-21T07:51:59+00:00",
    "message": {
        "content": "This is my message!"
    }
}

Order Sure Receipt Object

Properties:

Name Type Reference
id int N/A
document object Document Object
createdAt datetime N/A

Example:

{
    "id": 131,
    "document": {
        "id": 242,
        "name": "test.pdf",
        "url": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlEncoded": "https:\/\/s3.amazonaws.com\/valuepad-files\/documents\/53166\/test.pdf",
        "urlSecure": "https:\/\/stage.valuepad.com\/api\/v2.0\/documents\/242",
        "size": 14512415,
        "format": "pdf",
        "uploadedAt": "2016-04-21T07:51:59+00:00",
        "token": "iAxAKSVkMx9sAQGGJwlaf7oVnwy9ThQyuwBpC1Vr1rxW1l10YtTCpknG0KjBqLH5"
    },
    "createdAt": "2016-04-21T07:51:59+00:00"
}

Order Sure Receipt Persistable

Properties:

Name Type Reference
document mixed N/A
int N/A
- OR -
object Document Identifier Persistable

Example:

{
    "document": [
        "** --------------- Example #1 --------------- **",
        144,
        "** --------------- Example #2 --------------- **",
        {
            "id": 10,
            "token": "58IKsPHGJNDwUnOOjHJtPT6ZlSv14hwkPEhAKbGMhiZ1tcZuPSlqnhh4Z88LWKgl"
        }
    ]
}

Order Totals Object

Properties:

Name Type Reference
paid object N/A
- total int N/A
- fee float N/A
- techFee float N/A
unpaid object N/A
- total int N/A
- fee float N/A
- techFee float N/A

Example:

{
    "paid": {
        "total": 20,
        "fee": 49.99,
        "techFee": 49.99
    },
    "unpaid": {
        "total": 20,
        "fee": 49.99,
        "techFee": 49.99
    }
}

Pagination Object

Properties:

Name Type Reference
total int N/A
perPage int N/A
page int N/A
totalPages int N/A

Example:

{
    "total": 1000,
    "perPage": 10,
    "page": 31,
    "totalPages": 100
}

Property Contact Object

Properties:

Name Type Reference
type enum Property Contact Type Enum
name string N/A
firstName string N/A
lastName string N/A
middleName string N/A
displayName
(A shortcut dynamic property that shows either "name" if it is set or concatinated "firstName" and "lastName") 		string N/A
homePhone string N/A
cellPhone string N/A
workPhone string N/A
email string N/A
intentProceedDate datetime N/A

Example:

{
    "type": "realtor",
    "name": "John",
    "firstName": "Steve",
    "lastName": "Job",
    "middleName": "Mike",
    "displayName": "Mike",
    "homePhone": "(707) 553-1231",
    "cellPhone": "(707) 553-1231",
    "workPhone": "(707) 553-1231",
    "email": "info@valuepad.com",
    "intentProceedDate": "2016-04-20T07:51:59+00:00"
}

Ruleset Object

Properties:

Name Type Reference
id int N/A
level int N/A
label string N/A
rules object Ruleset Rules Object

Example:

{
    "id": 131,
    "level": 2,
    "label": "Client ABC",
    "rules": {
        "requireEnv": true,
        "clientAddress1": "1144 Holloway Ave.",
        "clientAddress2": "1144B Holloway Ave.",
        "clientState": {
            "code": "CA",
            "name": "California"
        },
        "clientCity": "San Francisco",
        "clientZip": "94132",
        "clientDisplayedOnReportAddress1": "1144 Holloway Ave.",
        "clientDisplayedOnReportAddress2": "1144B Holloway Ave.",
        "clientDisplayedOnReportState": {
            "code": "CA",
            "name": "California"
        },
        "clientDisplayedOnReportCity": "San Francisco",
        "clientDisplayedOnReportZip": "94132",
        "displayFdic": false,
        "dateRestrictionsIncludeTime": true
    }
}

Ruleset Rules Object

Properties:

Name Type Reference
requireEnv bool N/A
clientAddress1 string N/A
clientAddress2 string N/A
clientState object State Object
clientCity string N/A
clientZip string N/A
clientDisplayedOnReportAddress1 string N/A
clientDisplayedOnReportAddress2 string N/A
clientDisplayedOnReportState object State Object
clientDisplayedOnReportCity string N/A
clientDisplayedOnReportZip string N/A
displayFdic bool N/A
dateRestrictionsIncludeTime bool N/A

Example:

{
    "requireEnv": true,
    "clientAddress1": "1144 Holloway Ave.",
    "clientAddress2": "1144B Holloway Ave.",
    "clientState": {
        "code": "CA",
        "name": "California"
    },
    "clientCity": "San Francisco",
    "clientZip": "94132",
    "clientDisplayedOnReportAddress1": "1144 Holloway Ave.",
    "clientDisplayedOnReportAddress2": "1144B Holloway Ave.",
    "clientDisplayedOnReportState": {
        "code": "CA",
        "name": "California"
    },
    "clientDisplayedOnReportCity": "San Francisco",
    "clientDisplayedOnReportZip": "94132",
    "displayFdic": false,
    "dateRestrictionsIncludeTime": true
}

Session Object

Properties:

Name Type Reference
id int N/A
token string N/A
user mixed N/A
object (extends Customer Object) N/A
- type enum User Type Enum
- OR -
object (extends Appraiser Object) N/A
- type enum User Type Enum
- OR -
object (extends AMC Object) N/A
- type enum User Type Enum
createdAt datetime N/A
expireAt datetime N/A

Example:

{
    "id": 49,
    "token": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
    "user": [
        "** --------------- Example #1 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "name": "ABC Company",
            "companyType": "bank-lender",
            "type": "customer"
        },
        "** --------------- Example #2 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "firstName": "Hancock",
            "lastName": "Hancock",
            "email": "john.hancock@gmail.com",
            "type": "appraiser"
        },
        "** --------------- Example #3 --------------- **",
        {
            "id": 424,
            "username": "johnhancock",
            "displayName": "John Hancock",
            "status": "approved",
            "companyName": "ABC Company",
            "email": "john.hancock@gmail.com",
            "address1": "1234 Some Street",
            "address2": "Suite 200",
            "city": "Baltimore",
            "state": {
                "code": "CA",
                "name": "California"
            },
            "zip": "21209",
            "phone": "(410)123-4567",
            "fax": "(410)123-4567",
            "lenders": "ABC Lender",
            "secret1": "S5qQsutVW5tJQgMzoT3Z26Fct59Yv3lkwMeiP7yrwkx7Fx1079aOZFTvbwt30KSM",
            "secret2": "S5qQsut26Fct59YpMzoT3Z26Fct9Yv3lkoYeiP7yrwkx7Fx2479aOPATvhnt30KPL",
            "type": "amc"
        }
    ],
    "createdAt": "2016-04-20T07:51:59+00:00",
    "expireAt": "2016-04-21T07:51:59+00:00"
}

State Object

Properties:

Name Type Reference
code string N/A
name string N/A

Example:

{
    "code": "CA",
    "name": "California"
}

Submitted By User Object

Properties:

Name Type Reference
id int N/A
firstName string N/A
lastName string N/A
email string N/A
phone string N/A
role string N/A
address1 string N/A
address2 string N/A
city string N/A
state string N/A
zip string N/A
branchName string N/A

Example:

{
    "id": 131,
    "firstName": "John",
    "lastName": "Week",
    "email": "appraiser@gmail.com",
    "phone": "(410)123-4567",
    "role": "investor",
    "address1": "422 Long Rd.",
    "address2": "422H Long Rd.",
    "city": "San Francisco",
    "state": "CA",
    "zip": "76901",
    "branchName": "Branching Branch"
}

User Object

Properties:

Name Type Reference
id int N/A
username string N/A
displayName string N/A

Example:

{
    "id": 424,
    "username": "johnhancock",
    "displayName": "John Hancock"
}

Standard Enums

Here you will find all of the standard enums available.

Name Values
ACH Account Type Enum checking, saving
AMC Job Type Fee Qualifier Enum county, default, state, zip
Bank Account Type Enum business-checking, checking, savings
Business Type Enum certified-minority, hub-zone-small-business, large-business, not-applicable, small-business, small-disadvantaged-business, veteran-owned-business, women-owned-business
Certification Enum certified-general, certified-residential, licensed, transitional-license
Commercial Expertise Enum agricultural, elf-storage, hospitality, industrial, land, multi-family, office, retail, winery
Company Type Enum c-corporation, individual-ssn, individual-tax-id, llc-c, llc-p, llc-s, other, partnership, s-corporation, trust-estate
Concession Unit Enum amount, percentage
Conditions Request Enum due-date-extension, fee-increase, fee-increase-and-due-date-extension, other
Criticality Enum disabled, hardstop, warning
Customer Company Type Enum appraisal-management-company, bank-lender, credit-union, mortgage-broker
Device Platform Enum android, ios
Document Format Enum aci, csv, doc, docx, emz, env, file, gif, html, jpeg, jpg, odt, pdf, png, psd, rtf, sigimg0, sigimg1, sigimg2, sigimg3, tif, txt, wmz, xls, xlsx, xml, zap, zoo
FDIC Asset Type loan, ore, settlement
Lien Position Enum first, subordinate
Log Action Enum bid-request, change-additional-status, create-additional-document, create-document, create-order, delete-additional-document, delete-document, delete-order, reconsideration-request, revision-request, update-order, update-process-status
Order Decline Reason Enum other, out-of-coverage-area, too-busy
Order Document Extra Format Enum aci, env, zap, zoo
Order Document Format Enum env, pdf, xml
Order Payment Method Enum credit-card, invoice
Payment Means Enum bank-account, credit-card
Process Status Enum accepted, completed, inspection-completed, inspection-scheduled, late, new, on-hold, ready-for-review, request-for-bid, reviewed, revision-in-review, revision-pending
Property Approaches To Be Included Enum cost, income, sales
Property Best Person To Contact Enum additional-comments, assistant, borrower, co-borrower, listing-agent, other, owner, realtor, selling-agent
Property Contact Type Enum assistant, borrower, co-borrower, listing-agent, other, owner, realtor, selling-agent
Property Occupancy Enum new-construction, owner, tenant, unknown
Property Owner Interest Enum air-rights, duplex, fee-simple, leased-fee, leasehold, partial-interest
Property Value Qualifier Enum as-complete, as-is, as-proposed, as-stabilized, going-concern, liquidation-forced, liquidation-orderly
Property Value Type Enum fair-market-rental, insurable, liquidation, market
Queue Enum accepted, all, completed, due, inspected, late, new, on-hold, open, ready-for-review, revision, scheduled
User Status Enum approved, declined, disabled, pending
User Type Enum admin, amc, appraiser, customer, manager, system
Value Qualifier Enum as-is, subject-to-completed