NAV
shell ruby python javascript

Introduction Test

Welcome to the RESTFUL Appraisalflo API! You can use our API to access Appraisalflo API endpoints.

We have language bindings in Shell, Ruby, Python, and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

To authorize, use this code:

require 'Appraisalflo'

api = Appraisalflo::APIClient.authorize!('AUTHKEY')

import Appraisalflo

api = Appraisalflo.authorize('AUTHKEY')

# With shell, you can just pass the correct header with each request
curl http://api.appraisalflo.com/api/order \
  -H "Authorization: AUTHKEY"

const Appraisalflo = require('Appraisalflo');

let api = Appraisalflo.authorize('AUTHKEY');

Make sure to replace AUTHKEY with your API key.

Appraisalflo uses API keys to allow access to the API. You can register a new Appraisalflo API key at our developer portal.

Appraisalflo expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: AUTHKEY

CMS

CMS Event Request

To avoid duplication this section will be included in every payload as the Data.

Event

{
  "event":      {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "",
    "created_datetime": "",
    "username":         "",
    "password":         ""
  },
  "data": {
  }
}
Parameter Type Description
provider_id Integer Providers Unique Identifier
order_id Integer Order Unique Identifier
request String Event Request Unique Identifier
created_datetime DateTime Event created datetime
username String Optional Username required for logging into your site
password String Optional Password required for logging into your site

Assigned

This event assigns the order to the AMC.

Event

For more information on event section click here

Data

