Identifier

Query identifer

get

Query by identifier and find its associated IDs. May return more than one set of links due to the namespace overlap between UPRNs and USRNs.

Authorizations

ApiKeyAuthOAuth2

Path parameters

idstring · min: 1 · max: 36required

ID of the feature that is being matched

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.os.uk/search/links/v1/identifiers/{id}'

200

400

401

403

404

405

429

500

503

200

{
  "linkedIdentifiers": [
    {
      "linkedIdentifier": {
        "identifier": "text",
        "featureType": "BLPU",
        "identifierType": "GUID"
      },
      "correlations": [
        {
          "searchedIdentifierVersionDate": "text",
          "searchedIdentifierVersionNumber": 1,
          "correlationMethodIdentifier": "RoadLink_TOID_TopographicArea_TOID_2",
          "correlatedFeatureType": "BLPU",
          "correlatedIdentifierType": "GUID",
          "correlatedIdentifiers": [
            {
              "identifier": "text",
              "versionNumber": 1,
              "versionDate": "text",
              "confidence": "text",
              "correlationIdentifier": "text"
            }
          ]
        }
      ]
    }
  ]
}

Search results matching criteria