Other/API Reference - Ideal Postcodes

Retrieve by UMPRN

v1.0.0

Returns a multiple occupancy address identifited via its UMPRN (Multiple Residence Unique ID).

UMPRNs are a unique numeric code for any Multiple Residence household on the optional Multiple Residence dataset.

Testing

To test your implementation of our API we have a range of test UMPRNs that yield both successful and unsuccessful responses to your request. They are the following

0 Returns a successful UMPRN lookup response 2000
-1 Returns "UMPRN not found", error 4044
-2 Returns "no lookups remaining", error 4020
-3 Returns "daily (or individual) lookup limit breached", error 4021

Test request undergo the usual authentication and restriction rules. This is to help surface any issues that occur during implementation and does not cost you a lookup.

Pricing

Per lookup charges apply. Empty responses are not charged.

Input

{
  "type": "object",
  "properties": {
    "filter": {
      "type": "string",
      "description": "Comma separated whitelist of address elements to return. \n\nE.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3` address elements in your response\n"
    },
    "umprn": {
      "type": "string"
    }
  },
  "required": [
    "umprn"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "code",
    "message",
    "result"
  ],
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32",
      "enum": [
        2000
      ]
    },
    "message": {
      "type": "string",
      "enum": [
        "Success"
      ]
    },
    "result": {
      "type": "object"
    }
  }
}