{
  "event":      {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "assigned",
    "created_datetime": "",
    "username":         "",
    "password":         ""
  },
  "data": {
    "comments": [
      {
        "id":      "",
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}
Parameter Type Description
comments String For more information on comment section click here

Update

This event sends updates on order data. Any included key HAS been updated.

Event

For more information on event section click here

Data

{
  "event":      {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "update",
    "created_datetime": "",
    "username":         "",
    "password":         ""
  },
  "data": {
    "lender_id":                  "",
    "lender_branch_id":           "",
    "tpo_id":                     "",
    "tpo_branch_id":              "",
    "address":                    "",
    "unit":                       "",
    "city":                       "",
    "state":                      "",
    "zip":                        "",
    "county":                     "",
    "rush":                       "",
    "loan_number":                "",
    "fha_case_number":            "",
    "fdic_case_number":           "",
    "contract_price":             "",
    "requested_due_date":         "",
    "appraisal_contingency_date": "",
    "loan_type":                  "",
    "occupancy_status":           "",
    "purchase_type":              "",
    "property_type":              "",
    "intended_use":               "",
    "payment_responsibility":     "",
    "fee":                        "",
    "contacts":                   [
      {
        "type":    "",
        "name":    "",
        "email":   "",
        "address": "",
        "city":    "",
        "state":   "",
        "zip":     "",
        "county":  "",
        "phones":  [
          {
            "type":      "",
            "number":    "",
            "extension": ""
          }
        ]
      }
    ]
  }
}
Parameter Type Description
address String Property Address
unit String Property Unit
city String Property City
state String Property State
zip String Property Zip Code
county String Property County
rush String Rush Order is either Yes
products Array List of Product ID's
loan_number Integer Property Loan Number
fha_case_number String Property FHA Case Number
fdic_case_number String Property FDIC Case Number
contract_price Integer Property Contract Price
requested_due_date Date CMS Requested Due Date
appraisal_contingency_date Date Borrower Appraisal Contingency Date
loan_type Integer See Loan Types
occupancy_status Integer See Occupancy Status
purchase_type Integer See Purchase Type
property_type Integer See Property Type
intended_use Integer See Intended Use
payment_responsibility Integer Payment Type is either CMS
fee Integer Lender Fee
contacts Array Please see table below for more information on contacts

Contacts

Parameter Type Description
type String See Contact Types
firstname String First Name of Contact
lastname String Last Name of Contact
email String Email
email2 String Secondary Email
address String Address
city String City
state String State
zip String Zip Code
county String County
phones String Please see table below for more information on Contacts - Phones

Contacts - Phones

Parameter Type Description
type String See Contact Phone Types
number Integer 7 Digit Phone Number
extension Integer Extension

CMS Comments

This event sends a message to the AMC.

Event

For more information on event section click here

Data

{
  "event":      {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "comment",
    "created_datetime": "",
    "username":         "",
    "password":         ""
  },
  "data": {
    "comments": [
      {
        "id":      "",
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}
Parameter Type Description
comments Array Please see table below for more information on Comments

Comments

Parameter Type Description
id String Unique Identifer
name String User who made the comment (Messages from the system will be marked as "SYSTEM")
subject String Subject of the message
body base64 Body of the message

Documents

This event sends documents to the AMC.

Event

For more information on event section click here

Data

{
  "event":      {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "documents",
    "created_datetime": "",
    "username":         "",
    "password":         ""
  },
  "data": {
    "documents": [
      {
        "id":               "",
        "created_datetime": "",
        "created_by_user":  "",
        "name":             "",
        "extension":        "",
        "type":             "",
        "data":             ""
      }
    ]
  }
}
Parameter Type Description
documents Array Please see table below for more information on Documents

Documents

Parameter Type Description
id String Unique ID
created_datetime String Datetime stamp of when the document was created
created_by_user String Name of the user that created the document
name String Document Name (including extension)
extension String Document Extension
type String See Document Types
data base64 Document data base64 encoded

On Hold

This event puts the order on hold.

Event

For more information on event section click here

Data

{
  "event":      {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "on_hold",
    "created_datetime": "",
    "username":         "",
    "password":         ""
  },
  "data": {
    "comments": [
      {
        "id":      "",
        "created_datetime":    "",
        "created_by_user":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}
Parameter Type Description
comments String For more information on comment section click here

Resume

This event resumes the order after being on hold.

Event

For more information on event section click here

Data

{
  "event":      {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "resume",
    "created_datetime": "",
    "username":         "",
    "password":         ""
  },
  "data": {
    "comments": [
      {
        "id":      "",
        "created_datetime":    "",
        "created_by_user":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}
Parameter Type Description
comments String For more information on comment section click here

Unassigned

This event un-assigns the order to the AMC.

Event

For more information on event section click here

Data

{
  "event":      {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "unassigned",
    "created_datetime": "",
    "username":         "",
    "password":         ""
  },
  "data": {
    "comments": [
      {
        "id":      "",
        "created_datetime":    "",
        "created_by_user":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}
Parameter Type Description
comments String For more information on comment section click here

Modification Approved

This event assigns the order to the AMC.

Event

For more information on event section click here

Data

{
  "event":      {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "modification_accepted",
    "created_datetime": "",
    "username":         "",
    "password":         ""
  },
  "data": {
    "comments": [
      {
        "id":      "",
        "created_datetime":    "",
        "created_by_user":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}
Parameter Type Description
comments String For more information on comment section click here

Revisions Requested

This event requests revisions from the AMC.

Event

For more information on event section click here

Data

{
  "event":      {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "revisions_requested",
    "created_datetime": "",
    "username":         "",
    "password":         ""
  },
  "data": {
    "revisions": []
  }
}
Parameter Type Description
revisions Array Contains a list of messages

Payment

This event sends payments to the AMC.

Event

For more information on event section click here

Data

{
  "event":      {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "payment",
    "created_datetime": "",
    "username":         "",
    "password":         ""
  },
  "data": {
    "payment":                    {
        "id":          "",
        "type":        "",
        "description": "",
        "amount":      ""
    }
  }
}
Parameter Type Description
payment Array Please see table below for more information on Payments

Payment

Parameter Type Description
id String Unique ID
type String Value can either be Credit
description String Payment Description
amount Float Payment Amount

List Updates

This event will send out ALL the lists if there is an update to anything.

Event

For more information on event section click here

Data

{
  "event":      {
    "token":            "",
    "provider_id":      "",
    "request":          "definition_update",
    "created_datetime": "",
    "username":         "",
    "password":         ""
  },
  "data": {
    "definitions":                {
      "products":         [
        {
          "id":          "",
          "title":       "",
          "description": ""
        }
      ],
      "contact_types":    [
        {
          "title": "",
          "name":  ""
        }
      ],
      "document_types":   [
        {
          "title": "",
          "name":  ""
        }
      ],
      "loan_types":       [
        {
          "title": "",
          "name":  ""
        }
      ],
      "occupancy_status": [
        {
          "title": "",
          "name":  ""
        }
      ],
      "purchase_types":   [
        {
          "title": "",
          "name":  ""
        }
      ],
      "property_types":   [
        {
          "title": "",
          "name":  ""
        }
      ],
      "intended_use":     [
        {
          "title": "",
          "name":  ""
        }
      ]
    }
  }
}
Parameter Type Description
products Array Please see table below for more information on Products
contact_types Array Please see table below for more information on Generic List
document_types Array Please see table below for more information on Generic List
loan_types Array Please see table below for more information on Generic List
occupancy_status Array Please see table below for more information on Generic List
purchase_types Array Please see table below for more information on Generic List
property_types Array Please see table below for more information on Generic List
intended_use Array Please see table below for more information on Generic List

Products

Parameter Type Description
id String Unique ID
Title String Name of Product
description String Product Description

Generic List

Parameter Type Description
Title String Title of Item
name String Unique ID

AMC

AMC Event Request

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "",
    "created_datetime": ""
  },
  "data":  {
  }
}

To avoid duplication this section will be included in every payload as the Data.

Event

Parameter Type Description
token String Identifies the Integratotion partner
provider_id Integer Providers Unique Identifier
order_id Integer Order Unique Identifier
request Integer Event Unique Identifier
created_datetime DateTime Event created datetime

Get Order

require 'kittn'

api = Kittn::APIClient.authorize!('AUTHKEY')
api.kittens.get_order

import kittn

api = kittn.authorize('AUTHKEY')
api.kittens.get()

curl "http://api.appraisalflo.com/api/order" \
  -H "Authorization: AUTHKEY"

const kittn = require('kittn');

let api = kittn.authorize('AUTHKEY');
let kittens = api.kittens.get();

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "get_order",
    "created_datetime": ""
  }
}

This event will pull down the latest order data

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

The above command returns JSON structured like this:

{
  "data": {
    "lender_id":                  "",
    "lender_branch_id":           "",
    "tpo_id":                     "",
    "tpo_branch_id":              "",
    "created_datetime":           "",
    "address":                    "",
    "unit":                       "",
    "city":                       "",
    "state":                      "",
    "zip":                        "",
    "county":                     "",
    "rush":                       "",
    "loan_number":                "",
    "fha_case_number":            "",
    "fdic_case_number":           "",
    "contract_price":             "",
    "requested_due_date":         "",
    "appraisal_contingency_date": "",
    "loan_type":                  "",
    "occupancy_status":           "",
    "purchase_type":              "",
    "property_type":              "",
    "intended_use":               "",
    "fee":                        "",
    "payment_responsibility":     "",
    "products":                   [],
    "contacts":                   [
      {
        "type":    "",
        "name":    "",
        "email":   "",
        "email2":   "",
        "address": "",
        "city":    "",
        "state":   "",
        "zip":     "",
        "county":  "",
        "phones":  [
          {
            "type":      "",
            "number":    "",
            "extension": ""
          }
        ]
      }
    ]
  }
}

Data

Parameter Type Description
address String Property Address
unit String Property Unit
city String Property City
state String Property State
zip String Property Zip Code
county String Property County
rush String Rush Order is either Yes
products Array List of Product ID's
loan_number Integer Property Loan Number
fha_case_number String Property FHA Case Number
fdic_case_number String Property FDIC Case Number
contract_price Integer Property Contract Price
requested_due_date Date CMS Requested Due Date
appraisal_contingency_date Date Borrower Appraisal Contingency Date
loan_type Integer See Loan Types
occupancy_status Integer See Occupancy Status
purchase_type Integer See Purchase Type
property_type Integer See Property Type
intended_use Integer See Intended Use
payment_type Integer Payment Type is either CMS
contacts Array Please see table below for more information on contacts

Contacts

Parameter Type Description
type String See Contact Types
firstname String First Name of Contact
lastname String Last Name of Contact
email String Email
email2 String Secondary Email
address String Address
city String City
state String State
zip String Zip Code
county String County
phones String Please see table below for more information on Contacts - Phones

Contacts - Phones

Parameter Type Description
type String See Contact Phone Types
number Integer 7 Digit Phone Number
extension Integer Extension

This endpoint retrieves all kittens.

HTTP Request

GET http://api.appraisalflo.com/api/order

Get Payments

require 'kittn'

api = Kittn::APIClient.authorize!('AUTHKEY')
api.kittens.get_order

import kittn

api = kittn.authorize('AUTHKEY')
api.kittens.get()

curl "http://api.appraisalflo.com/api/order" \
  -H "Authorization: AUTHKEY"

const kittn = require('kittn');

let api = kittn.authorize('AUTHKEY');
let kittens = api.kittens.get();

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "get_payments",
    "created_datetime": ""
  }
}

This event will pull down all payments

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

The above command returns JSON structured like this:

{
  "data":  {
    "payments":                   [
      {
        "id":               "",
        "created_datetime": "",
        "type":             "",
        "description":      "",
        "amount":           ""
      }
    ]
  }
}

Data

Parameter Type Description
payment Array Please see table below for more information on Payments

Payment

Parameter Type Description
id String Unique ID
created_datetime String TimeStamp of when the payment was made
type String Value can either be Credit
description String Payment Description
amount Float Payment Amount

HTTP Request

GET http://api.appraisalflo.com/api/order

Get Comments

require 'kittn'

api = Kittn::APIClient.authorize!('AUTHKEY')
api.kittens.get_order

import kittn

api = kittn.authorize('AUTHKEY')
api.kittens.get()

curl "http://api.appraisalflo.com/api/order" \
  -H "Authorization: AUTHKEY"

const kittn = require('kittn');

let api = kittn.authorize('AUTHKEY');
let kittens = api.kittens.get();

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "get_comments",
    "created_datetime": ""
  }
}

This event will pull down all comments

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

The above command returns JSON structured like this:

{
  "data":  {
    "comments": [
      {
        "id":      "",
        "created_datetime": "",
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}

Data

Parameter Type Description
comments Array Please see table below for more information on Comments

Comments

Parameter Type Description
id String Unique Identifer
created_datetime String TimeStamp of when the comment was made
name String User who made the comment (Messages from the system will be marked as "SYSTEM")
subject String Subject of the message
body base64 Body of the message

HTTP Request

GET http://api.appraisalflo.com/api/order

Get Documents

require 'kittn'

api = Kittn::APIClient.authorize!('AUTHKEY')
api.kittens.get_order

import kittn

api = kittn.authorize('AUTHKEY')
api.kittens.get()

curl "http://api.appraisalflo.com/api/order" \
  -H "Authorization: AUTHKEY"

const kittn = require('kittn');

let api = kittn.authorize('AUTHKEY');
let kittens = api.kittens.get();

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "get_documents",
    "created_datetime": ""
  }
}

This event will pull down all documents

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

The above command returns JSON structured like this:

{
  "data":  {
    "documents":                  [
      {
        "id":               "",
        "created_datetime": "",
        "name":             "",
        "extension":        "",
        "type":             "",
        "data":             ""
      }
    ]
  }
}

Data

Parameter Default Description
documents Array Please see table below for more information on Documents

Documents

Parameter Type Description
id String Unique ID
created_datetime String TimeStamp of when the payment was made
name String Document Name (including extension)
extension String Document Extension
type String See Document Types
data base64 Document data base64 encoded

HTTP Request

GET http://api.appraisalflo.com/api/order

Accepted

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "accepted"
  },
  "data": {
    "comments": [
      {
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
comments Array For more information on comments section click here

Declined

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "declined"
  },
  "data": {
    "comments": [
      {
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
comments Array For more information on comments section click here

Vendor Assigned

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "vendor_assigned"
  },
  "data": {
    "comments": [
      {
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
comments Array For more information on comments section click here

Vendor Accepted

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "vendor_accepted"
  },
  "data": {
    "comments": [
      {
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
comments Array For more information on comments section click here

Vendor Declined

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "vendor_declined"
  },
  "data": {
    "comments": [
      {
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
comments Array For more information on comments section click here

Modification Request

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "modification_request"
  },
  "data": {
    "comments": [
      {
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ],
    "modification_request": {
      "due_date": "",
      "fee":      "",
      "type":     "",
      "comment":  ""
    }
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
comments Array For more information on comments section click here
modification_request Array Please see table below for more information on Modification Requests

Data

Parameter Default Description
due_date date Due Date
fee float Fee
type String Type of Modification Request
comment String Comment

Inspection Scheduled

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "inspection_scheduled"
  },
  "data": {
    "inspection_scheduled_date": ""
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
inspection_scheduled_date Date Inspection Scheduled Date

Inspection Completed

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "inspection_completed"
  },
  "data": {
    "inspection":         {
      "date": ""
    }
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
inspection_completed_date Date Inspection Completed Date

Received

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "received"
  },
  "data": {
    "comments": [
      {
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
comments Array For more information on comments section click here

Delivered

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "delivered"
  },
  "data": {
    "comments": [
      {
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ],
    "documents": [
      {
        "name":      "",
        "extension": "",
        "type":      "",
        "data":      ""
      }
    ]
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
comments Array For more information on comments section click here
documents Array Please see table below for more information on Documents

Documents

Parameter Type Description
name String Document Name (including extension)
extension String Document Extension
type String See Document Types
data base64 Document data base64 encoded

Payment

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "payment"
  },
  "data": {
    "payment": {
      "id":          "",
      "type":        "",
      "description": "",
      "amount":      ""
    }
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
payment Array Please see table below for more information on Payment

Payment

Parameter Type Description
type String Value can either be Credit
description String Payment Description
amount Float Payment Amount

AMC Comments

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "comment"
  },
  "data": {
    "comments": [
      {
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Type Description
comments Array Please see table below for more information on Comments

Comments

Parameter Type Description
name String User who made the comment (Messages from the system will be marked as "SYSTEM")
subject String Subject of the message
body base64 Body of the message

Documents

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "documents"
  },
  "data": {
    "documents": [
      {
        "name":      "",
        "extension": "",
        "type":      "",
        "data":      ""
      }
    ]
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
documents Array Please see table below for more information on Documents

Documents

Parameter Type Description
name String Document Name (including extension)
extension String Document Extension
type String See Document Types
data base64 Document data base64 encoded

On Hold

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "on_hold"
  },
  "data": {
    "comments": [
      {
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
comments Array For more information on comments section click here

Resume

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "created_datetime": "",
    "request":          "resume"
  },
  "data": {
    "comments": [
      {
        "name":    "",
        "subject": "",
        "body":    ""
      }
    ]
  }
}

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

Data

Parameter Default Description
comments Array For more information on comments section click here

Get Lists

require 'kittn'

api = Kittn::APIClient.authorize!('AUTHKEY')
api.kittens.get_order

import kittn

api = kittn.authorize('AUTHKEY')
api.kittens.get()

curl "http://api.appraisalflo.com/api/order" \
  -H "Authorization: AUTHKEY"

const kittn = require('kittn');

let api = kittn.authorize('AUTHKEY');
let kittens = api.kittens.get();

{
  "event": {
    "token":            "",
    "provider_id":      "",
    "order_id":         "",
    "request":          "get_payments",
    "created_datetime": ""
  }
}

This event will pull down all lists

Event

For more information on event section click here

HTTP Request

http://api.appraisalflo.com/api/order

The above command returns JSON structured like this:

{
  "data":  {
    "definitions": {
      "products":                   [
        {
          "id":          "",
          "title":       "",
          "description": ""
        }
      ],
      "contact_types":              [],
      "contact_sub_types":          [],
      "document_types":             [
        {
          "id":   "",
          "name": ""
        }
      ],
      "loan_types":                 [
        {
          "id":   "",
          "name": ""
        }
      ],
      "occupancy_status":           [
        {
          "id":   "",
          "name": ""
        }
      ],
      "purchase_types":             [
        {
          "id":   "",
          "name": ""
        }
      ],
      "property_types":             [
        {
          "id":   "",
          "name": ""
        }
      ],
      "intended_use":               [
        {
          "id":   "",
          "name": ""
        }
      ],
      "declined_types":             [],
      "payment_types":              [],
      "modification_request_types": []
    }
  }
}

Data

Parameter Type Description
products Array Please see table below for more information on Products
contact_types Array Please see table below for more information on Generic List
document_types Array Please see table below for more information on Generic List
loan_types Array Please see table below for more information on Generic List
occupancy_status Array Please see table below for more information on Generic List
purchase_types Array Please see table below for more information on Generic List
property_types Array Please see table below for more information on Generic List
intended_use Array Please see table below for more information on Generic List

Products

Parameter Type Description
id String Unique ID
Title String Name of Product
description String Product Description

AMC Generic List

Parameter Type Description
id Integer Unique ID
name String Name of the item

HTTP Request

GET http://api.appraisalflo.com/api/order

Errors

The Kittn API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The kitten requested is hidden for administrators only.
404 Not Found -- The specified kitten could not be found.
405 Method Not Allowed -- You tried to access a kitten with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
410 Gone -- The kitten requested has been removed from our servers.
418 I'm a teapot.
429 Too Many Requests -- You're requesting too many kittens! Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.
shell ruby python javascript