Revisions

Revisions are a way to request revision for the appraisal orders. You can either request a regular revision or a reconsideration of value.

PUT/api/v1/orders/{order_id}/request_revision

Request revision

This endpoint allows you to request a regular appraisal order revision. It is a x-www-form-urlencoded request.

URL attributes

  • Name
    order_id
    Type
    string required
    Description

    The order id.

Form attributes

  • Name
    comments
    Type
    string required
    Description

    The comments for the revision.

  • Name
    attachments
    Type
    array
    Description

    An array of attachments. Each attachment should be a file object.

Request

PUT
/api/v1/orders/{order_id}/orders
curl --location --request PUT 'https://app.collateralxp.com/api/v1/orders/d54008ce-90e5-4012-8a10-4fcbc786ae5f/request_revision' \
  --header 'X-API-KEY: {api_key}' \
  --form 'comments="Hay"' \
  --form 'attachments[]=@"/comps.pdf"'

Response

{
  "success": true
}
PUT/api/v1/orders/{order_id}/request_reconsideration_of_value

Request a reconsideration of value

This endpoint allows you to request a reconsideration of value. It is a form-data request.

URL attributes

  • Name
    order_id
    Type
    string required
    Description

    The order id.

Form attributes

  • Name
    reason
    Type
    string required
    Description

    Reason enum value. Possible values are alternate_closed_sales general_errors subject_errors.

  • Name
    summary
    Type
    string required
    Description

    Summary of the reconsideration of value.

  • Name
    supporting_data
    Type
    string
    Description

    Supporting data for the reconsideration of value.

  • Name
    attachments
    Type
    array
    Description

    An array of attachments. Each attachment should be a file object.

Request

PUT
/api/v1/orders/{order_id}/request_reconsideration_of_value
curl --location --request PUT 'http://localhost:3000/api/v1/orders/d54008ce-90e5-4012-8a10-4fcbc786ae5f/request_reconsideration_of_value' \
  --header 'X-API-KEY: {api_key}' \
  --form 'reason="alternate_closed_sales"' \
  --form 'summary="Test"' \
  --form 'supporting_data="A,B,C"' \
  --form 'attachments[]=@"/comps.pdf"'

Response

{
  "success": true
}