GET Report

https://api.geowox.com/assignment/report?country_code=ie&application_id=<application_id>

It returns all data related to a specific assignment linked to a borrower request. It gets as input parameter the specific application_id attached to a request coming from the booking flow widget.

  • string country_code (required)

    • Accepted parameters: ie

  • string application_id (required)

    • Custom lender's application id added as parameter URL in the booking widget

Below a list of values returned by the API call.

Value

Description

application_id

Custom application id from the client

status_code and status_name

It can have 2 values based on the status of the current assignment:

  • If the assignment is still in progress (meaning, not yet completed and signed)

    • status_code=VALUATION_PENDING

    • status_name="Valuation pending to complete"

  • If the assignment is complete and signed

    • status_code=VALUATION_READY

    • status_name="Valuation completed and signed-off report ready"

request_uuid

Request identifier for logging purpose

result

The result object contains all the hard data and details of the current valuation assignment. See details below.

report_url

Report URL signed-off by the valuer.

The URL is:

  • Signed (not publicly accessible)

  • Valid for only 7 days

report_generated_date

The date the report has been created

effective_date

The valuation date

market_value

Valuer's market value for the specific subject property

currency

Currency used. Default "euro"

area_measure

Unit system. Default "sqm"

date_format

All dates format. Default "YYYY-MM-DD"

subject_property

Subject property characteristics

comp_properties

Array of the comps (with characteristics and transaction details) selected by the valuer

Example

Request

curl --request GET \
-H 'Authorization: Bearer <VERY_LONG_ACCESS_TOKEN>' \
-H 'x-api-key: <API_KEY>'
https://api.geowox.com/assignment/report?country_code=ie&application_id=test_123

Response

{ "status_code": "VALUATION_READY",
"status_name": "Valuation completed and signed-off report ready",
"result": {
"report_url": "https://...",
"report_generated_date": "2022-05-12",
"effective_date": "2022-05-12",
"market_value": 950000.0,
"valuation_purpose": "secure lending",
"currency": "euro",
"area_measure": "sqm",
"date_format": "YYYY-MM-DD",
"subject_property": {
"address": "14 heytesbury lane ballsbridge dublin 4 dublin",
"eircode": "D04R1H2",
"floor_area_value": 149.0,
"lot_area_value": null,
"storey_value": 2,
"bedroom_value": 3,
"bathroom_value": 2,
"year_built_value": null,
"property_type_name": "mid terrace",
"development": "existing dwelling",
"energy_rating_class": null
},
"comp_properties": [ {
"address": "38 heytesbury lane dublin 4 d04 w2t6",
"eircode": "D04W2T6",
"floor_area_value": 133.0,
"lot_area_value": null,
"storey_value": null,
"bedroom_value": 4,
"bathroom_value": 2,
"year_built_value": null,
"transaction_type": "sold",
"transaction_date": "2021-07-30",
"transaction_value": 1450000.0,
"development": "existing dwelling",
"property_type_name": "detached" },
{...},
{...}]
}
}

Status codes

Value

Reason

Message

200

-

-

400

Missing country_code=ie from the request params

The country code is missing or it's not in the correct format

400

Missing application_id from the request params

The application id is missing

400

API key is not connected with the company

The company is missing or it's not connected with api key

400

Request or project are not available

The request or project is missing

404

Valuation request has been created but not the assignment

The assignment is missing

404

Missing country_code=ie and application_id

No value has been found

500

Unknown error

Unknown error

Did this answer your question?