> For the complete documentation index, see [llms.txt](https://docs.altum.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.altum.ai/taxeren-en-waarderen/woningwaarde-api/authentication-input-and-response.md).

# Authenticatie, invoer en resultaat

## Plaats objectgegevens om een nauwkeurige geautomatiseerde modelwaardering te ontvangen.

<mark style="color:green;">`POST`</mark> `https://api.altum.ai/avm`

Met dit eindpunt kunt u antwoord ontvangen van het Altum AI AVM-model.

#### Headers

| Name                                           | Type   | Description                                                                                                               |
| ---------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------- |
| Content-Type<mark style="color:red;">\*</mark> | string | application/json                                                                                                          |
| x-api-key<mark style="color:red;">\*</mark>    | string | Unieke API-sleutel van Altum. Maak er een via het platform op [https://platform.altum.ai](https://platform.altum.ai/auth) |

#### Request Body

| Name                                          | Type    | Description                                       |
| --------------------------------------------- | ------- | ------------------------------------------------- |
| postcode<mark style="color:red;">\*</mark>    | string  | Postcode van het object                           |
| image                                         | boolean | Afbeelding van object ophalen, 0 of 1             |
| buildyear                                     | integer | Jaar van constructie                              |
| innersurfacearea                              | integer | Vierkante meter (m2) binnenoppervlakte            |
| outersurfacecarea                             | integer | Vierkante meter (m2) buitenoppervlakte            |
| energylabel                                   | string  | Energielabel A t/m G                              |
| housetype                                     | string  | Woningtype van het object                         |
| valuationdate                                 | string  | Waarderingsdatum (standaard is datum van boeking) |
| houseaddition                                 | string  | Huisbrieven en/of toevoegingen                    |
| housenumber<mark style="color:red;">\*</mark> | number  | Huisnummer                                        |

{% tabs %}
{% tab title="200: OK Succesvolle reactie" %}

```
{
    "Output": {
        "BagID": "0637010021364937",
        "PostCode": "1234AB",
        "HouseNumber": "1",
        "HouseAddition": null,
        "City": "Woonplaats",
        "Street": "Straatnaam",
        "HouseType": "Tussenwoning",
        "BuildYear": "2001",
        "InnerSurfaceArea": "121",
        "OuterSurfaceArea": "136",
        "Volume": "429",
        "EnergyLabel": null,
        "Longitude": "4.524624609",
        "Latitude": "52.070925901563704",
        "Rooms": null,
        "Image": null,
        "ValuationDate": "20200326",
        "PriceEstimation": "355012",
        "Confidence": "90% Confidence Interval is 327363-429880."
    }
}
```

{% endtab %}

{% tab title="400: Bad Request Mislukte reactie" %}

```
{
  "Output": "The given house address not found in database, the combination of Post Code, House Number and House Addition does not exist."
}

{
  'Unsupported evaluation date format, it should be YYYYMMDD.'
}

{
  'The evaluation date range should be from {} and until {}.'
}

{
  'Output': 'The given house type is unsupported or unknown.'
}

{
  'Output': 'The prediction is too low.'
}
```

{% endtab %}

{% tab title="401: Unauthorized Geen toegang" %}

```
{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}
```

{% endtab %}

{% tab title="403: Forbidden Verboden" %}

```
{
	"message": "Missing Authentication Token"
}
```

{% endtab %}

{% tab title="500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar" %}

```
{
	"message": "Internal server error"
}
```

{% endtab %}

{% tab title="422: Unprocessable Entity Verkeerd invoerformaat" %}

```
{
  "detail": [
    {
      "loc": [
        "body",
        "postcode"
      ],
      "msg": "string does not match regex \"^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$\"",
      "type": "value_error.str.regex",
      "ctx": {
        "pattern": "^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$"
      }
    }
  ]
}
```

{% endtab %}

{% tab title="429: Too Many Requests API-sleutellimiet overschreden" %}

{% endtab %}
{% endtabs %}

## Request body

#### Voorbeeld verzoek

```
{
   "postcode" : "1234AB",
   "housenumber" : "5",
   "houseaddition" : "",
   "valuationdate" : "20200326",
   "image": 1,
   "buildyear": 2000,
   "innersurfacearea": 150,
   "outersurfacearea": 100,
   "energylabel": "B",
   "housetype": "Vrijstaande woning"
}
```

## &#x20;Up next:

{% content-ref url="/pages/-LwNf4yZXvEbM\_g-RwmB" %}
[Parameters](/taxeren-en-waarderen/woningwaarde-api/variables.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.altum.ai/taxeren-en-waarderen/woningwaarde-api/authentication-input-and-response.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.