getOrder

GET

/api/v2/public/valuation/order/{id}

Returns a valuation or loan-quote request created by createOrder, with its current status. Only the user who placed the order can read it.

Reference

Copy as Markdown

Auth: X-API-KEY: <your key> header

Use when: After createOrder, to check whether the valuation or loan quote is ready.

Don't use when: Checking more than once a minute.

Parameters

Name	In	Type	Required	Description
`id`	path	integer	yes	Request id (`data.id` from `createOrder`).

Notes for agents

Check at most once a minute.
Stop when status is COMPLETED or REJECTED; both are final. Report statusLabel and any message to the user.
Only the user who placed the order can read it. A 404 means the request does not exist or belongs to another user.

Example request

curl https://app.smartcapitalcenter.com/api/v2/public/valuation/order/98765 \
  -H "X-API-KEY: $SCC_API_KEY"

Response `200`

Request found; data is the request.

Standard envelope with data in the same shape as the createOrder response. The fields you need most:

Field	Type	Description
`id`	integer	Request id.
`propertyId`	integer	Numeric property id the request belongs to.
`type`	string	Request type: `VALUATION` (detailed valuation, orderType FULL) or `LOAN` (loan quote). The schema also lists `SPREADING`, which this API never creates.
`typeLabel`	string	Human-readable request type.
`status`	string	Processing status. `COMPLETED` and `REJECTED` are final; see `createOrder` for every value.
`statusLabel`	string	Human-readable status.
`documents`	array	Documents attached to the request.
`createdAtTimestamp`	string	When the request was created.
`updatedAtTimestamp`	string	When the request last changed.
`completedAtTimestamp`	string	Set once the request is `COMPLETED`.
`message`	string	Message from the analyst, if any.

Errors

Code	Meaning
404	Request not found or not owned by the caller

# getOrder `GET /api/v2/public/valuation/order/{id}` Returns a valuation or loan-quote request created by `createOrder`, with its current status. Only the user who placed the order can read it. **Auth:** `X-API-KEY: <your key>` header **Use when:** After `createOrder`, to check whether the valuation or loan quote is ready. **Don't use when:** Checking more than once a minute. ## Parameters | Name | In | Type | Required | Description | |---|---|---|---|---| | `id` | path | integer | yes | Request id (`data.id` from `createOrder`). | ## Notes for agents - Check at most once a minute. - Stop when `status` is `COMPLETED` or `REJECTED`; both are final. Report `statusLabel` and any `message` to the user. - Only the user who placed the order can read it. A `404` means the request does not exist or belongs to another user. ## Example request ```bash curl https://app.smartcapitalcenter.com/api/v2/public/valuation/order/98765 \ -H "X-API-KEY: $SCC_API_KEY" ``` ## Response `200` Request found; `data` is the request. Standard envelope with `data` in the same shape as the `createOrder` response. The fields you need most: | Field | Type | Description | |---|---|---| | `id` | integer | Request id. | | `propertyId` | integer | Numeric property id the request belongs to. | | `type` | string | Request type: `VALUATION` (detailed valuation, orderType FULL) or `LOAN` (loan quote). The schema also lists `SPREADING`, which this API never creates. | | `typeLabel` | string | Human-readable request type. | | `status` | string | Processing status. `COMPLETED` and `REJECTED` are final; see `createOrder` for every value. | | `statusLabel` | string | Human-readable status. | | `documents` | array | Documents attached to the request. | | `createdAtTimestamp` | string | When the request was created. | | `updatedAtTimestamp` | string | When the request last changed. | | `completedAtTimestamp` | string | Set once the request is `COMPLETED`. | | `message` | string | Message from the analyst, if any. | ## Errors | Code | Meaning | |---|---| | 404 | Request not found or not owned by the caller |