The authentication token you've provided is incorrect. Sign in to the Self Service Portal to find the right token.\n",
"headers": {
"Transaction-Id": {
"$ref": "#/components/headers/Transaction-Id"
},
"Reference-Id": {
"$ref": "#/components/headers/Reference-Id"
}
}
},
"500": {
"description": "Internal Server Error
An unexpected server error was encountered. Try submitting another request. If the issue persists, contact support.\n",
"headers": {
"Transaction-Id": {
"$ref": "#/components/headers/Transaction-Id"
},
"Reference-Id": {
"$ref": "#/components/headers/Reference-Id"
}
}
},
"403": {
"description": "Forbidden \n * The authentication token you've provided is valid, but it's associated with another product or you have insufficient credits. Sign in to the Self Service Portal to check if you are using the right token and if you have credits. \n * The authentication token you've provided is disabled. Sign in to the Self Service Portal to activate the token. \n * The domain you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the domain.\n * The IP address you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the IP address.\n",
"headers": {
"Transaction-Id": {
"$ref": "#/components/headers/Transaction-Id"
},
"Reference-Id": {
"$ref": "#/components/headers/Reference-Id"
}
}
},
"404": {
"description": "Not Found
The resource you've requested could not be found. Try submitting another call and make sure you're using the correct endpoint URL. If the issue persists, contact support.\n",
"headers": {
"Transaction-Id": {
"$ref": "#/components/headers/Transaction-Id"
},
"Reference-Id": {
"$ref": "#/components/headers/Reference-Id"
}
}
},
"415": {
"description": "Unsupported Media Type
You've specified an invalid Content-Type header. Try submitting another call and make sure you specify a valid Content-Type value. Check out Supported data formats for details.\n",
"headers": {
"Transaction-Id": {
"$ref": "#/components/headers/Transaction-Id"
},
"Reference-Id": {
"$ref": "#/components/headers/Reference-Id"
}
}
},
"503": {
"description": "Service Unavailable
The service is currently unavailable. You can check the API's uptime and downtime by going to the service status page.\n",
"headers": {
"Transaction-Id": {
"$ref": "#/components/headers/Transaction-Id"
},
"Reference-Id": {
"$ref": "#/components/headers/Reference-Id"
}
}
},
"406": {
"description": "Not Acceptable
You've specified an invalid Accept header. Try submitting another call and make sure you specify a valid Accept value. Check out Supported data formats for details.\n",
"headers": {
"Transaction-Id": {
"$ref": "#/components/headers/Transaction-Id"
},
"Reference-Id": {
"$ref": "#/components/headers/Reference-Id"
}
}
},
"429": {
"description": "Too Many Requests
You've submitted too many requests. To protect all customers, your account has been temporarily throttled. Check out Rate limiting for details.\n",
"headers": {
"Transaction-Id": {
"$ref": "#/components/headers/Transaction-Id"
},
"Reference-Id": {
"$ref": "#/components/headers/Reference-Id"
}
}
},
"408": {
"description": "Request Timeout
Your request has timed out (the web server failed to respond in the specified time frame). Try submitting another request.\n",
"headers": {
"Transaction-Id": {
"$ref": "#/components/headers/Transaction-Id"
},
"Reference-Id": {
"$ref": "#/components/headers/Reference-Id"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailValidationV2Response"
},
"example": {
"result": {
"confidence": "unknown",
"verbose_output": "timeout",
"email": "example@test.com"
},
"metadata": {
"normalized_email": "example@test.com"
}
}
}
}
}
},
"security": [
{
"OAuth2": []
},
{
"Auth-Token": []
}
]
}
}
},
"components": {
"schemas": {
"Address7Lines": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "The first line of address containing a number of specific components relating to the premises and street.",
"nullable": true,
"example": "1 Main Street"
},
"address_line_2": {
"type": "string",
"description": "The second line of address containing a number of specific components relating to the premises and street.",
"nullable": true
},
"address_line_3": {
"type": "string",
"description": "The third line of address containing a number of specific components relating to the premises and street.",
"nullable": true
},
"locality": {
"type": "string",
"description": "The town, locality or suburb.",
"nullable": true,
"example": "MELBOURNE"
},
"region": {
"type": "string",
"description": "The city, state code or province.",
"nullable": true,
"example": "VIC"
},
"postal_code": {
"type": "string",
"description": "The post/zip code.",
"nullable": true,
"example": "3004"
},
"country": {
"type": "string",
"description": "The localised country name.",
"nullable": true,
"example": "AUSTRALIA"
}
},
"additionalProperties": false,
"description": "Seven address lines representing a formatted address for the chosen country."
},
"AddressComponent": {
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "Address language.",
"nullable": true,
"example": "en-GB"
},
"country_name": {
"type": "string",
"description": "The name of the country where the address is located.",
"nullable": true,
"example": "United Kingdom"
},
"country_iso_3": {
"type": "string",
"description": "The 3-letter ISO country code.",
"nullable": true,
"example": "GBR"
},
"country_iso_2": {
"type": "string",
"description": "The 2-letter ISO country code.",
"nullable": true,
"example": "GB"
},
"country_iso_numeric": {
"type": "string",
"description": "The numeric ISO country code.",
"nullable": true,
"example": "780"
},
"postal_code": {
"$ref": "#/components/schemas/AddressComponentPostalCode"
},
"delivery_service": {
"$ref": "#/components/schemas/AddressComponentDeliveryService"
},
"secondary_delivery_service": {
"$ref": "#/components/schemas/AddressComponentDeliveryService"
},
"sub_building": {
"$ref": "#/components/schemas/AddressComponentSubBuilding"
},
"building": {
"$ref": "#/components/schemas/AddressComponentBuilding"
},
"organization": {
"$ref": "#/components/schemas/AddressComponentOrganization"
},
"street": {
"$ref": "#/components/schemas/AddressComponentStreet"
},
"secondary_street": {
"$ref": "#/components/schemas/AddressComponentStreet"
},
"route_service": {
"$ref": "#/components/schemas/AddressComponentRouteService"
},
"locality": {
"$ref": "#/components/schemas/AddressComponentLocality"
},
"physical_locality": {
"$ref": "#/components/schemas/AddressComponentLocality"
},
"additional_elements": {
"$ref": "#/components/schemas/AddressComponentAdditionalElements"
}
},
"additionalProperties": false,
"description": "The components that differ by country and address type. Note that parameters with blank values will not be returned."
},
"AddressComponentAdditionalElements": {
"type": "object",
"properties": {
"locality": {
"$ref": "#/components/schemas/AddressComponentAdditionalLocality"
}
},
"additionalProperties": false,
"description": "The additional elements component."
},
"AddressComponentAdditionalLocality": {
"type": "object",
"properties": {
"sub_region": {
"$ref": "#/components/schemas/AddressComponentAdditionalSubRegion"
}
},
"additionalProperties": false,
"description": "The additional locality component."
},
"AddressComponentAdditionalSubRegion": {
"type": "object",
"properties": {
"administrative_county": {
"type": "string",
"description": "The name of the administratve county.",
"nullable": true,
"example": "North Yorkshire"
},
"former_postal_county": {
"type": "string",
"description": "The name of the former postal county.",
"nullable": true,
"example": "North Yorkshire"
},
"traditional_county": {
"type": "string",
"description": "The name of the traditional county.",
"nullable": true,
"example": "Yorkshire"
}
},
"additionalProperties": false,
"description": "The additional sub region component."
},
"AddressComponentBuilding": {
"type": "object",
"properties": {
"building_name": {
"type": "string",
"description": "The building name.",
"nullable": true,
"example": "Sir John Peace Building"
},
"secondary_name": {
"type": "string",
"description": "The secondary building name.",
"nullable": true
},
"building_number": {
"type": "string",
"description": "The building number.",
"nullable": true,
"example": "549"
},
"secondary_number": {
"type": "string",
"description": "The secondary name of the building (if available).",
"nullable": true
},
"allotment_number": {
"type": "string",
"description": "The allotment name where a person or property resides.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The building component."
},
"AddressComponentBusinessOrganization": {
"type": "object",
"properties": {
"company_name": {
"type": "string",
"description": "The company name from an additional business dataset.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The business component."
},
"AddressComponentDeliveryService": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"description": "The full name of the delivery service.",
"nullable": true
},
"service_type": {
"type": "string",
"description": "The delivery service type.",
"nullable": true
},
"service_number": {
"type": "string",
"description": "The delivery service number.",
"nullable": true
},
"post_centre_name": {
"type": "string",
"description": "The delivery service post center name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The delivery service component."
},
"AddressComponentLocality": {
"type": "object",
"properties": {
"region": {
"$ref": "#/components/schemas/AddressComponentLocalityItem"
},
"sub_region": {
"$ref": "#/components/schemas/AddressComponentLocalityItem"
},
"town": {
"$ref": "#/components/schemas/AddressComponentLocalityItem"
},
"district": {
"$ref": "#/components/schemas/AddressComponentLocalityItem"
},
"sub_district": {
"$ref": "#/components/schemas/AddressComponentLocalityItem"
}
},
"additionalProperties": false,
"description": "The locality component."
},
"AddressComponentLocalityItem": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name for this subcomponent.",
"nullable": true,
"example": "NOTTINGHAM"
},
"code": {
"type": "string",
"description": "The code of this subcomponent.",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of this subcomponent.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A single place name, code and a description of its type."
},
"AddressComponentOrganization": {
"type": "object",
"properties": {
"department_name": {
"type": "string",
"description": "The department name within an organization.",
"nullable": true
},
"secondary_department_name": {
"type": "string",
"description": "The secondary department name within an organization.",
"nullable": true
},
"company_name": {
"type": "string",
"description": "The company name.",
"nullable": true
},
"business": {
"$ref": "#/components/schemas/AddressComponentBusinessOrganization"
}
},
"additionalProperties": false,
"description": "The organization component."
},
"AddressComponentPostalCode": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"description": "The full name of the postal code.",
"nullable": true,
"example": "92626-7037"
},
"primary": {
"type": "string",
"description": "The primary name of the postal code.",
"nullable": true,
"example": "92626"
},
"secondary": {
"type": "string",
"description": "The secondary name of the postal code.",
"nullable": true,
"example": "7037"
}
},
"additionalProperties": false,
"description": "The post code component."
},
"AddressComponentRouteService": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"description": "The full name of the route service.",
"nullable": true
},
"service_type": {
"type": "string",
"description": "The route service type.",
"nullable": true
},
"service_number": {
"type": "string",
"description": "The route service number.",
"nullable": true
},
"delivery_name": {
"type": "string",
"description": "The route service delivery name.",
"nullable": true
},
"qualifier": {
"type": "string",
"description": "The route service qualifier.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The route service component."
},
"AddressComponentStreet": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"description": "The combination of the other populated secondary street components: prefix, name, type, suffix.",
"nullable": true,
"example": "Summer St"
},
"prefix": {
"type": "string",
"description": "The street prefix only.",
"nullable": true
},
"name": {
"type": "string",
"description": "The street name only.",
"nullable": true,
"example": "Summer"
},
"type": {
"type": "string",
"description": "The street type only.",
"nullable": true,
"example": "St"
},
"suffix": {
"type": "string",
"description": "The street suffix only.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The street component."
},
"AddressComponentSubBuilding": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of a building or property.",
"nullable": true
},
"entrance": {
"$ref": "#/components/schemas/AddressComponentSubBuildingItem"
},
"floor": {
"$ref": "#/components/schemas/AddressComponentSubBuildingItem"
},
"door": {
"$ref": "#/components/schemas/AddressComponentSubBuildingItem"
}
},
"additionalProperties": false,
"description": "The sub building component."
},
"AddressComponentSubBuildingItem": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"description": "The full name of this subcomponent.",
"nullable": true,
"example": "L 6"
},
"type": {
"type": "string",
"description": "The type of this subcomponent.",
"nullable": true,
"example": "L"
},
"value": {
"type": "string",
"description": "The value of this subcomponent.",
"nullable": true,
"example": "6"
}
},
"additionalProperties": false,
"description": "An item of sub-building information, such as a floor or entrance number or name."
},
"AddressDatasetElement": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the dataset.",
"nullable": true,
"example": "au-address-datafusion"
},
"name": {
"type": "string",
"description": "The name of the dataset.",
"nullable": true,
"example": "Australia Enhanced Address"
}
},
"additionalProperties": false,
"description": "Address dataset element."
},
"AddressDatasetsCountryResult": {
"type": "object",
"properties": {
"country_iso_3": {
"type": "string",
"description": "The country ISO3 code.",
"nullable": true,
"example": "GBR"
},
"country_name": {
"type": "string",
"description": "The country name.",
"nullable": true,
"example": "United Kingdom"
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressDatasetElement"
},
"description": "The available datasets.",
"nullable": true
},
"valid_combinations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "The combination of valid datasets.",
"nullable": true,
"example": [
[
"gb-additional-electricity",
"gb-additional-gas"
],
[
"gb-additional-names",
"gb-additional-notyetbuilt"
]
]
}
},
"additionalProperties": false,
"description": "Address dataset result."
},
"AddressDatasetsV1Response": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressDatasetsCountryResult"
},
"description": "The address datasets V1 result.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response model for AddressDatasetsV1 endpoint."
},
"AddressEnrichment": {
"type": "object",
"properties": {
"geocodes": {
"$ref": "#/components/schemas/AddressEnrichmentGeocodes"
}
},
"additionalProperties": false,
"description": "Address validate enrichment."
},
"AddressEnrichmentGeocodes": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "The latitude.",
"format": "double",
"nullable": true,
"example": 52.9413
},
"longitude": {
"type": "number",
"description": "The longitude.",
"format": "double",
"nullable": true,
"example": 1.16312
},
"match_level": {
"type": "string",
"description": "Specifies the accuracy of the coordinates for the specified address.",
"nullable": true,
"example": "Premises"
}
},
"additionalProperties": false,
"description": "The enrichment geocodes result."
},
"AddressFormatV1Components": {
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "Address language.",
"nullable": true,
"example": "en-GB"
},
"country_name": {
"type": "string",
"description": "The name of the country where the address is located.",
"nullable": true,
"example": "United Kingdom"
},
"country_iso_3": {
"type": "string",
"description": "The 3-letter ISO country code.",
"nullable": true,
"example": "GBR"
},
"country_iso_2": {
"type": "string",
"description": "The 2-letter ISO country code.",
"nullable": true,
"example": "GB"
},
"country_iso_numeric": {
"type": "string",
"description": "The numeric ISO country code.",
"nullable": true,
"example": "780"
},
"postal_code": {
"$ref": "#/components/schemas/AddressComponentPostalCode"
},
"delivery_service": {
"$ref": "#/components/schemas/AddressComponentDeliveryService"
},
"secondary_delivery_service": {
"$ref": "#/components/schemas/AddressComponentDeliveryService"
},
"sub_building": {
"$ref": "#/components/schemas/AddressComponentSubBuilding"
},
"building": {
"$ref": "#/components/schemas/AddressComponentBuilding"
},
"organization": {
"$ref": "#/components/schemas/AddressComponentOrganization"
},
"street": {
"$ref": "#/components/schemas/AddressComponentStreet"
},
"secondary_street": {
"$ref": "#/components/schemas/AddressComponentStreet"
},
"route_service": {
"$ref": "#/components/schemas/AddressComponentRouteService"
},
"locality": {
"$ref": "#/components/schemas/AddressComponentLocality"
},
"physical_locality": {
"$ref": "#/components/schemas/AddressComponentLocality"
},
"additional_elements": {
"$ref": "#/components/schemas/AddressComponentAdditionalElements"
}
},
"additionalProperties": false,
"description": "The components that differ by country and address type. Note that parameters with blank values will not be returned."
},
"AddressFormatV1Metadata": {
"type": "object",
"properties": {
"address_info": {
"$ref": "#/components/schemas/AddressMetadataInfo"
},
"barcode": {
"$ref": "#/components/schemas/AddressMetadataBarcode"
},
"route_classification": {
"$ref": "#/components/schemas/AddressMetadataRouteClassification"
},
"address_classification": {
"$ref": "#/components/schemas/AddressMetadataAddressClassification"
},
"dpv": {
"$ref": "#/components/schemas/AddressMetadataDpv"
}
},
"additionalProperties": false,
"description": "The address metadata."
},
"AddressFormatV1Request": {
"type": "object",
"properties": {
"layouts": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom layout name.",
"nullable": true,
"example": [
"default"
]
},
"layout_format": {
"$ref": "#/components/schemas/AddressLayoutFormat"
},
"attributes": {
"$ref": "#/components/schemas/AddressFormatV1RequestAttributes"
}
},
"additionalProperties": false,
"description": "The address format V1 request."
},
"AddressFormatV1RequestAttributes": {
"type": "object",
"properties": {
"geocodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesGeocode"
},
"description": "The dataset named Geocodes and its associated attributes.",
"nullable": true
},
"usa_regional_geocodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesUsaRegionalGeocodes"
},
"description": "The dataset named USA Regional Geocodes and its associated attributes.",
"nullable": true
},
"aus_regional_geocodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesAusRegionalGeocodes"
},
"description": "The dataset named AUS Regional Geocodes and its associated attributes.",
"nullable": true
},
"nzl_regional_geocodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesNzlRegionalGeocodes"
},
"description": "The dataset named NZL Regional Geocodes and its associated attributes.",
"nullable": true
},
"uk_location_complete": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesUkLocationComplete"
},
"description": "The dataset named UK Location Complete and its associated attributes.",
"nullable": true
},
"uk_location_essential": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesUkLocationEssential"
},
"description": "The dataset named UK Location Essential and its associated attributes.",
"nullable": true
},
"gbr_government": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesGbrGovernment"
},
"description": "The dataset named GBR Government and its associated attributes.",
"nullable": true
},
"gbr_health": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesGbrHealth"
},
"description": "The dataset named GBR Health and its associated attributes.",
"nullable": true
},
"gbr_business": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesGbAdditionalBusinessAddressValidate"
},
"description": "The dataset named GBR Business and its associated attributes.",
"nullable": true
},
"premium_location_insight": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesPremiumLocationInsight"
},
"description": "The dataset named Premium Location Insight and its associated attributes.",
"nullable": true
},
"what3words": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesWhat3Words"
},
"description": "The dataset named what3words and its associated attributes.",
"nullable": true
},
"gbr_location_grid": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2GbrLocationGrid"
},
"description": "The dataset named GBR Location Grid and its associated attributes.",
"nullable": true
},
"gbr_parliament": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2GbrParliament"
},
"description": "The dataset named GBR Parliament and its associated attributes.",
"nullable": true
},
"gbr_mosaic": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2GbrMosaic"
},
"description": "The dataset named GBR Mosaic and its associated attributes.",
"nullable": true
},
"gbr_mosaic_financial": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2GbrMosaicFinancial"
},
"description": "The dataset named GBR Mosaic Financial and its associated attributes.",
"nullable": true
},
"gbr_alias": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2GbrAlias"
},
"description": "The dataset named GBR Alias and its associated attributes.",
"nullable": true
},
"gbr_quality": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2GbrQuality"
},
"description": "The dataset named GBR Quality and its associated attributes.",
"nullable": true
},
"addressbase_classification": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AprClassification"
},
"description": "The dataset named Addressbase Classification and its associated attributes.",
"nullable": true
},
"addressbase_cross_reference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AprCrossReference"
},
"description": "The dataset named Addressbase Cross Reference and its associated attributes.",
"nullable": true
},
"addressbase_government": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AprGovernment"
},
"description": "The dataset named Addressbase Government and its associated attributes.",
"nullable": true
},
"addressbase_health": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AprHealth"
},
"description": "The dataset named Addressbase Health and its associated attributes.",
"nullable": true
},
"addressbase_location_grid": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AprLocationGrid"
},
"description": "The dataset named Addressbase Location Grid and its associated attributes.",
"nullable": true
},
"addressbase_parliament": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AprParliament"
},
"description": "The dataset named Addressbase Parliament and its associated attributes.",
"nullable": true
},
"addressbase_quality": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AprQuality"
},
"description": "The dataset named Addressbase Quality and its associated attributes.",
"nullable": true
},
"addressbase_street": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AprStreet"
},
"description": "The dataset named Addressbase Street and its associated attributes.",
"nullable": true
},
"addressbase_topography": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AprTopography"
},
"description": "The dataset named Addressbase Topography and its associated attributes.",
"nullable": true
},
"addressbase_voa": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AprVoa"
},
"description": "The dataset named Addressbase Voa and its associated attributes.",
"nullable": true
},
"irl_mosaic": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2IrlMosaic"
},
"description": "The dataset named IRL Mosaic and its associated attributes.",
"nullable": true
},
"nzl_household": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2NzlHousehold"
},
"description": "The dataset named NZL Household and its associated attributes.",
"nullable": true
},
"nzl_mosaic": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2NzlMosaic"
},
"description": "The dataset named NZL Mosaic and its associated attributes.",
"nullable": true
},
"nzl_property": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2NzlProperty"
},
"description": "The dataset named NZL Property and its associated attributes.",
"nullable": true
},
"sgp_mosaic": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2SgpMosaic"
},
"description": "The dataset named SGP Mosaic and its associated attributes.",
"nullable": true
}
},
"additionalProperties": false,
"description": "AddressFormatV1RequestAttributes used for format and enrich."
},
"AddressFormatV1Response": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/AddressFormatV1Result"
},
"metadata": {
"$ref": "#/components/schemas/AddressFormatV1Metadata"
},
"enrichment": {
"$ref": "#/components/schemas/AddressFormatV1ResponseEnrichment"
}
},
"additionalProperties": false,
"description": "Response model for AddressFormatV1 endpoint."
},
"AddressFormatV1ResponseEnrichment": {
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"description": "The transaction id of the request.",
"nullable": true
},
"result": {
"$ref": "#/components/schemas/EnrichmentV2ResultAddressValidate"
},
"metadata": {
"$ref": "#/components/schemas/EnrichmentV2ResultAddressValidateMetadata"
},
"error": {
"$ref": "#/components/schemas/ResponseError"
}
},
"additionalProperties": false,
"description": "Enrichment response object, used for format and enrich requests."
},
"AddressFormatV1Result": {
"type": "object",
"properties": {
"global_address_key": {
"type": "string",
"description": "The ID of the address received as part of a validation.",
"nullable": true
},
"confidence": {
"type": "string",
"description": "The confidence of address validation result.",
"nullable": true,
"example": "Verified match"
},
"address": {
"$ref": "#/components/schemas/Address7Lines"
},
"addresses_formatted": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressFormattedAddressLines"
},
"description": "Customized address layouts.",
"nullable": true
},
"components": {
"$ref": "#/components/schemas/AddressFormatV1Components"
}
},
"additionalProperties": false,
"description": "Information about the result. Includes the validated address and its confidence level."
},
"AddressFormatted": {
"type": "object",
"properties": {
"layout_name": {
"type": "string",
"description": "The address layout name.",
"nullable": true,
"example": "QADefault"
},
"not_enough_lines": {
"type": "boolean",
"description": "There are not enough address lines configured to display the whole address."
},
"has_truncated_lines": {
"type": "boolean",
"description": "Truncation has occurred on one or more address lines."
},
"address": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"description": "The customized address layouts in default format.",
"nullable": true,
"example": {
"AmexStreet": "1 Main St",
"AmexTown": "Surbiton",
"AmexCountry": "United Kingdom",
"gas_meters": [
{
"mprn": "52902306"
},
{
"mprn": "52902307"
}
]
}
}
},
"additionalProperties": false,
"description": "Customized address layouts."
},
"AddressFormattedAddressLines": {
"type": "object",
"properties": {
"layout_name": {
"type": "string",
"description": "The address layout name.",
"nullable": true,
"example": "QADefault"
},
"not_enough_lines": {
"type": "boolean",
"description": "There are not enough address lines configured to display the whole address."
},
"has_truncated_lines": {
"type": "boolean",
"description": "Truncation has occurred on one or more address lines."
},
"address": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"description": "The customized address layouts in default format.",
"nullable": true,
"example": {
"AmexStreet": "1 Main St",
"AmexTown": "Surbiton",
"AmexCountry": "United Kingdom",
"gas_meters": [
{
"mprn": "52902306"
},
{
"mprn": "52902307"
}
]
}
},
"has_missing_sub_premises": {
"type": "boolean",
"description": "The missing subpremise attribute specifies if the address is missing a subpremise when using the verification engine.It can be ignored when using all other engines."
},
"address_lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLine"
},
"description": "The customized address layouts in address-line format.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Customized address layouts."
},
"AddressInputComponentName": {
"type": "object",
"properties": {
"forename": {
"type": "string",
"description": "The first name.",
"nullable": true
},
"middlename": {
"type": "string",
"description": "Middle initial.",
"nullable": true
},
"surname": {
"type": "string",
"description": "The surname.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The address input component name."
},
"AddressInputComponents": {
"type": "object",
"properties": {
"unspecified": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The input component collection.",
"nullable": true,
"example": [
"1 Main Street"
]
},
"names": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressInputComponentName"
},
"description": "The names component.",
"nullable": true,
"example": [
"1 Main Street"
]
},
"locality": {
"$ref": "#/components/schemas/AddressLocalityConstrains"
}
},
"additionalProperties": false,
"description": "The address search input component."
},
"AddressLayout": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the address layout.",
"nullable": true,
"example": "QADefault"
},
"country_iso_3": {
"type": "string",
"description": "The country ISO3 code.",
"nullable": true,
"example": "GBR"
},
"datasets": {
"type": "array",
"items": {
"type": "string"
},
"description": "The dataset for address validation.",
"nullable": true,
"example": [
"gb-address"
]
}
},
"additionalProperties": false,
"description": "The address layout."
},
"AddressLayoutFormat": {
"enum": [
"default",
"address_lines"
],
"type": "string",
"description": "The format of the customized address layout."
},
"AddressLayoutV2": {
"required": [
"applies_to",
"lines",
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 100,
"minLength": 1,
"pattern": "^([A-Za-z0-9_\\-]{1}[A-Za-z0-9_\\-\\ ]*[A-Za-z0-9_\\-]{1}|[A-Za-z0-9_\\-]{1})$",
"type": "string",
"description": "The layout name."
},
"comment": {
"type": "string",
"description": "The layout comment.",
"nullable": true
},
"applies_to": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLayoutV2AppliesTo"
},
"description": "The layout applies to."
},
"options": {
"$ref": "#/components/schemas/AddressLayoutV2Options"
},
"lines": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLayoutV2Line"
},
"description": "The layout lines."
}
},
"additionalProperties": false,
"description": "Address Layout V2."
},
"AddressLayoutV2AppliesTo": {
"required": [
"country_iso",
"datasets"
],
"type": "object",
"properties": {
"country_iso": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "The country ISO3 code.",
"example": "GBR"
},
"datasets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The datasets.",
"example": [
"au-address"
]
},
"language": {
"type": "string",
"description": "The language.",
"nullable": true
},
"script": {
"type": "string",
"description": "The script.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Address Layout V2 Applies To."
},
"AddressLayoutV2ElementConfigurationWithDefault": {
"type": "object",
"properties": {
"default": {
"type": "string",
"description": "The default configuration.",
"nullable": true
},
"configuration_by_element": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "The configuration of each element.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Address Layout V2 Element Configuration."
},
"AddressLayoutV2Line": {
"type": "object",
"properties": {
"line_name": {
"type": "string",
"description": "The line name.",
"nullable": true
},
"max_width": {
"type": "integer",
"description": "Max width.",
"format": "int32",
"nullable": true
},
"elements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLayoutV2LineElement"
},
"description": "Elements.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Address Layout V2 Line."
},
"AddressLayoutV2LineElement": {
"type": "object",
"properties": {
"element_name": {
"type": "string",
"description": "The element name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Address Layout V2 Line Element."
},
"AddressLayoutV2Options": {
"type": "object",
"properties": {
"variation": {
"type": "integer",
"description": "Variation",
"format": "int32"
},
"flatten_diacritics": {
"type": "boolean",
"description": "Flatten Diacritics"
},
"use_secondary_postcode": {
"type": "string",
"description": "Use Secondary Postcode",
"nullable": true
},
"enable_enhanced_layout": {
"type": "boolean",
"description": "Enable Enhanced Layout"
},
"display_enhanced_info_on_picklist": {
"type": "boolean",
"description": "Display Enhanced Info On Picklist"
},
"enable_intelligent_layout": {
"type": "boolean",
"description": "Enable Intelligent Layout"
},
"capitalise_unused": {
"type": "boolean",
"description": "Capitalise Unused"
},
"separate_elements": {
"type": "boolean",
"description": "Separate Elements"
},
"element_separator": {
"$ref": "#/components/schemas/AddressLayoutV2ElementConfigurationWithDefault"
},
"retention_element_separator": {
"$ref": "#/components/schemas/AddressLayoutV2ElementConfigurationWithDefault"
},
"prepend_element_separator": {
"$ref": "#/components/schemas/AddressLayoutV2ElementConfigurationWithDefault"
},
"separate_element_separator": {
"$ref": "#/components/schemas/AddressLayoutV2ElementConfigurationWithDefault"
},
"terminate_lines": {
"type": "boolean",
"description": "Terminate Lines"
},
"line_terminator": {
"$ref": "#/components/schemas/AddressLayoutV2ElementConfigurationWithDefault"
},
"conditional_format": {
"type": "string",
"description": "Conditional Format",
"nullable": true
},
"pad_lines": {
"type": "boolean",
"description": "Pad Lines"
},
"padding_character": {
"type": "string",
"description": "Padding Character",
"nullable": true
},
"multiple_dataplus_delimiter": {
"type": "string",
"description": "Multiple DataPlus Delimiter",
"nullable": true
},
"abbreviate_item": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicating the elements that are abbreviated.",
"nullable": true
},
"capitalise_item": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicating the elements that are capitalised.",
"nullable": true
},
"exclude_item": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicating the elements that are excluded.",
"nullable": true
},
"element_extras": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "Indicating the elements with extra characters.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Address Layout V2 Options"
},
"AddressLayoutV2Status": {
"enum": [
"CreationInProgress",
"Completed"
],
"type": "string",
"description": "The status of the layout"
},
"AddressLayoutsV1Request": {
"required": [
"country_iso",
"datasets"
],
"type": "object",
"properties": {
"country_iso": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "The country ISO3 code of address.",
"example": "AUS"
},
"datasets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The datasets for address layout.",
"example": [
"au-address"
]
}
},
"additionalProperties": false,
"description": "The Address Layout V1 request."
},
"AddressLayoutsV1Response": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLayout"
},
"description": "The address layout V1 result.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response model for AddressLayoutsV1 endpoint."
},
"AddressLayoutsV2CreateRequest": {
"required": [
"layout"
],
"type": "object",
"properties": {
"layout": {
"$ref": "#/components/schemas/AddressLayoutV2"
}
},
"additionalProperties": false,
"description": "Address Layouts V2 Create Request."
},
"AddressLayoutsV2CreateResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/AddressLayoutsV2CreateResult"
}
},
"additionalProperties": false,
"description": "Response model for Address Layouts V2 create endpoint."
},
"AddressLayoutsV2CreateResult": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Layout ID",
"nullable": true
}
},
"additionalProperties": false,
"description": "Address Layouts V2 Create Result"
},
"AddressLayoutsV2GetResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/AddressLayoutsV2GetResult"
}
},
"additionalProperties": false,
"description": "Response model for Address Layouts V2 Get endpoint."
},
"AddressLayoutsV2GetResponseModel": {
"required": [
"applies_to",
"lines",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The layout ID.",
"nullable": true
},
"name": {
"maxLength": 100,
"minLength": 1,
"pattern": "^([A-Za-z0-9_\\-]{1}[A-Za-z0-9_\\-\\ ]*[A-Za-z0-9_\\-]{1}|[A-Za-z0-9_\\-]{1})$",
"type": "string",
"description": "The layout name."
},
"comment": {
"type": "string",
"description": "The layout comment.",
"nullable": true
},
"applies_to": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLayoutV2AppliesTo"
},
"description": "The layout applies to."
},
"options": {
"$ref": "#/components/schemas/AddressLayoutV2Options"
},
"lines": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLayoutV2Line"
},
"description": "The layout lines."
},
"status": {
"$ref": "#/components/schemas/AddressLayoutV2Status"
},
"license_id": {
"type": "string",
"description": "The license ID selected during the layout creation (for internal purposes).",
"nullable": true
}
},
"additionalProperties": false,
"description": "Address Layout V2 Get Response Model."
},
"AddressLayoutsV2GetResult": {
"type": "object",
"properties": {
"layout": {
"$ref": "#/components/schemas/AddressLayoutsV2GetResponseModel"
}
},
"additionalProperties": false,
"description": "Address Layouts V2 Get Result."
},
"AddressLayoutsV2ListResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLayoutsV2ListResponseModel"
},
"description": "Address Layouts V2 List Result Collection",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response model for Address Layouts V2 List endpoint."
},
"AddressLayoutsV2ListResponseModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The layout ID.",
"nullable": true
},
"name": {
"maxLength": 100,
"minLength": 1,
"pattern": "^([A-Za-z0-9_\\-]{1}[A-Za-z0-9_\\-\\ ]*[A-Za-z0-9_\\-]{1}|[A-Za-z0-9_\\-]{1})$",
"type": "string",
"description": "The layout name."
},
"applies_to": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLayoutV2AppliesTo"
},
"description": "The layout applies to.",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/AddressLayoutV2Status"
}
},
"additionalProperties": false,
"description": "Address Layout V2 List Response Model."
},
"AddressLayoutsV2UpdateLayout": {
"required": [
"applies_to",
"id",
"lines",
"name"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "The layout ID."
},
"name": {
"maxLength": 100,
"minLength": 1,
"pattern": "^([A-Za-z0-9_\\-]{1}[A-Za-z0-9_\\-\\ ]*[A-Za-z0-9_\\-]{1}|[A-Za-z0-9_\\-]{1})$",
"type": "string",
"description": "The layout name."
},
"comment": {
"type": "string",
"description": "The layout comment.",
"nullable": true
},
"applies_to": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLayoutV2AppliesTo"
},
"description": "The layout applies to."
},
"options": {
"$ref": "#/components/schemas/AddressLayoutV2Options"
},
"lines": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLayoutV2Line"
},
"description": "The layout lines."
}
},
"additionalProperties": false,
"description": "Address Layout V2 Update Layout."
},
"AddressLayoutsV2UpdateRequest": {
"required": [
"layout"
],
"type": "object",
"properties": {
"layout": {
"$ref": "#/components/schemas/AddressLayoutsV2UpdateLayout"
}
},
"additionalProperties": false,
"description": "Address Layouts V2 Update Request."
},
"AddressLine": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The label of address line.",
"nullable": true,
"example": "AmexStreet"
},
"line": {
"type": "string",
"description": "The text of address line.",
"nullable": true,
"example": "1 Main St"
},
"has_overflown_to_other_line": {
"type": "boolean",
"description": "Indicating some address elements were lost from this line or not."
},
"is_truncated": {
"type": "boolean",
"description": "Indicating truncation occurred on this line or not."
},
"line_content": {
"$ref": "#/components/schemas/AddressLineContent"
}
},
"additionalProperties": false,
"description": "The address line of customized layout."
},
"AddressLineContent": {
"enum": [
"none",
"address",
"name",
"ancillary",
"dataplus"
],
"type": "string",
"description": "The type of address line."
},
"AddressLocalityConstrains": {
"type": "object",
"properties": {
"region": {
"$ref": "#/components/schemas/AddressRestrictionRules"
}
},
"additionalProperties": false,
"description": "A class representing search locality constraints"
},
"AddressLookupKey": {
"required": [
"value"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of the lookup key.",
"nullable": true,
"example": "Default"
},
"value": {
"minLength": 1,
"type": "string",
"description": "The value of the lookup key.",
"example": "1234567890"
}
},
"additionalProperties": false,
"description": "The address lookup key."
},
"AddressLookupV1Request": {
"required": [
"country_iso",
"datasets",
"key"
],
"type": "object",
"properties": {
"country_iso": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "The country ISO3 code.",
"example": "USA"
},
"datasets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The datasets for address lookup.",
"example": [
"us-address"
]
},
"key": {
"$ref": "#/components/schemas/AddressLookupKey"
}
},
"additionalProperties": false,
"description": "Address lookup V1 request."
},
"AddressLookupV2Request": {
"required": [
"components",
"country_iso",
"datasets"
],
"type": "object",
"properties": {
"country_iso": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Gets or sets the country ISO3 code of address.",
"example": "GBR"
},
"datasets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets the datasets for address validation.",
"nullable": true,
"example": [
"gb-address"
]
},
"max_addresses": {
"type": "integer",
"description": "Gets or sets the maximum number of addresses a search request should return.",
"format": "int32",
"nullable": true,
"example": 10
},
"max_suggestions": {
"type": "integer",
"description": "Gets or sets the maximum number of suggestions a search request should return.",
"format": "int32",
"nullable": true
},
"attributes": {
"$ref": "#/components/schemas/AddressLookupV2RequestAttributes"
},
"key": {
"$ref": "#/components/schemas/Key"
},
"preferred_language": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets the preferred language.",
"nullable": true
},
"preferred_script": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets the the preferred script.",
"nullable": true
},
"names": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressInputComponentName"
},
"description": "The names component.",
"nullable": true,
"example": [
"1 Main Street"
]
},
"layouts": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom layout name.",
"nullable": true,
"example": [
"default"
]
}
},
"additionalProperties": false,
"description": "The address lookup v2 request."
},
"AddressLookupV2RequestAttributes": {
"type": "object",
"properties": {
"locality_lookup": {
"type": "array",
"items": {
"type": "string"
},
"description": "AddressLookupV2RequestAttributes for locality lookup.",
"nullable": true
},
"postal_code_lookup": {
"type": "array",
"items": {
"type": "string"
},
"description": "AddressLookupV2RequestAttributes for postal code lookup.",
"nullable": true
}
},
"additionalProperties": false,
"description": "AddressLookupV2RequestAttributes for locality search."
},
"AddressLookupV2Result": {
"type": "object",
"properties": {
"more_results_available": {
"type": "boolean",
"description": "Gets or sets a value indicating whether property that there are more suggestions available than the results provided."
},
"confidence": {
"type": "string",
"description": "Gets or sets the outcome (confidence level) of the validation.",
"nullable": true,
"example": "Verified match"
},
"suggestions_key": {
"type": "string",
"description": "Gets or sets the suggestions key for address suggestion refinement.",
"nullable": true
},
"suggestions_prompt": {
"type": "string",
"description": "Gets or sets the prompt to display to the user, indicating what information they should enter next.",
"nullable": true,
"example": "Enter selection"
},
"suggestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Suggestion"
},
"description": "Gets or sets the possible postcode, locality or UDPRN (for GBR)",
"nullable": true
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressSuggestionV2Hub"
},
"description": "Gets or sets the collection of suggested addresses",
"nullable": true
},
"addresses_formatted": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLookupV2ResultAddressFormatted"
},
"description": "Gets or sets the collection of formatted addresses",
"nullable": true
}
},
"additionalProperties": false,
"description": "Address lookup V2 result."
},
"AddressLookupV2ResultAddressFormatted": {
"type": "object",
"properties": {
"layout_name": {
"type": "string",
"description": "The address layout name.",
"nullable": true,
"example": "QADefault"
},
"address": {
"type": "object",
"additionalProperties": {},
"description": "The customized address layouts in default format.",
"nullable": true,
"example": {
"AmexStreet": "1 Main St",
"AmexTown": "Surbiton",
"AmexCountry": "United Kingdom",
"gas_meters": [
{
"mprn": "52902306"
},
{
"mprn": "52902307"
}
]
}
}
},
"additionalProperties": false,
"description": "Customized address layouts."
},
"AddressMetadata": {
"type": "object",
"properties": {
"address_info": {
"$ref": "#/components/schemas/AddressMetadataInfo"
},
"barcode": {
"$ref": "#/components/schemas/AddressMetadataBarcode"
},
"route_classification": {
"$ref": "#/components/schemas/AddressMetadataRouteClassification"
},
"address_classification": {
"$ref": "#/components/schemas/AddressMetadataAddressClassification"
},
"dpv": {
"$ref": "#/components/schemas/AddressMetadataDpv"
}
},
"additionalProperties": false,
"description": "The address metadata."
},
"AddressMetadataAddressClassification": {
"type": "object",
"properties": {
"address_type": {
"$ref": "#/components/schemas/AddressMetadataAddressType"
},
"delivery_type": {
"type": "string",
"description": "Type of mail delivery at the address. Either \"business\", \"residential\" or \"mixed\".",
"nullable": true,
"example": "Business"
},
"is_deliverable": {
"type": "string",
"description": "Indicator if the address is deliverable - applicable to NZL addresses only.",
"nullable": true,
"example": "Y"
}
},
"additionalProperties": false,
"description": "Address deliverability and type indicators."
},
"AddressMetadataAddressType": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The code of the address type (applicable to USA, AUS and NZL addresses).",
"nullable": true,
"example": "S"
},
"description": {
"type": "string",
"description": "The description of the address type (applicable to USA, AUS and NZL addresses).",
"nullable": true,
"example": "Street"
}
},
"additionalProperties": false,
"description": "The address type."
},
"AddressMetadataBarcode": {
"type": "object",
"properties": {
"delivery_point_barcode": {
"type": "string",
"description": "The delivery point barcode (applicable for USA addresses only).",
"nullable": true,
"example": "02139430177"
},
"check_digit": {
"type": "string",
"description": "The delivery point barcode's check digit (applicable for USA addresses only).",
"nullable": true,
"example": "3"
},
"sort_plan_number": {
"type": "string",
"description": "The sort plan number barcode (applicable for AUS addresses only).",
"nullable": true,
"example": "022"
}
},
"additionalProperties": false,
"description": "Address barcode."
},
"AddressMetadataDpv": {
"type": "object",
"properties": {
"cmra_indicator": {
"type": "string",
"description": "Indicates that the address is a private business that acts as a commercial mail-receiving agent for specific clients.",
"nullable": true,
"example": "Y"
},
"seed_indicator": {
"type": "string",
"description": "Seed records are control records placed by the USPS to prevent unauthorized tampering (e.g., creation of lists containing every single delivery point in a geographical region). A seed address will deactivate DPV functionality. To re-activate, please visit the Self Service Portal.",
"nullable": true,
"example": "Y"
},
"dpv_indicator": {
"type": "string",
"description": "Indicates whether selected address is confirmed as deliverable via DPV (Delivery Point Validation) process. For all possible values, please visit our technical documentation portal.",
"nullable": true,
"example": "Y"
},
"footnotes": {
"type": "array",
"items": {
"type": "string"
},
"description": "USPS codes denoting DPV match levels. For a list of all possible values, please visit our technical documentation portal.",
"nullable": true,
"example": [
"AA",
"BB"
]
},
"vacancy_indicator": {
"type": "string",
"description": "An address known to be unoccupied for over 90 days and therefore not receiving mail deliveries.",
"nullable": true,
"example": "Y"
},
"no_stats_indicator": {
"type": "string",
"description": "An address known to not receive mail deliveries (e.g. a house under construction).",
"nullable": true,
"example": "Y"
},
"pbsa_indicator": {
"type": "string",
"description": "Indicates addresses known to be Post Office Box Street Addresses (PBSA).",
"nullable": true,
"example": "Y"
},
"lacs_indicator": {
"type": "string",
"description": "Gets or sets the Locatable Address ConversionSystem Link Indicator.\nIt links addresses that were converted due to USPS changes to their new addresses.\nThis affects many rural addresses with assigned city-style names for 911 emergencies.",
"nullable": true,
"example": "Y"
},
"lacs_code": {
"type": "string",
"description": "Gets or sets the Locatable Address ConversionSystem Link Code.\nIt links addresses that were converted due to USPS changes to their new addresses.\nThis affects many rural addresses with assigned city-style names for 911 emergencies.",
"nullable": true,
"example": "14"
},
"urbanization": {
"type": "string",
"description": "Gets or sets Urbanization property of the address.",
"nullable": true
},
"delivery_line_1": {
"type": "string",
"description": "Gets or sets delivery line 1 of the address.",
"nullable": true
},
"delivery_line_2": {
"type": "string",
"description": "Gets or sets delivery line 2 of the address.",
"nullable": true
},
"last_line": {
"type": "string",
"description": "Gets or sets last line of the address.",
"nullable": true
},
"no_stat_reason_code": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets DPV No stat reason code",
"nullable": true
},
"drop": {
"type": "string",
"description": "Gets or sets DPV Drop indicator",
"nullable": true
},
"throwback": {
"type": "string",
"description": "Gets or sets DPV Throwback indicator",
"nullable": true
},
"non_delivery_days_indicator": {
"type": "string",
"description": "Gets or sets DPV Non Delivery Day indicator",
"nullable": true
},
"non_delivery_days_value": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets DPV Non Delivery Week Days indicator",
"nullable": true
},
"no_secure_location": {
"type": "string",
"description": "Gets or sets DPV No Secure Location indicator",
"nullable": true
},
"door_not_accessible": {
"type": "string",
"description": "Gets or sets DPV Door Not Accessible indicator",
"nullable": true
},
"enhanced_dpv_code": {
"type": "string",
"description": "Gets or sets Enhanced DPV Return Code",
"nullable": true
},
"firm_name": {
"type": "string",
"description": "Gets or sets Firm Name field of the address.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Delivery Point Validation information for the address (USA only)."
},
"AddressMetadataInfo": {
"type": "object",
"properties": {
"sources": {
"type": "array",
"items": {
"type": "string"
},
"description": "Source of address information.",
"nullable": true
},
"number_of_households": {
"type": "string",
"description": "Number of households for records in GBR Not Yet Built, or multi-occupancy count of the owning delivery point for GBR Multiple Residence.",
"nullable": true,
"example": "1"
},
"just_built_date": {
"type": "string",
"description": "Construction date of the record, if it has been constructed in the last 6 months (GBR specific).",
"nullable": true,
"example": "20210605"
},
"identifier": {
"$ref": "#/components/schemas/AddressMetadataInfoId"
}
},
"additionalProperties": false,
"description": "Address information."
},
"AddressMetadataInfoId": {
"type": "object",
"properties": {
"umrrn": {
"type": "string",
"description": "Royal Mail's Unique Multiple Residence Reference Number, an eight-digit code linked to UDPRNs in Royal Mail's Multiple Residence dataset.",
"nullable": true,
"example": "50101642"
},
"udprn": {
"type": "string",
"description": "Royal Mail's Unique Delivery Point Reference Number, an eight-digit code assigned to every delivery point in the Postcode Address File (PAF).",
"nullable": true,
"example": "12353232"
},
"uprn": {
"type": "string",
"description": "Unique Property Reference Number, a unique 12-digit identifier for each land and property unit (AddressBase and AddressBase with Names).",
"nullable": true,
"example": "12353232"
},
"dpid": {
"type": "string",
"description": "Australia Post's Delivery Point Identifier, an eight-digit number that uniquely identifies a physical location to which Australia Post delivers mail - applicable to AUS and NZL addresses.",
"nullable": true,
"example": "62147712"
},
"gnafPid": {
"type": "string",
"description": "Geoscape Australia's Geocoded National Address File Persistent Identifier (G-NAF ID).",
"nullable": true,
"example": "GAVIC424477161"
},
"paf_address_key": {
"type": "string",
"description": "PAF Address key (GBR specific).",
"nullable": true,
"example": "2304084100000000S"
},
"hin": {
"type": "string",
"description": "Household Identification Number (applicable for AUS addresses).",
"nullable": true,
"example": "203060068"
},
"organization_key": {
"type": "string",
"description": "Unique 14-character key for the organization record.",
"nullable": true
},
"lpi_key": {
"type": "string",
"description": "Unique 14-character key for the LPI record.",
"nullable": true
},
"dps": {
"type": "string",
"description": "A two character code uniquely identifying an individual delivery point within a postcode.",
"nullable": true
},
"parent_uprn": {
"type": "string",
"description": "The UPRN of the parent property associated with a record.",
"nullable": true
},
"building_id": {
"type": "string",
"description": "This is a unique number which identifies each building or premises.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The ID metadata of formatted address."
},
"AddressMetadataRouteClassification": {
"type": "object",
"properties": {
"carrier_route": {
"type": "string",
"description": "The carrier route value (applicable for USA addresses only).",
"nullable": true,
"example": "C077"
},
"id": {
"type": "string",
"description": "The street identifier (applicable for AUS addresses only).",
"nullable": true,
"example": "38396"
},
"elot": {
"type": "string",
"description": "Contains a sequence number and an ascending/descending code.\nThe number indicates the first occurrence of delivery made to the add-on range within the carrier route.\nThe code indicates the approximate delivery order within the sequence number.",
"nullable": true,
"example": "0000A"
},
"roudis_id": {
"type": "string",
"description": "This reference code provides an entry point into the ROUDIS2000 file provided by La Poste.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Address deliverability and type indicators."
},
"AddressNameValuePair": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the pair.",
"nullable": true,
"example": "flatten"
},
"value": {
"type": "string",
"description": "The value of the pair.",
"nullable": true,
"example": "true"
}
},
"additionalProperties": false,
"description": "The address name value pair."
},
"AddressPromptSetType": {
"enum": [
"oneline",
"default",
"generic",
"optimal",
"alternate",
"alternate2",
"alternate3"
],
"type": "string",
"description": "The available prompt sets."
},
"AddressPromptSetsLine": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"description": "The prompt to display to the user.",
"nullable": true,
"example": "Building number or name."
},
"suggested_input_length": {
"type": "integer",
"description": "The suggested length of the input buffer.",
"format": "int32",
"nullable": true,
"example": 40
},
"example": {
"type": "string",
"description": "An example of possible input.",
"nullable": true,
"example": "12"
}
},
"additionalProperties": false,
"description": "PromptLine describes a line of a prompt set."
},
"AddressPromptSetsV1Request": {
"required": [
"country_iso",
"datasets",
"prompt_set"
],
"type": "object",
"properties": {
"country_iso": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "The country ISO3 code.",
"example": "AUS"
},
"datasets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The datasets of the promptset.",
"example": [
"au-address"
]
},
"search_type": {
"$ref": "#/components/schemas/AddressSearchType"
},
"prompt_set": {
"$ref": "#/components/schemas/AddressPromptSetType"
}
},
"additionalProperties": false,
"description": "Address prompt set request."
},
"AddressPromptSetsV1Response": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/AddressPromptSetsV1Result"
}
},
"additionalProperties": false,
"description": "Response model for AddressPromptSetsV1 endpoint."
},
"AddressPromptSetsV1Result": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressPromptSetsLine"
},
"description": "Describes one line of the prompt set.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Address prompt set result."
},
"AddressRequestAttributesEnrichmentGeocode": {
"enum": [
"latitude",
"longitude",
"match_level"
],
"type": "string",
"description": "The dataset named Geocodes and its associated attributes."
},
"AddressRestrictionRules": {
"type": "object",
"properties": {
"exists": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the address element is required to exist for returned addresses\nor required to not exist. Null value means that both records with and without such element will be returned.",
"nullable": true
},
"must_be": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets an array of values, causing the returned result to include only records that have one of the values",
"nullable": true
},
"must_not_be": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets an array of values, causing the returned result to include only records that exclude the values",
"nullable": true
}
},
"additionalProperties": false,
"description": "A class that represents address restriction rules"
},
"AddressSearchType": {
"enum": [
"singleline",
"typedown",
"verification",
"keyfinder",
"intuitive_classic"
],
"type": "string",
"description": "The available search type."
},
"AddressSearchV1Request": {
"required": [
"components",
"country_iso",
"datasets"
],
"type": "object",
"properties": {
"country_iso": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "The country ISO3 code of address.",
"example": "GBR"
},
"datasets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The datasets for address validation.",
"nullable": true,
"example": [
"au-address"
]
},
"max_suggestions": {
"type": "integer",
"description": "The maximum number of suggestions a search request should return.\nPlease refer to the documentation.",
"format": "int32",
"nullable": true,
"example": 10
},
"components": {
"$ref": "#/components/schemas/AddressInputComponents"
},
"location": {
"maxLength": 40,
"minLength": 0,
"type": "string",
"description": "Geographical location (latitude,longitude) to use as the center point for the search (USA only).",
"nullable": true,
"example": "42.3529, -71.0578"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressNameValuePair"
},
"description": "Additional options.",
"nullable": true,
"example": [
{
"name": "search_type",
"value": "singleline"
}
]
},
"preferred_language": {
"type": "array",
"items": {
"type": "string"
},
"description": "The datasets for address validation.",
"nullable": true,
"example": [
"ja"
]
},
"preferred_script": {
"type": "array",
"items": {
"type": "string"
},
"description": "The datasets for address validation.",
"nullable": true,
"example": [
"preserve_input"
]
},
"street": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "The country ISO3 code of address.",
"nullable": true,
"example": "GBR"
},
"town": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "The country ISO3 code of address.",
"nullable": true,
"example": "GBR"
},
"region": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "The country ISO3 code of address.",
"nullable": true,
"example": "GBR"
},
"postal_code": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "The country ISO3 code of address.",
"nullable": true,
"example": "GBR"
}
},
"additionalProperties": false,
"description": "The address search v1 request."
},
"AddressSearchV1Response": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/AddressSearchV1Result"
}
},
"additionalProperties": false,
"description": "Response model for AddressSearchV1 endpoint."
},
"AddressSearchV1Result": {
"type": "object",
"properties": {
"more_results_available": {
"type": "boolean",
"description": "To indicate that there are more suggestions available than the results provided."
},
"confidence": {
"type": "string",
"description": "The outcome (confidence level) of the validation.",
"nullable": true,
"example": "Verified match"
},
"suggestions_key": {
"type": "string",
"description": "The suggestions key for address suggestion refinement.",
"nullable": true
},
"suggestions_prompt": {
"type": "string",
"description": "The prompt to display to the user, indicating what information they should enter next.",
"nullable": true,
"example": "Enter selection"
},
"suggestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressSuggestion"
},
"description": "The collection of the suggestions that match the address search input.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Address search V1 result."
},
"AddressSuggestion": {
"type": "object",
"properties": {
"global_address_key": {
"type": "string",
"description": "The ID of the address received as part of a validation.",
"nullable": true
},
"text": {
"type": "string",
"description": "The suggestion that should be presented to the user as a possible match to their input.",
"nullable": true,
"example": "Level 6 549 St Kilda Road, MELBOURNE VIC 3004"
},
"matched": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"description": "A collection of the characters in the suggestion that have been matched. Integrators can use this information to highlight matched text.",
"nullable": true,
"example": [
[
17,
22
],
[
11,
15
],
[
3,
10
],
[
0,
2
]
]
},
"format": {
"type": "string",
"description": "The format URL of the suggested address.",
"nullable": true
},
"stepin": {
"type": "string",
"description": "The stepin URL of the cluster of addresses.",
"nullable": true
},
"number_of_addresses": {
"type": "integer",
"description": "The stepin URL of the cluster of addresses.",
"format": "int32"
},
"dataset": {
"type": "string",
"description": "The dataset of the suggestion.",
"nullable": true,
"example": "Multiple Residence"
},
"additional_attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressNameValuePair"
},
"description": "The additional attributes of the suggestion.",
"nullable": true
},
"names": {
"type": "array",
"items": {
"type": "string"
},
"description": "The additional attributes of the suggestion.",
"nullable": true
},
"uprn": {
"type": "string",
"description": "The UPRN of the suggestion.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The suggestions that match the address search input."
},
"AddressSuggestionV2Hub": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "Gets or sets the suggestion text",
"nullable": true
},
"matched": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"description": "Gets or sets the matched field",
"nullable": true
},
"global_address_key": {
"type": "string",
"description": "Gets or sets the global address key",
"nullable": true
},
"format": {
"type": "string",
"description": "Gets or sets the format field",
"nullable": true
},
"dataset": {
"type": "string",
"description": "Gets or sets the suggestion dataset",
"nullable": true
},
"names": {
"type": "array",
"items": {
"type": "string"
},
"description": "The additional attributes of the suggestion.",
"nullable": true
},
"uprn": {
"type": "string",
"description": "The UPRN of the suggestion.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The address suggestion for the hub v2 endpoint."
},
"AddressSuggestionsFormatV1": {
"type": "object",
"properties": {
"global_address_key": {
"type": "string",
"description": "The ID of the address received as part of a validation.",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/Address7Lines"
},
"addresses_formatted": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressFormatted"
},
"description": "Customized address layouts.",
"nullable": true
},
"components": {
"$ref": "#/components/schemas/AddressComponent"
},
"metadata": {
"$ref": "#/components/schemas/AddressMetadata"
}
},
"additionalProperties": false,
"description": "Address suggestions format V1."
},
"AddressSuggestionsFormatV1Request": {
"required": [
"components",
"country_iso",
"datasets"
],
"type": "object",
"properties": {
"country_iso": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "The country ISO3 code of address.",
"example": "AUS"
},
"datasets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The datasets for address validation.",
"example": [
"au-address"
]
},
"max_suggestions": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"description": "The maximum number of suggestions a search request should return (should be between 1 and 100).",
"format": "int32",
"nullable": true,
"example": 10
},
"components": {
"$ref": "#/components/schemas/AddressInputComponents"
},
"layouts": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom layout name.",
"nullable": true,
"example": [
"default"
]
}
},
"additionalProperties": false,
"description": "The address suggestions format v1 request."
},
"AddressSuggestionsFormatV1RequestAttributes": {
"type": "object",
"properties": {
"geocodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressRequestAttributesEnrichmentGeocode"
},
"description": "The dataset named Geocodes and its associated attributes.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Datasets and their specific attributes."
},
"AddressSuggestionsFormatV1Response": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/AddressSuggestionsFormatV1Result"
}
},
"additionalProperties": false,
"description": "Response model for AddressSuggestionsFormatV1 endpoint."
},
"AddressSuggestionsFormatV1Result": {
"type": "object",
"properties": {
"more_results_available": {
"type": "boolean",
"description": "To indicate that there are more suggestions available than the results provided."
},
"confidence": {
"type": "string",
"description": "The outcome (confidence level) of the validation.",
"nullable": true,
"example": "Multiple matches"
},
"suggestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressSuggestionsFormatV1"
},
"description": "The collection of the suggestions that match the address search input.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Address suggestions format result."
},
"AddressSuggestionsV1Request": {
"required": [
"refinement"
],
"type": "object",
"properties": {
"refinement": {
"minLength": 1,
"type": "string",
"description": "The refinement text.",
"example": "A123"
}
},
"additionalProperties": false,
"description": "Address suggestion V1 request."
},
"AddressSuggestionsV1Response": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/AddressSearchV1Result"
}
},
"additionalProperties": false,
"description": "Response model for AddressSuggestionsV1 endpoint."
},
"AddressValidateV1Request": {
"required": [
"components",
"country_iso",
"datasets"
],
"type": "object",
"properties": {
"country_iso": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "The country ISO3 code of address.",
"example": "AUS"
},
"datasets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The datasets for address validation.",
"example": [
"au-address"
]
},
"max_suggestions": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"description": "The maximum number of suggestions a search request should return (should be between 1 and 100).",
"format": "int32",
"nullable": true,
"example": 10
},
"components": {
"$ref": "#/components/schemas/AddressInputComponents"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressNameValuePair"
},
"description": "Additional options.",
"nullable": true,
"example": [
{
"name": "intensity",
"value": "close"
}
]
},
"attributes": {
"$ref": "#/components/schemas/AddressFormatV1RequestAttributes"
},
"layouts": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom layout name.",
"nullable": true,
"example": [
"default"
]
},
"layout_format": {
"$ref": "#/components/schemas/AddressLayoutFormat"
}
},
"additionalProperties": false,
"description": "Used for combined Validate and Enrichment call"
},
"AddressValidateV1Response": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/AddressValidateV1Result"
},
"metadata": {
"$ref": "#/components/schemas/AddressMetadata"
},
"enrichment": {
"$ref": "#/components/schemas/AddressFormatV1ResponseEnrichment"
}
},
"additionalProperties": false,
"description": "Response model for AddressValidateV1 endpoint."
},
"AddressValidateV1Result": {
"type": "object",
"properties": {
"validation_detail": {
"$ref": "#/components/schemas/AddressValidationDetail"
},
"global_address_key": {
"type": "string",
"description": "The ID of the address received as part of a validation.",
"nullable": true
},
"more_results_available": {
"type": "boolean",
"description": "To indicate that there are more suggestions available than the results provided.",
"nullable": true
},
"confidence": {
"type": "string",
"description": "The outcome (confidence level) of the validation.",
"nullable": true,
"example": "Multiple matches"
},
"address": {
"$ref": "#/components/schemas/Address7Lines"
},
"addresses_formatted": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressFormattedAddressLines"
},
"description": "Customized address layouts.",
"nullable": true
},
"components": {
"$ref": "#/components/schemas/AddressComponent"
},
"suggestions_key": {
"type": "string",
"description": "The suggestions key for address suggestion refinement.",
"nullable": true
},
"suggestions_prompt": {
"type": "string",
"description": "The prompt to display to the user, indicating what information they should enter next.",
"nullable": true,
"example": "Enter selection"
},
"suggestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressSuggestion"
},
"description": "The collection of the suggestions that match the address validate input.",
"nullable": true
},
"match_type": {
"type": "string",
"description": "Match type for verified address.",
"nullable": true
},
"match_confidence": {
"type": "string",
"description": "Match confidence for verified address.",
"nullable": true
},
"match_info": {
"$ref": "#/components/schemas/MatchInfoFlags"
}
},
"additionalProperties": false,
"description": "Address validate V1 result."
},
"AddressValidationDetail": {
"type": "object",
"properties": {
"building_firm_name_corrected": {
"type": "boolean",
"description": "Building or Firm name has been added or changed."
},
"primary_number_corrected": {
"type": "boolean",
"description": "Primary Number has been added or changed."
},
"street_corrected": {
"type": "boolean",
"description": "Street has been (non-trivially) corrected."
},
"rural_route_highway_contract_matched": {
"type": "boolean",
"description": "Rural Route or Highway Contract has been matched."
},
"city_name_corrected": {
"type": "boolean",
"description": "City name has been added or changed."
},
"city_name_alias_matched": {
"type": "boolean",
"description": "City name has been alias matched."
},
"state_corrected": {
"type": "boolean",
"description": "State or Province has been added or changed."
},
"zip_code_corrected": {
"type": "boolean",
"description": "Post code has been added or corrected."
},
"secondary_num_retained": {
"type": "boolean",
"description": "Secondary number has been retained."
},
"iden_pre_st_info_retained": {
"type": "boolean",
"description": "Identifiable pre-street information has been retained."
},
"gen_pre_st_info_retained": {
"type": "boolean",
"description": "General pre-street information has been retained."
},
"post_st_info_retained": {
"type": "boolean",
"description": "Post-street information has been retained."
}
},
"additionalProperties": false,
"description": "Address validation details."
},
"BulkAddressV1CreateBatchRequest": {
"required": [
"addresses"
],
"type": "object",
"properties": {
"defaults": {
"$ref": "#/components/schemas/BulkAddressV1CreateBatchRequestOptions"
},
"addresses": {
"maxItems": 10000,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkAddressV1CreateBatchRequestAddress"
},
"description": "List of input components."
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Create Batch request."
},
"BulkAddressV1CreateBatchRequestAddress": {
"type": "object",
"properties": {
"address": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "The address to validate.",
"nullable": true,
"example": "1 main st, sydney"
},
"country_iso": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "You can indicate the 3-letter ISO country code if the address that is subject to validation doesn't contain an address country code.\nThis will overwrite the country_iso in the default options.",
"nullable": true,
"example": "AUS"
},
"datasets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The datasets to apply.",
"nullable": true,
"example": [
"au-address-gnaf"
]
}
},
"additionalProperties": false,
"description": "Bulk Address V1 address component."
},
"BulkAddressV1CreateBatchRequestOptions": {
"type": "object",
"properties": {
"country_iso": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "The country ISO3 code of address.",
"nullable": true,
"example": "USA"
},
"datasets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The datasets for address validation.",
"nullable": true,
"example": [
"us-address"
]
},
"batch_reference_id": {
"maxLength": 256,
"minLength": 0,
"pattern": "^[\\w\\-\\/\\:\\.\\,\\(\\) ]+$",
"type": "string",
"description": "Optional identifier that will be returned in the response to help you track the batch.",
"nullable": true
},
"max_processing_time": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "Optional maximum processing time of the batch.\nIf the batch is still processing after this time, it will be stopped.\nThe value should be in ISO 8601 duration format (e.g., \"PT30M\" for 30 minutes).\nMaximum allowed value is \"PT24H\" (24 hours). Minimum allowed value is \"PT1M\" (1 minute).",
"nullable": true
}
},
"additionalProperties": false,
"description": "The default options that applied to all the addresses."
},
"BulkAddressV1CreateBatchResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkAddressV1CreateBatchResult"
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Create Batch response."
},
"BulkAddressV1CreateBatchResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Create Batch result."
},
"BulkAddressV1GetBatchResultsResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseResult"
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Results response."
},
"BulkAddressV1GetBatchResultsResponseAddress": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "The address that is the subject of the validation.",
"nullable": true,
"example": "555 Ellis St | Mountain View | CA | 94043"
},
"country_iso": {
"type": "string",
"description": "The country ISO of the validation.",
"nullable": true,
"example": "DEU"
},
"datasets": {
"type": "array",
"items": {
"type": "string"
},
"description": "The datasets of the validation.",
"nullable": true,
"example": [
"de-address-ed"
]
},
"confidence": {
"type": "string",
"description": "The outcome (confidence level) of the validation.",
"nullable": true,
"example": "verified match"
},
"match_type": {
"type": "string",
"description": "Match type for verified address.",
"nullable": true,
"example": "full_with_post_code"
},
"match_confidence": {
"type": "string",
"description": "Match confidence for verified address.",
"nullable": true,
"example": "high"
},
"match_info": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressMatchInfo"
},
"addresses_formatted": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressAddressFormatted"
},
"description": "Addresses formatted details for verified address.",
"nullable": true
},
"components": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponents"
},
"metadata": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressMetadata"
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Results response Address data"
},
"BulkAddressV1GetBatchResultsResponseAddressAddressFormatted": {
"type": "object",
"properties": {
"layout_name": {
"type": "string",
"description": "The layout name for address to map.",
"nullable": true,
"example": "myLayout"
},
"address": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The address formatted.",
"nullable": true,
"example": {
"CountryIso": "DEU",
"CountryName": "",
"PostalCode": "75245",
"Locality": "Neulingen",
"Street": "Am Sickenbrünnle",
"Building": ""
}
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Results response Address Formatted data"
},
"BulkAddressV1GetBatchResultsResponseAddressComponents": {
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "Address language.",
"nullable": true,
"example": "en-GB"
},
"country_name": {
"type": "string",
"description": "The name of the country where the address is located.",
"nullable": true,
"example": "United Kingdom"
},
"country_iso_3": {
"type": "string",
"description": "The 3-letter ISO country code.",
"nullable": true,
"example": "GBR"
},
"country_iso_2": {
"type": "string",
"description": "The 2-letter ISO country code.",
"nullable": true,
"example": "GB"
},
"postal_code": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsPostalCode"
},
"delivery_service": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsDeliveryService"
},
"secondary_delivery_service": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsDeliveryService"
},
"sub_building": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsSubBuilding"
},
"building": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsBuilding"
},
"organization": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsOrganization"
},
"street": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsStreet"
},
"secondary_street": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsStreet"
},
"route_service": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsRouteService"
},
"locality": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsLocality"
},
"physical_locality": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsLocality"
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Results response Address Components data"
},
"BulkAddressV1GetBatchResultsResponseAddressComponentsBuilding": {
"type": "object",
"properties": {
"building_name": {
"type": "string",
"description": "The building name.",
"nullable": true,
"example": "Sir John Peace Building"
},
"building_number": {
"type": "string",
"description": "The building number.",
"nullable": true,
"example": "549"
},
"secondary_name": {
"type": "string",
"description": "The secondary building name.",
"nullable": true
},
"secondary_number": {
"type": "string",
"description": "The secondary name of the building (if available).",
"nullable": true
},
"allotment_number": {
"type": "string",
"description": "The allotment name where a person or property resides.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The building component."
},
"BulkAddressV1GetBatchResultsResponseAddressComponentsDeliveryService": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"description": "The full name of the delivery service.",
"nullable": true
},
"service_type": {
"type": "string",
"description": "The delivery service type.",
"nullable": true
},
"service_number": {
"type": "string",
"description": "The delivery service number.",
"nullable": true
},
"post_centre_name": {
"type": "string",
"description": "The delivery service post center name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The delivery service component."
},
"BulkAddressV1GetBatchResultsResponseAddressComponentsLocality": {
"type": "object",
"properties": {
"region": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem"
},
"sub_region": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem"
},
"town": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem"
},
"district": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem"
},
"sub_district": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem"
}
},
"additionalProperties": false,
"description": "The locality component."
},
"BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Gets or sets the locality name",
"nullable": true
},
"code": {
"type": "string",
"description": "Gets or sets the locality code",
"nullable": true
},
"description": {
"type": "string",
"description": "Gets or sets the locality description",
"nullable": true
}
},
"additionalProperties": false,
"description": "A single place name, code and a description of its type."
},
"BulkAddressV1GetBatchResultsResponseAddressComponentsOrganization": {
"type": "object",
"properties": {
"department_name": {
"type": "string",
"description": "The department name within an organization.",
"nullable": true
},
"secondary_department_name": {
"type": "string",
"description": "The secondary department name within an organization.",
"nullable": true
},
"company_name": {
"type": "string",
"description": "The company name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The organization component."
},
"BulkAddressV1GetBatchResultsResponseAddressComponentsPostalCode": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"description": "The full name of the postal code.",
"nullable": true,
"example": "92626-7037"
},
"primary": {
"type": "string",
"description": "The primary name of the postal code.",
"nullable": true,
"example": "92626"
},
"secondary": {
"type": "string",
"description": "The secondary name of the postal code.",
"nullable": true,
"example": "7037"
}
},
"additionalProperties": false,
"description": "The post code component."
},
"BulkAddressV1GetBatchResultsResponseAddressComponentsRouteService": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"description": "The full name of the route service.",
"nullable": true
},
"service_type": {
"type": "string",
"description": "The route service type.",
"nullable": true
},
"service_number": {
"type": "string",
"description": "The route service number.",
"nullable": true
},
"delivery_name": {
"type": "string",
"description": "The route service delivery name.",
"nullable": true
},
"qualifier": {
"type": "string",
"description": "The route service qualifier.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The route service component."
},
"BulkAddressV1GetBatchResultsResponseAddressComponentsStreet": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"description": "The combination of the other populated secondary street components: prefix, name, type, suffix.",
"nullable": true,
"example": "Summer St"
},
"name": {
"type": "string",
"description": "The street name only.",
"nullable": true,
"example": "Summer"
},
"type": {
"type": "string",
"description": "The street type only.",
"nullable": true,
"example": "St"
},
"prefix": {
"type": "string",
"description": "The street prefix only.",
"nullable": true
},
"suffix": {
"type": "string",
"description": "The street suffix only.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The street component."
},
"BulkAddressV1GetBatchResultsResponseAddressComponentsSubBuilding": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of a building or property.",
"nullable": true
},
"entrance": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsSubBuildingItem"
},
"floor": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsSubBuildingItem"
},
"door": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressComponentsSubBuildingItem"
}
},
"additionalProperties": false,
"description": "The sub building component."
},
"BulkAddressV1GetBatchResultsResponseAddressComponentsSubBuildingItem": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"description": "The full name of this subcomponent.",
"nullable": true,
"example": "L 6"
},
"type": {
"type": "string",
"description": "The type of this subcomponent.",
"nullable": true,
"example": "L"
},
"value": {
"type": "string",
"description": "The value of this subcomponent.",
"nullable": true,
"example": "6"
}
},
"additionalProperties": false,
"description": "An item of sub-building information, such as a floor or entrance number or name."
},
"BulkAddressV1GetBatchResultsResponseAddressMatchInfo": {
"type": "object",
"properties": {
"postcode_action": {
"type": "string",
"description": "Postcode action info.",
"nullable": true
},
"address_action": {
"type": "string",
"description": "Address action info.",
"nullable": true
},
"generic_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "General match codes info.",
"nullable": true
},
"aus_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "AUS specific match codes info.",
"nullable": true
},
"deu_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "DEU specific match codes info.",
"nullable": true
},
"fra_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "FRA specific match codes info.",
"nullable": true
},
"gbr_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "GBR specific match codes info.",
"nullable": true
},
"nld_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "NLD specific match codes info.",
"nullable": true
},
"nzl_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "NZL specific match codes info.",
"nullable": true
},
"sgp_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "SGP specific match codes info.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Results response Address Match Info data"
},
"BulkAddressV1GetBatchResultsResponseAddressMetadata": {
"type": "object",
"properties": {
"address_info": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressMetadataAddressInfo"
},
"route_classification": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressMetadataRouteClassification"
},
"barcode": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressMetadataBarcode"
},
"address_classification": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressMetadataAddressClassification"
},
"dpv": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressMetadataDpv"
}
},
"additionalProperties": false,
"description": "The address metadata."
},
"BulkAddressV1GetBatchResultsResponseAddressMetadataAddressClassification": {
"type": "object",
"properties": {
"address_type": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressMetadataAddressClassificationAddressType"
},
"delivery_type": {
"type": "string",
"description": "Type of mail delivery at the address. Either \"business\", \"residential\" or \"mixed\".",
"nullable": true,
"example": "Business"
},
"is_deliverable": {
"type": "string",
"description": "Indicator if the address is deliverable - applicable to NZL addresses only.",
"nullable": true,
"example": "Y"
}
},
"additionalProperties": false,
"description": "Address deliverability and type indicators."
},
"BulkAddressV1GetBatchResultsResponseAddressMetadataAddressClassificationAddressType": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The code of the address type (applicable to USA, AUS and NZL addresses).",
"nullable": true,
"example": "S"
},
"description": {
"type": "string",
"description": "The description of the address type (applicable to USA, AUS and NZL addresses).",
"nullable": true,
"example": "Street"
}
},
"additionalProperties": false,
"description": "The address type."
},
"BulkAddressV1GetBatchResultsResponseAddressMetadataAddressInfo": {
"type": "object",
"properties": {
"sources": {
"type": "array",
"items": {
"type": "string"
},
"description": "Source of address information.",
"nullable": true
},
"number_of_households": {
"type": "string",
"description": "Number of households for records in GBR Not Yet Built, or multi-occupancy count of the owning delivery point for GBR Multiple Residence.",
"nullable": true,
"example": "1"
},
"just_built_date": {
"type": "string",
"description": "Construction date of the record, if it has been constructed in the last 6 months (GBR specific).",
"nullable": true,
"example": "20210605"
},
"identifier": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddressMetadataAddressInfoIdentifier"
}
},
"additionalProperties": false,
"description": "Address information."
},
"BulkAddressV1GetBatchResultsResponseAddressMetadataAddressInfoIdentifier": {
"type": "object",
"properties": {
"udprn": {
"type": "string",
"description": "Royal Mail's Unique Delivery Point Reference Number, an eight-digit code assigned to every delivery point in the Postcode Address File (PAF).",
"nullable": true,
"example": "12353232"
},
"umrrn": {
"type": "string",
"description": "Royal Mail's Unique Multiple Residence Reference Number, an eight-digit code linked to UDPRNs in Royal Mail's Multiple Residence dataset.",
"nullable": true,
"example": "50101642"
},
"dpid": {
"type": "string",
"description": "Australia Post's Delivery Point Identifier, an eight-digit number that uniquely identifies a physical location to which Australia Post delivers mail - applicable to AUS and NZL addresses.",
"nullable": true,
"example": "62147712"
},
"gnafpid": {
"type": "string",
"description": "Geoscape Australia's Geocoded National Address File Persistent Identifier (G-NAF ID).",
"nullable": true,
"example": "GAVIC424477161"
},
"hin": {
"type": "string",
"description": "Household Identification Number (applicable for AUS addresses).",
"nullable": true,
"example": "203060068"
},
"paf_address_key": {
"type": "string",
"description": "PAF Address key (GBR specific).",
"nullable": true,
"example": "2304084100000000S"
}
},
"additionalProperties": false,
"description": "The ID metadata of formatted address."
},
"BulkAddressV1GetBatchResultsResponseAddressMetadataBarcode": {
"type": "object",
"properties": {
"delivery_point_barcode": {
"type": "string",
"description": "The delivery point barcode (applicable for USA addresses only).",
"nullable": true,
"example": "02139430177"
},
"check_digit": {
"type": "string",
"description": "The delivery point barcode's check digit (applicable for USA addresses only).",
"nullable": true,
"example": "3"
},
"sort_plan_number": {
"type": "string",
"description": "The sort plan number barcode (applicable for AUS addresses only).",
"nullable": true,
"example": "022"
}
},
"additionalProperties": false,
"description": "Address barcode."
},
"BulkAddressV1GetBatchResultsResponseAddressMetadataDpv": {
"type": "object",
"properties": {
"cmra_indicator": {
"type": "string",
"description": "Indicates that the address is a private business that acts as a commercial mail-receiving agent for specific clients.",
"nullable": true,
"example": "Y"
},
"seed_indicator": {
"type": "string",
"description": "Seed records are control records placed by the USPS to prevent unauthorized tampering (e.g., creation of lists containing every single delivery point in a geographical region). A seed address will deactivate DPV functionality. To re-activate, please visit the Self Service Portal.",
"nullable": true,
"example": "Y"
},
"dpv_indicator": {
"type": "string",
"description": "Indicates whether selected address is confirmed as deliverable via DPV (Delivery Point Validation) process. For all possible values, please visit our technical documentation portal.",
"nullable": true,
"example": "Y"
},
"footnotes": {
"type": "array",
"items": {
"type": "string"
},
"description": "USPS codes denoting DPV match levels. For a list of all possible values, please visit our technical documentation portal.",
"nullable": true,
"example": [
"AA",
"BB"
]
},
"vacancy_indicator": {
"type": "string",
"description": "An address known to be unoccupied for over 90 days and therefore not receiving mail deliveries.",
"nullable": true,
"example": "Y"
},
"no_stats_indicator": {
"type": "string",
"description": "An address known to not receive mail deliveries (e.g. a house under construction).",
"nullable": true,
"example": "Y"
},
"pbsa_indicator": {
"type": "string",
"description": "Indicates addresses known to be Post Office Box Street Addresses (PBSA).",
"nullable": true,
"example": "Y"
}
},
"additionalProperties": false,
"description": "Delivery Point Validation information for the address (USA only)."
},
"BulkAddressV1GetBatchResultsResponseAddressMetadataRouteClassification": {
"type": "object",
"properties": {
"carrier_route": {
"type": "string",
"description": "The carrier route value (applicable for USA addresses only).",
"nullable": true,
"example": "C077"
},
"id": {
"type": "string",
"description": "The street identifier (applicable for AUS addresses only).",
"nullable": true,
"example": "38396"
}
},
"additionalProperties": false,
"description": "Address deliverability and type indicators."
},
"BulkAddressV1GetBatchResultsResponseResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"credits_charged": {
"type": "integer",
"description": "The number of credits charged for this Batch.",
"format": "int32"
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
},
"reason": {
"type": "string",
"description": "The reason of the current Batch status.",
"nullable": true
},
"statistics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseStatistic"
},
"description": "The statistics of the address confidence level.",
"nullable": true
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchResultsResponseAddress"
},
"description": "The Addresses validation results.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Batch Results result."
},
"BulkAddressV1GetBatchResultsResponseStatistic": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Confidence.",
"nullable": true,
"example": "verified"
},
"value": {
"type": "integer",
"description": "Count.",
"format": "int32",
"example": 10
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Results response statistic."
},
"BulkAddressV1GetBatchStatusMetadata": {
"type": "object",
"properties": {
"batch_config": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchStatusMetadataBatchConfig"
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Batch Status metadata."
},
"BulkAddressV1GetBatchStatusMetadataBatchConfig": {
"type": "object",
"properties": {
"country_iso": {
"type": "string",
"description": "Country ISO.",
"nullable": true
},
"datasets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Datasets.",
"nullable": true
},
"add_components": {
"type": "boolean",
"description": "Add components.",
"nullable": true
},
"add_metadata": {
"type": "boolean",
"description": "Add metadata.",
"nullable": true
},
"add_extra_match_info": {
"type": "boolean",
"description": "Add extra match info.",
"nullable": true
},
"max_processing_time": {
"type": "string",
"description": "Optional maximum processing time of the batch.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Batch Status metadata's batch config."
},
"BulkAddressV1GetBatchStatusResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchStatusResult"
},
"metadata": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchStatusMetadata"
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Batch Status response."
},
"BulkAddressV1GetBatchStatusResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
},
"reason": {
"type": "string",
"description": "The reason of the current Batch status.",
"nullable": true
},
"records": {
"type": "integer",
"description": "The number of address have been submitted.",
"format": "int32",
"nullable": true
},
"records_processed": {
"type": "integer",
"description": "The number of address have been processed.",
"format": "int32",
"nullable": true
},
"date_submitted": {
"type": "string",
"description": "The date time when the Batch is created in ISO-8601 format.",
"format": "date-time",
"nullable": true
},
"date_started": {
"type": "string",
"description": "The date time when the Batch is started in ISO-8601 format.",
"format": "date-time",
"nullable": true
},
"date_ended": {
"type": "string",
"description": "The date time when the Batch is ended in ISO-8601 format.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Batch Status result."
},
"BulkAddressV1GetBatchesBatch": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
},
"reason": {
"type": "string",
"description": "The reason of the current Batch status.",
"nullable": true
},
"records": {
"type": "integer",
"description": "The number of addresses have been submitted.",
"format": "int32"
},
"records_processed": {
"type": "integer",
"description": "The number of addresses have been processed.",
"format": "int32"
},
"date_submitted": {
"type": "string",
"description": "The date time when the Batch is created in ISO-8601 format.",
"format": "date-time"
},
"date_started": {
"type": "string",
"description": "The date time when the Batch is started in ISO-8601 format.",
"format": "date-time",
"nullable": true
},
"date_ended": {
"type": "string",
"description": "The date time when the Batch is ended in ISO-8601 format.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Batches Batch Info."
},
"BulkAddressV1GetBatchesResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchesResult"
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Batches response."
},
"BulkAddressV1GetBatchesResult": {
"type": "object",
"properties": {
"batches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkAddressV1GetBatchesBatch"
},
"description": "Batches.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Get Batches result."
},
"BulkAddressV1StartBatchResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkAddressV1StartBatchResult"
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Start Batch response."
},
"BulkAddressV1StartBatchResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Start Batch result."
},
"BulkAddressV1StopBatchResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkAddressV1StopBatchResult"
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Stop Batch response."
},
"BulkAddressV1StopBatchResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Address V1 Stop Batch result."
},
"BulkEmailV1CreateBatchRequest": {
"required": [
"emails"
],
"type": "object",
"properties": {
"defaults": {
"$ref": "#/components/schemas/BulkEmailV1CreateBatchRequestOptions"
},
"emails": {
"maxItems": 10000,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkEmailV1CreateBatchRequestEmail"
},
"description": "List of input components."
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Create Batch request."
},
"BulkEmailV1CreateBatchRequestEmail": {
"type": "object",
"properties": {
"email": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "The email address that is the subject of the validation.",
"nullable": true,
"example": "support@experian.com"
}
},
"additionalProperties": false,
"description": "Bulk Email V1 email component."
},
"BulkEmailV1CreateBatchRequestOptions": {
"type": "object",
"properties": {
"batch_reference_id": {
"maxLength": 256,
"minLength": 0,
"pattern": "^[\\w\\-\\/\\:\\.\\,\\(\\) ]+$",
"type": "string",
"description": "Optional identifier that will be returned in the response to help you track the batch.",
"nullable": true
},
"max_processing_time": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "Optional maximum processing time of the batch.\nIf the batch is still processing after this time, it will be stopped.\nThe value should be in ISO 8601 duration format (e.g., \"PT30M\" for 30 minutes).\nMaximum allowed value is \"PT24H\" (24 hours). Minimum allowed value is \"PT1M\" (1 minute).",
"nullable": true
}
},
"additionalProperties": false,
"description": "The default options that applied to the batch."
},
"BulkEmailV1CreateBatchResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkEmailV1CreateBatchResult"
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Create Batch response."
},
"BulkEmailV1CreateBatchResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Create Batch result."
},
"BulkEmailV1GetBatchResultsResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkEmailV1GetBatchResultsResult"
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Get Results response."
},
"BulkEmailV1GetBatchResultsResponseEmail": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email address that is the subject of the validation.",
"nullable": true,
"example": "support@experian.com"
},
"confidence": {
"type": "string",
"description": "The outcome (confidence level) of the validation.",
"nullable": true,
"example": "verified"
},
"verbose_output": {
"type": "string",
"description": "Additional information on the confidence level.",
"nullable": true,
"example": "verified"
},
"did_you_mean": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of more likely email addresses. Suggestions include fixes to syntax errors in the provided email address, typos in domains etc.",
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/BulkEmailV1GetBatchResultsResponseEmailMetadata"
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Get Results response."
},
"BulkEmailV1GetBatchResultsResponseEmailMetadata": {
"type": "object",
"properties": {
"domain_detail": {
"$ref": "#/components/schemas/BulkEmailV1GetBatchResultsResponseEmailMetadataDomainDetail"
}
},
"additionalProperties": false,
"description": "Metadata fields and values that can be returned, in addition to the main core information."
},
"BulkEmailV1GetBatchResultsResponseEmailMetadataDomainDetail": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type field value:\nconsumer - returned for \"free\" domains\nbusiness - returned for \"business\" domains\nOmit the field \"type\" when we are unable to provide a value",
"nullable": true,
"example": "consumer "
}
},
"additionalProperties": false,
"description": "Details about the domain."
},
"BulkEmailV1GetBatchResultsResponseStatistic": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Confidence.",
"nullable": true,
"example": "verified"
},
"value": {
"type": "integer",
"description": "Count.",
"format": "int32",
"example": 10
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Get Results response statistic."
},
"BulkEmailV1GetBatchResultsResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"credits_charged": {
"type": "integer",
"description": "The number of credits charged for this Batch.",
"format": "int32"
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
},
"reason": {
"type": "string",
"description": "The reason of the current Batch status.",
"nullable": true
},
"statistics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkEmailV1GetBatchResultsResponseStatistic"
},
"description": "The statistics of the email confidence level.",
"nullable": true
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkEmailV1GetBatchResultsResponseEmail"
},
"description": "The Emails validation results.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Get Batch Results result."
},
"BulkEmailV1GetBatchStatusBatchConfig": {
"type": "object",
"properties": {
"max_processing_time": {
"type": "string",
"description": "Optional maximum processing time of the batch.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The submitted default options."
},
"BulkEmailV1GetBatchStatusMetadata": {
"type": "object",
"properties": {
"batch_config": {
"$ref": "#/components/schemas/BulkEmailV1GetBatchStatusBatchConfig"
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Get Batch Status metadata."
},
"BulkEmailV1GetBatchStatusResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkEmailV1GetBatchStatusResult"
},
"metadata": {
"$ref": "#/components/schemas/BulkEmailV1GetBatchStatusMetadata"
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Get Batch Status response."
},
"BulkEmailV1GetBatchStatusResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
},
"reason": {
"type": "string",
"description": "The reason of the current Batch status.",
"nullable": true
},
"records": {
"type": "integer",
"description": "The number of email have been submitted.",
"format": "int32",
"nullable": true
},
"records_processed": {
"type": "integer",
"description": "The number of email have been processed.",
"format": "int32",
"nullable": true
},
"date_submitted": {
"type": "string",
"description": "The date time when the Batch is created in ISO-8601 format.",
"format": "date-time",
"nullable": true
},
"date_started": {
"type": "string",
"description": "The date time when the Batch is started in ISO-8601 format.",
"format": "date-time",
"nullable": true
},
"date_ended": {
"type": "string",
"description": "The date time when the Batch is ended in ISO-8601 format.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Get Batch Status result."
},
"BulkEmailV1GetBatchesBatch": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
},
"reason": {
"type": "string",
"description": "The reason of the current Batch status.",
"nullable": true
},
"records": {
"type": "integer",
"description": "The number of emails have been submitted.",
"format": "int32"
},
"records_processed": {
"type": "integer",
"description": "The number of emails have been processed.",
"format": "int32"
},
"date_submitted": {
"type": "string",
"description": "The date time when the Batch is created in ISO-8601 format.",
"format": "date-time"
},
"date_started": {
"type": "string",
"description": "The date time when the Batch is started in ISO-8601 format.",
"format": "date-time",
"nullable": true
},
"date_ended": {
"type": "string",
"description": "The date time when the Batch is ended in ISO-8601 format.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Get Batches Batch Info."
},
"BulkEmailV1GetBatchesResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkEmailV1GetBatchesResult"
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Get Batches response."
},
"BulkEmailV1GetBatchesResult": {
"type": "object",
"properties": {
"batches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkEmailV1GetBatchesBatch"
},
"description": "Batches.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Get Batches result."
},
"BulkEmailV1StartBatchResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkEmailV1StartBatchResult"
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Start Batch response."
},
"BulkEmailV1StartBatchResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Start Batch result."
},
"BulkEmailV1StopBatchResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkEmailV1StopBatchResult"
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Stop Batch response."
},
"BulkEmailV1StopBatchResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Email V1 Stop Batch result."
},
"BulkPhoneV1CreateBatchRequest": {
"required": [
"phones"
],
"type": "object",
"properties": {
"defaults": {
"$ref": "#/components/schemas/BulkPhoneV1CreateBatchRequestOptions"
},
"phones": {
"maxItems": 10000,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkPhoneV1CreateBatchRequestPhone"
},
"description": "List of input components."
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Create Batch request."
},
"BulkPhoneV1CreateBatchRequestOptions": {
"type": "object",
"properties": {
"output_format": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The desired format of the phone number: E164, PLUS_E164, NATIONAL, any 3-letter ISO country code.\nIf not specified, the default format, E164, will be used.",
"nullable": true,
"example": "NATIONAL"
},
"country_iso": {
"maxLength": 3,
"minLength": 0,
"type": "string",
"description": "You can indicate the 3-letter ISO country code if the phone number that is subject to validation doesn't contain a phone country code.",
"nullable": true,
"example": "GBR"
},
"get_ported_date": {
"type": "boolean",
"description": "The date the phone number was last ported, returned only if the number has been moved to a different network.\nThis is an optional field and is included only when get_ported_date is set to true, which incurs an additional click.",
"nullable": true,
"example": true
},
"supplementary_live_status": {
"$ref": "#/components/schemas/CreateBatchSupplementaryLiveStatus"
},
"batch_reference_id": {
"maxLength": 256,
"minLength": 0,
"pattern": "^[\\w\\-\\/\\:\\.\\,\\(\\) ]+$",
"type": "string",
"description": "Optional identifier that will be returned in the response to help you track the batch.",
"nullable": true
},
"max_processing_time": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "Optional maximum processing time of the batch.\nIf the batch is still processing after this time, it will be stopped.\nThe value should be in ISO 8601 duration format (e.g., \"PT30M\" for 30 minutes).\nMaximum allowed value is \"PT24H\" (24 hours). Minimum allowed value is \"PT1M\" (1 minute).",
"nullable": true
}
},
"additionalProperties": false,
"description": "The default options that applied to all the phone numbers."
},
"BulkPhoneV1CreateBatchRequestPhone": {
"type": "object",
"properties": {
"number": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "The phone number that is the subject of the validation.",
"nullable": true,
"example": "1234567890"
},
"country_iso": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "You can indicate the 3-letter ISO country code if the phone number that is subject to validation doesn't contain a phone country code.\nThis will overwrite the country_iso in the default options.",
"nullable": true,
"example": "GBR"
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 phone component."
},
"BulkPhoneV1CreateBatchResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkPhoneV1CreateBatchResult"
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Create Batch response."
},
"BulkPhoneV1CreateBatchResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Create Batch result."
},
"BulkPhoneV1GetBatchResultsResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkPhoneV1GetBatchResultsResult"
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Get Results response."
},
"BulkPhoneV1GetBatchResultsResponsePhone": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The phone number that is the subject of the validation.",
"nullable": true,
"example": "17087694383"
},
"validated_phone_number": {
"type": "string",
"description": "The validated phone number. Also includes the international country calling code. Note\nthat this field is returned even if the phone number has a confidence status of \"Invalid\".",
"nullable": true,
"example": "17087694383"
},
"formatted_phone_number": {
"type": "string",
"description": "The phone number in the format you specified in \"output_format\".",
"nullable": true,
"example": "(708) 769-4383"
},
"phone_type": {
"type": "string",
"description": "The type of phone number. Note: Landline is only supported in North America.",
"nullable": true,
"example": "Mobile"
},
"confidence": {
"type": "string",
"description": "The outcome (confidence level) of the validation.",
"nullable": true,
"example": "Verified"
},
"ported_date": {
"type": "string",
"description": "The date the phone number was last ported, returned only if the number has been moved to a different network. \nThis is an optional field and is included only when get_ported_date is set to true, which incurs an additional click.",
"nullable": true,
"example": "2012-06-27T09:32:09Z"
},
"disposable_number": {
"type": "string",
"description": "Indicates whether the phone number is a disposable number based on lookup list of disposable numbers.\nIf the number can be found in the lookup list, the value returned will be \"Yes\". Otherwise, the value returned\nwill be \"Unknown\". This value would be returned if the get_disposable_number boolean is set to true.",
"nullable": true,
"example": "Yes"
},
"metadata": {
"$ref": "#/components/schemas/BulkPhoneV1GetBatchResultsResponsePhoneMetadata"
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Get Results response."
},
"BulkPhoneV1GetBatchResultsResponsePhoneMetadata": {
"type": "object",
"properties": {
"original_operator_name": {
"type": "string",
"description": "The name of the MSISDN operator where the phone number was originally registered.",
"nullable": true,
"example": "T-Mobile"
},
"original_network_status": {
"type": "string",
"description": "The status of the network where the phone number was originally registered.",
"nullable": true,
"example": "Available"
},
"original_home_network_identity": {
"type": "string",
"description": "The Mobile Country Code (MCC) and Mobile Network Code (MNC) where the phone number was originally registered.",
"nullable": true,
"example": "310200"
},
"original_country_prefix": {
"type": "string",
"description": "The international calling code of the country where the phone number was originally registered.",
"nullable": true,
"example": "1"
},
"original_country_name": {
"type": "string",
"description": "The name of the country where the phone number was originally registered.",
"nullable": true,
"example": "United States of America"
},
"original_country_iso": {
"type": "string",
"description": "The 3-letter ISO code of the country where the phone number was originally registered.",
"nullable": true,
"example": "USA"
},
"operator_name": {
"type": "string",
"description": "The name of the MSISDN operator where the phone number is currently registered.",
"nullable": true,
"example": "Verizon"
},
"network_status": {
"type": "string",
"description": "The status of the network where the phone number is currently registered.",
"nullable": true,
"example": "Available"
},
"home_network_identity": {
"type": "string",
"description": "The Mobile Country Code (MCC) and Mobile Network Code (MNC) where the phone number is currently registered.",
"nullable": true,
"example": "311480"
},
"country_prefix": {
"type": "string",
"description": "The international calling code of the country where the phone number is currently registered.",
"nullable": true,
"example": "1"
},
"country_name": {
"type": "string",
"description": "The name of the country where the phone number is currently registered.",
"nullable": true,
"example": "United States of America"
},
"country_iso": {
"type": "string",
"description": "The 3-letter ISO code of the country where the phone number is currently registered.",
"nullable": true,
"example": "USA"
},
"is_ported": {
"type": "string",
"description": "Indicates whether the phone number is ported or not.",
"nullable": true,
"example": "Yes"
},
"email_to_sms_address": {
"type": "string",
"description": "Email address which can be used to send SMS messages to this phone number.",
"nullable": true,
"example": "7087694383@vtext.com"
},
"email_to_mms_address": {
"type": "string",
"description": "Email address which can be used to send MMS messages to this phone number.",
"nullable": true,
"example": "7087694383@vzwpix.com"
}
},
"additionalProperties": false,
"description": "Metadata fields and values that can be returned, in addition to the main core information."
},
"BulkPhoneV1GetBatchResultsResponseStatistic": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Confidence.",
"nullable": true,
"example": "Verified"
},
"value": {
"type": "integer",
"description": "Count.",
"format": "int32",
"example": 10
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Get Results response statistic."
},
"BulkPhoneV1GetBatchResultsResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"credits_charged": {
"type": "integer",
"description": "The number of credits charged for this Batch.",
"format": "int32"
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
},
"reason": {
"type": "string",
"description": "The reason of the current Batch status.",
"nullable": true
},
"statistics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkPhoneV1GetBatchResultsResponseStatistic"
},
"description": "The statistics of the phone numbers confidence level.",
"nullable": true
},
"phones": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkPhoneV1GetBatchResultsResponsePhone"
},
"description": "The phones validation results.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Get Batch Results result."
},
"BulkPhoneV1GetBatchStatusBatchConfig": {
"type": "object",
"properties": {
"output_format": {
"type": "string",
"description": "The desired format of the phone number: E164, PLUS_E164, NATIONAL, any 3-letter ISO country code.",
"nullable": true
},
"country_iso": {
"type": "string",
"description": "The 3-letter ISO country code if the phone number that is subject to validation doesn't contain a phone country code.",
"nullable": true
},
"get_ported_date": {
"type": "boolean",
"description": "A boolean indicator to attempt to retrieve the last ported date of the phone number.",
"nullable": true
},
"supplementary_live_status": {
"$ref": "#/components/schemas/BulkPhoneV1GetBatchStatusBatchConfigSupplementaryLiveStatus"
},
"max_processing_time": {
"type": "string",
"description": "Optional maximum processing time of the batch.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The submitted default options."
},
"BulkPhoneV1GetBatchStatusBatchConfigSupplementaryLiveStatus": {
"type": "object",
"properties": {
"mobile": {
"type": "array",
"items": {
"type": "string"
},
"description": "An indicator to attempt to get supplementary live status for Mobile Phone Number.",
"nullable": true
},
"landline": {
"type": "array",
"items": {
"type": "string"
},
"description": "An indicator to attempt to get supplementary live status for Landline Phone Number.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Batch configuration supplementary live status."
},
"BulkPhoneV1GetBatchStatusMetadata": {
"type": "object",
"properties": {
"batch_config": {
"$ref": "#/components/schemas/BulkPhoneV1GetBatchStatusBatchConfig"
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Get Batch Status metadata."
},
"BulkPhoneV1GetBatchStatusResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkPhoneV1GetBatchStatusResult"
},
"metadata": {
"$ref": "#/components/schemas/BulkPhoneV1GetBatchStatusMetadata"
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Get Batch Status response."
},
"BulkPhoneV1GetBatchStatusResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
},
"reason": {
"type": "string",
"description": "The reason of the current Batch status.",
"nullable": true
},
"records": {
"type": "integer",
"description": "The number of phone numbers have been submitted.",
"format": "int32",
"nullable": true
},
"records_processed": {
"type": "integer",
"description": "The number of phone numbers have been processed.",
"format": "int32",
"nullable": true
},
"date_submitted": {
"type": "string",
"description": "The date time when the Batch is created in ISO-8601 format.",
"format": "date-time"
},
"date_started": {
"type": "string",
"description": "The date time when the Batch is started in ISO-8601 format.",
"format": "date-time",
"nullable": true
},
"date_ended": {
"type": "string",
"description": "The date time when the Batch is ended in ISO-8601 format.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Get Batch Status result."
},
"BulkPhoneV1GetBatchesBatch": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
},
"reason": {
"type": "string",
"description": "The reason of the current Batch status.",
"nullable": true
},
"records": {
"type": "integer",
"description": "The number of phone numbers have been submitted.",
"format": "int32"
},
"records_processed": {
"type": "integer",
"description": "The number of phone numbers have been processed.",
"format": "int32"
},
"date_submitted": {
"type": "string",
"description": "The date time when the Batch is created in ISO-8601 format.",
"format": "date-time"
},
"date_started": {
"type": "string",
"description": "The date time when the Batch is started in ISO-8601 format.",
"format": "date-time",
"nullable": true
},
"date_ended": {
"type": "string",
"description": "The date time when the Batch is ended in ISO-8601 format.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Get Batches Batch Info."
},
"BulkPhoneV1GetBatchesResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkPhoneV1GetBatchesResult"
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Get Batches response."
},
"BulkPhoneV1GetBatchesResult": {
"type": "object",
"properties": {
"batches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkPhoneV1GetBatchesBatch"
},
"description": "Batches.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Get Batches result."
},
"BulkPhoneV1StartBatchResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkPhoneV1StartBatchResult"
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Start Batch response."
},
"BulkPhoneV1StartBatchResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Start Batch result."
},
"BulkPhoneV1StopBatchResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/BulkPhoneV1StopBatchResult"
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Stop Batch response."
},
"BulkPhoneV1StopBatchResult": {
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"description": "Batch ID.",
"nullable": true
},
"batch_reference_id": {
"type": "string",
"description": "Optional reference identifier to track this batch.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current Batch status.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bulk Phone V1 Stop Batch result."
},
"CommercialMosaicElements": {
"type": "object",
"properties": {
"group_type_code": {
"type": "string",
"description": "The group type code.",
"nullable": true
},
"group_type_description": {
"type": "string",
"description": "The group type description.",
"nullable": true
},
"group_code": {
"type": "string",
"description": "The group code.",
"nullable": true
},
"group_description": {
"type": "string",
"description": "The group description.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The Commercial mosaic elements."
},
"CreateBatchSupplementaryLiveStatus": {
"type": "object",
"properties": {
"mobile": {
"type": "array",
"items": {
"type": "string"
},
"description": "An indicator to attempt to get supplementary live status for Mobile Phone Number.",
"nullable": true,
"example": [
"USA"
]
},
"landline": {
"type": "array",
"items": {
"type": "string"
},
"description": "An indicator to attempt to get supplementary live status for Landline Phone Number.",
"nullable": true,
"example": [
"GBR"
]
}
},
"additionalProperties": false,
"description": "The supplementary live status request model. Please note that this feature has additional charge if requested."
},
"DatasetMetadata": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Attribute-level metadata code.",
"nullable": true,
"example": "S200"
},
"message": {
"type": "string",
"description": "Attribute-level metadata message.",
"nullable": true,
"example": "Match"
},
"value": {
"type": "string",
"description": "The attribute's value that was returned by the API.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The attribute's metadata."
},
"DatasetMetadataV2": {
"required": [
"code",
"message",
"value"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EmailRiskResult": {
"type": "object",
"properties": {
"score": {
"type": "integer",
"description": "A score indicating the risk level. Low score: 0, High score: 100",
"format": "int32",
"nullable": true,
"example": "100"
},
"tumbling_risk": {
"type": "integer",
"description": "A score indicating multiple variations of the same email address. 0 indicates no tumbling detected, while values of 1, 2 and 3 indicated a linear risk of tumbling detected.",
"format": "int32",
"nullable": true,
"example": "3"
},
"domain_risk": {
"type": "integer",
"description": "A score indicating the domain risk level, based on historical information and industry data. Low score: 0, High score: 10.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "The risk of a fraudulent profile."
},
"EmailValidationV1Confidence": {
"enum": [
"verified",
"undeliverable",
"unreachable",
"illegitimate",
"disposable",
"unknown"
],
"type": "string",
"description": "The outcome (confidence level) of the validation."
},
"EmailValidationV1Request": {
"required": [
"email"
],
"type": "object",
"properties": {
"email": {
"minLength": 1,
"type": "string",
"description": "The email address that is the subject of the validation.",
"example": "support@experian.com"
},
"timeout": {
"type": "integer",
"description": "Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 3-15. If a timeout occurs, a confidence status of \"unknown\" and a verbose result of \"timeout\" will be returned.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "The request model.",
"xml": {
"name": "request"
}
},
"EmailValidationV1Response": {
"type": "object",
"properties": {
"reference_id": {
"type": "string",
"description": "If you chose to submit a \"Reference-Id\" in the response body, the value will be returned with the response.",
"nullable": true
},
"transaction_id": {
"type": "string",
"description": "Unique Experian-assigned transaction identifier.",
"nullable": true,
"example": "ab123ab1-abc1-1234-abcd-ab1a123a1a12"
},
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/EmailValidationV1Result"
}
},
"additionalProperties": false,
"description": "The response model.",
"xml": {
"name": "response"
}
},
"EmailValidationV1Result": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email address that is the subject of the validation.",
"nullable": true,
"example": "support@experian.com"
},
"confidence": {
"$ref": "#/components/schemas/EmailValidationV1Confidence"
},
"verbose": {
"type": "string",
"description": "Additional information on the confidence level.",
"nullable": true,
"example": "verified, mailboxFull, unreachable"
},
"corrections": {
"type": "array",
"items": {
"type": "string",
"xml": {
"name": "correction"
}
},
"description": "A list of more likely email addresses. Suggestions include fixes to syntax errors in the provided email address, typos in domains etc.",
"nullable": true,
"xml": {
"name": "corrections",
"wrapped": true
}
}
},
"additionalProperties": false,
"description": "Details about the result. Includes the validated data and its confidence level."
},
"EnrichmentV2AprClassification": {
"enum": [
"code",
"record",
"scheme"
],
"type": "string",
"description": "The dataset named Addressbase Classification and its associated attributes."
},
"EnrichmentV2AprClassificationCodeResult": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Code describing land use classification.",
"nullable": true
},
"primary": {
"type": "string",
"description": "Description of primary classification element.",
"nullable": true
},
"secondary": {
"type": "string",
"description": "Description of secondary classification element.",
"nullable": true
},
"tertiary": {
"type": "string",
"description": "Description of tertiary classification element.",
"nullable": true
},
"quaternary": {
"type": "string",
"description": "Description of quaternary classification element.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Classification Code."
},
"EnrichmentV2AprClassificationMetadata": {
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"record": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"scheme": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2AprClassificationRecordResult": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Unique key of the classification record.",
"nullable": true
},
"start_date": {
"type": "string",
"description": "Start date of classification record.",
"nullable": true
},
"end_date": {
"type": "string",
"description": "End date of classification record.",
"nullable": true
},
"update_date": {
"type": "string",
"description": "Last update date of classification record.",
"nullable": true
},
"entry_date": {
"type": "string",
"description": "Entry date of classification record.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Classification Record."
},
"EnrichmentV2AprClassificationResult": {
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/EnrichmentV2AprClassificationCodeResult"
},
"record": {
"$ref": "#/components/schemas/EnrichmentV2AprClassificationRecordResult"
},
"scheme": {
"$ref": "#/components/schemas/EnrichmentV2AprClassificationSchemeResult"
}
},
"additionalProperties": false,
"description": "Response for Addressbase Classification dataset."
},
"EnrichmentV2AprClassificationSchemeResult": {
"type": "object",
"properties": {
"scheme": {
"type": "string",
"description": "Name of the classification scheme.",
"nullable": true
},
"version": {
"type": "string",
"description": "Version of the classification scheme.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Classification Scheme."
},
"EnrichmentV2AprCrossReference": {
"enum": [
"addresslayer_2",
"council_tax",
"integrated_transport_network",
"non_domestic_rates",
"topography_layer"
],
"type": "string",
"description": "The dataset named Addressbase Cross Reference and its associated attributes."
},
"EnrichmentV2AprCrossReferenceAddressLayer2Result": {
"type": "object",
"properties": {
"primary_key": {
"type": "string",
"description": "Primary key of the record in external dataset.",
"nullable": true
},
"key": {
"type": "string",
"description": "Unique key for the cross reference record.",
"nullable": true
},
"version": {
"type": "string",
"description": "Version number of the source object.",
"nullable": true
},
"created_date": {
"type": "string",
"description": "Date the record was created.",
"nullable": true
},
"update_date": {
"type": "string",
"description": "Date the record was last changed.",
"nullable": true
},
"entry_date": {
"type": "string",
"description": "Date of data entry.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Cross Reference Address Layer 2."
},
"EnrichmentV2AprCrossReferenceCouncilTaxResult": {
"type": "object",
"properties": {
"primary_key": {
"type": "string",
"description": "Primary key of the record in external dataset.",
"nullable": true
},
"key": {
"type": "string",
"description": "Unique key for the cross reference record.",
"nullable": true
},
"version": {
"type": "string",
"description": "Version number of the source object.",
"nullable": true
},
"created_date": {
"type": "string",
"description": "Date the record was created.",
"nullable": true
},
"update_date": {
"type": "string",
"description": "Date the record was last changed.",
"nullable": true
},
"entry_date": {
"type": "string",
"description": "Date of data entry.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Cross Reference Council Tax."
},
"EnrichmentV2AprCrossReferenceIntegratedTransportNetworkResult": {
"type": "object",
"properties": {
"primary_key": {
"type": "string",
"description": "Primary key of the record in external dataset.",
"nullable": true
},
"key": {
"type": "string",
"description": "Unique key for the cross reference record.",
"nullable": true
},
"version": {
"type": "string",
"description": "Version number of the source object.",
"nullable": true
},
"created_date": {
"type": "string",
"description": "Date the record was created.",
"nullable": true
},
"update_date": {
"type": "string",
"description": "Date the record was last changed.",
"nullable": true
},
"entry_date": {
"type": "string",
"description": "Date of data entry.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Cross Reference Integrated Transport Network."
},
"EnrichmentV2AprCrossReferenceMetadata": {
"type": "object",
"properties": {
"addresslayer_2": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"council_tax": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"integrated_transport_network": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"non_domestic_rates": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"topography_layer": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2AprCrossReferenceNonDomesticRatesResult": {
"type": "object",
"properties": {
"primary_key": {
"type": "string",
"description": "Primary key of the record in external dataset.",
"nullable": true
},
"key": {
"type": "string",
"description": "Unique key for the cross reference record.",
"nullable": true
},
"version": {
"type": "string",
"description": "Version number of the source object.",
"nullable": true
},
"created_date": {
"type": "string",
"description": "Date the record was created.",
"nullable": true
},
"update_date": {
"type": "string",
"description": "Date the record was last changed.",
"nullable": true
},
"entry_date": {
"type": "string",
"description": "Date of data entry.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Cross Reference Non Domestic Rates."
},
"EnrichmentV2AprCrossReferenceResult": {
"type": "object",
"properties": {
"addresslayer_2": {
"$ref": "#/components/schemas/EnrichmentV2AprCrossReferenceAddressLayer2Result"
},
"council_tax": {
"$ref": "#/components/schemas/EnrichmentV2AprCrossReferenceCouncilTaxResult"
},
"integrated_transport_network": {
"$ref": "#/components/schemas/EnrichmentV2AprCrossReferenceIntegratedTransportNetworkResult"
},
"non_domestic_rates": {
"$ref": "#/components/schemas/EnrichmentV2AprCrossReferenceNonDomesticRatesResult"
},
"topography_layer": {
"$ref": "#/components/schemas/EnrichmentV2AprCrossReferenceTopographyLayerResult"
}
},
"additionalProperties": false,
"description": "Response for Addressbase Cross Reference dataset."
},
"EnrichmentV2AprCrossReferenceTopographyLayerResult": {
"type": "object",
"properties": {
"primary_key": {
"type": "string",
"description": "Primary key of the record in external dataset.",
"nullable": true
},
"key": {
"type": "string",
"description": "Unique key for the cross reference record.",
"nullable": true
},
"version": {
"type": "string",
"description": "Version number of the source object.",
"nullable": true
},
"created_date": {
"type": "string",
"description": "Date the record was created.",
"nullable": true
},
"update_date": {
"type": "string",
"description": "Date the record was last changed.",
"nullable": true
},
"entry_date": {
"type": "string",
"description": "Date of data entry.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Cross Reference Topography Layer."
},
"EnrichmentV2AprGovernment": {
"enum": [
"government"
],
"type": "string",
"description": "The dataset named Addressbase Government and its associated attributes."
},
"EnrichmentV2AprGovernmentElementsResult": {
"type": "object",
"properties": {
"eer_code": {
"type": "string",
"description": "Code for European Electoral Region.",
"nullable": true
},
"eer_name": {
"type": "string",
"description": "Name of European Electoral Region.",
"nullable": true
},
"gor_code": {
"type": "string",
"description": "Code for Government Office Region.",
"nullable": true
},
"gor_name": {
"type": "string",
"description": "Name of Government Office Region.",
"nullable": true
},
"lea_code": {
"type": "string",
"description": "Code for Local Education Authority.",
"nullable": true
},
"lea_name": {
"type": "string",
"description": "Name of Local Education Authority.",
"nullable": true
},
"la_code": {
"type": "string",
"description": "Code for Local Authority.",
"nullable": true
},
"la_name": {
"type": "string",
"description": "Name of Local Authority.",
"nullable": true
},
"ward_code": {
"type": "string",
"description": "Code for Local Authority Ward.",
"nullable": true
},
"ward_name": {
"type": "string",
"description": "Name of Local Authority Ward.",
"nullable": true
},
"cens_out_area": {
"type": "string",
"description": "Census Area output code.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Government Elements."
},
"EnrichmentV2AprGovernmentMetadata": {
"type": "object",
"properties": {
"government": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2AprGovernmentResult": {
"type": "object",
"properties": {
"government": {
"$ref": "#/components/schemas/EnrichmentV2AprGovernmentElementsResult"
}
},
"additionalProperties": false,
"description": "Response for Addressbase Government dataset."
},
"EnrichmentV2AprHealth": {
"enum": [
"health"
],
"type": "string",
"description": "The dataset named Addressbase Health and its associated attributes."
},
"EnrichmentV2AprHealthElementsResult": {
"type": "object",
"properties": {
"authority_code": {
"type": "string",
"description": "Code for NHS Authority.",
"nullable": true
},
"authority_name": {
"type": "string",
"description": "Name of NHS Authority.",
"nullable": true
},
"pclh_code": {
"type": "string",
"description": "Code for Primary Care Trust or Local Health Group.",
"nullable": true
},
"pclh_name": {
"type": "string",
"description": "Name of Primary Care Trust or Local Health Group.",
"nullable": true
},
"ward_code": {
"type": "string",
"description": "Code for Local Authority Ward.",
"nullable": true
},
"ward_name": {
"type": "string",
"description": "Name of Local Authority Ward.",
"nullable": true
},
"ccg_code": {
"type": "string",
"description": "Code for Clinical Commissioning Group or equivalent.",
"nullable": true
},
"ccg_name": {
"type": "string",
"description": "Name of Clinical Commissioning Group or equivalent.",
"nullable": true
},
"doh_code": {
"type": "string",
"description": "Department of Health area code.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Health Elements."
},
"EnrichmentV2AprHealthMetadata": {
"type": "object",
"properties": {
"health": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2AprHealthResult": {
"type": "object",
"properties": {
"health": {
"$ref": "#/components/schemas/EnrichmentV2AprHealthElementsResult"
}
},
"additionalProperties": false,
"description": "Response for Addressbase Health dataset."
},
"EnrichmentV2AprLocationGrid": {
"enum": [
"blpu",
"building",
"postal_code",
"street"
],
"type": "string",
"description": "The dataset named Addressbase Location Grid and its associated attributes."
},
"EnrichmentV2AprLocationGridBlpuResult": {
"type": "object",
"properties": {
"x_coordinate": {
"type": "number",
"description": "Easting coordinate of the BLPU in metres (1 cm resolution).",
"format": "double",
"nullable": true
},
"y_coordinate": {
"type": "number",
"description": "Northing coordinate of the BLPU in metres (1 cm resolution).",
"format": "double",
"nullable": true
},
"ap_x_coordinate": {
"type": "number",
"description": "Easting coordinate in 10 cm resolution, zero-padded to 8 digits.",
"format": "double",
"nullable": true
},
"ap_y_coordinate": {
"type": "number",
"description": "Northing coordinate in 10 cm resolution, zero-padded to 8 digits.",
"format": "double",
"nullable": true
},
"latitude": {
"type": "number",
"description": "Latitude of the BLPU using the ETRS89 coordinate system.",
"format": "double",
"nullable": true
},
"longitude": {
"type": "number",
"description": "Longitude of the BLPU using the ETRS89 coordinate system.",
"format": "double",
"nullable": true
},
"rpc": {
"type": "string",
"description": "Indicates the location type of the grid reference (e.g., visual centre, postcode-based).",
"nullable": true
},
"postal_code": {
"type": "string",
"description": "The postcode associated with the BLPU.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Location Grid Blpu."
},
"EnrichmentV2AprLocationGridBuildingResult": {
"type": "object",
"properties": {
"x_coordinate": {
"type": "number",
"description": "Easting coordinate of the building in metres (1 cm resolution).",
"format": "double",
"nullable": true
},
"y_coordinate": {
"type": "number",
"description": "Northing coordinate of the building in metres (1 cm resolution).",
"format": "double",
"nullable": true
},
"ap_x_coordinate": {
"type": "number",
"description": "Easting coordinate in 10 cm resolution, zero-padded to 8 digits.",
"format": "double",
"nullable": true
},
"ap_y_coordinate": {
"type": "number",
"description": "Northing coordinate in 10 cm resolution, zero-padded to 8 digits.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Location Grid Building."
},
"EnrichmentV2AprLocationGridMetadata": {
"type": "object",
"properties": {
"blpu": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"building": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"postal_code": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"street": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2AprLocationGridPostalCodeResult": {
"type": "object",
"properties": {
"x_coordinate": {
"type": "number",
"description": "Easting coordinate of the postcode in metres (1 cm resolution).",
"format": "double",
"nullable": true
},
"y_coordinate": {
"type": "number",
"description": "Northing coordinate of the postcode in metres (1 cm resolution).",
"format": "double",
"nullable": true
},
"ap_x_coordinate": {
"type": "number",
"description": "Easting coordinate in 10 cm resolution, zero-padded to 8 digits.",
"format": "double",
"nullable": true
},
"ap_y_coordinate": {
"type": "number",
"description": "Northing coordinate in 10 cm resolution, zero-padded to 8 digits.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Location Grid Postal Code."
},
"EnrichmentV2AprLocationGridResult": {
"type": "object",
"properties": {
"blpu": {
"$ref": "#/components/schemas/EnrichmentV2AprLocationGridBlpuResult"
},
"building": {
"$ref": "#/components/schemas/EnrichmentV2AprLocationGridBuildingResult"
},
"postal_code": {
"$ref": "#/components/schemas/EnrichmentV2AprLocationGridPostalCodeResult"
},
"street": {
"$ref": "#/components/schemas/EnrichmentV2AprLocationGridStreetResult"
}
},
"additionalProperties": false,
"description": "Response for Addressbase Location Grid dataset."
},
"EnrichmentV2AprLocationGridStreetResult": {
"type": "object",
"properties": {
"x_coordinate": {
"type": "number",
"description": "Easting coordinate of the street in metres (1 cm resolution).",
"format": "double",
"nullable": true
},
"y_coordinate": {
"type": "number",
"description": "Northing coordinate of the street in metres (1 cm resolution).",
"format": "double",
"nullable": true
},
"ap_x_coordinate": {
"type": "number",
"description": "Easting coordinate in 10 cm resolution, zero-padded to 8 digits.",
"format": "double",
"nullable": true
},
"ap_y_coordinate": {
"type": "number",
"description": "Northing coordinate in 10 cm resolution, zero-padded to 8 digits.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Location Grid Street."
},
"EnrichmentV2AprParliament": {
"enum": [
"westminster"
],
"type": "string",
"description": "The dataset named Addressbase Parliament and its associated attributes."
},
"EnrichmentV2AprParliamentMetadata": {
"type": "object",
"properties": {
"westminster": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2AprParliamentResult": {
"type": "object",
"properties": {
"westminster": {
"$ref": "#/components/schemas/EnrichmentV2AprParliamentWestminsterResult"
}
},
"additionalProperties": false,
"description": "Response for Addressbase Parliament dataset."
},
"EnrichmentV2AprParliamentWestminsterResult": {
"type": "object",
"properties": {
"constituency_code": {
"type": "string",
"description": "Code for Parliamentary Constituency.",
"nullable": true
},
"constituency": {
"type": "string",
"description": "Name of Parliamentary Constituency.",
"nullable": true
},
"mp": {
"type": "string",
"description": "Name of the MP.",
"nullable": true
},
"mp_party": {
"type": "string",
"description": "Political party of the MP.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Parliament Westminster."
},
"EnrichmentV2AprQuality": {
"enum": [
"custodian",
"metadata",
"record"
],
"type": "string",
"description": "The dataset named Addressbase Quality and its associated attributes."
},
"EnrichmentV2AprQualityCustodianResult": {
"type": "object",
"properties": {
"custodian": {
"type": "string",
"description": "Name of the custodian organization.",
"nullable": true
},
"custodian_uprn": {
"type": "string",
"description": "UPRN of the custodian location.",
"nullable": true
},
"custodian_language": {
"type": "string",
"description": "Local language name of the custodian.",
"nullable": true
},
"custodian_code": {
"type": "string",
"description": "Four-digit code identifying the custodian.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Quality Custodian."
},
"EnrichmentV2AprQualityMetadata": {
"type": "object",
"properties": {
"custodian": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"metadata": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"record": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2AprQualityMetadataResult": {
"type": "object",
"properties": {
"coordinate_system": {
"type": "string",
"description": "Name of the coordinate system used.",
"nullable": true
},
"coordinate_unit": {
"type": "string",
"description": "Unit of measurement used.",
"nullable": true
},
"postal_code_type": {
"type": "string",
"description": "Indicates small or large user postcode.",
"nullable": true
},
"gazetteer_name": {
"type": "string",
"description": "Name of the dataset.",
"nullable": true
},
"gazetteer_scope": {
"type": "string",
"description": "Description of dataset contents.",
"nullable": true
},
"linked_data": {
"type": "string",
"description": "External sources used to update dataset.",
"nullable": true
},
"gazetteer_owner": {
"type": "string",
"description": "Organization responsible for the dataset.",
"nullable": true
},
"metadata_date": {
"type": "string",
"description": "Date metadata was last updated.",
"nullable": true
},
"classification_scheme": {
"type": "string",
"description": "Classification scheme used in dataset.",
"nullable": true
},
"gazetteer_date": {
"type": "string",
"description": "Date dataset is considered current.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Quality Metadata."
},
"EnrichmentV2AprQualityRecordResult": {
"type": "object",
"properties": {
"blpu_status": {
"type": "string",
"description": "Indicates the status of the address associated with the BLPU record.",
"nullable": true
},
"lpi_status": {
"type": "string",
"description": "Indicates the status of the address associated with the LPI record.",
"nullable": true
},
"state": {
"type": "string",
"description": "Indicates the current state of the BLPU.",
"nullable": true
},
"state_date": {
"type": "string",
"description": "The date on which the BLPU entered its current state.",
"nullable": true
},
"start_date": {
"type": "string",
"description": "The date on which the BLPU was defined.",
"nullable": true
},
"update_date": {
"type": "string",
"description": "The date on which the record was last updated.",
"nullable": true
},
"entry_date": {
"type": "string",
"description": "The date of data entry.",
"nullable": true
},
"update_frequency": {
"type": "string",
"description": "Indicates how frequently the data is updated.",
"nullable": true
},
"is_official": {
"type": "string",
"description": "Indicates the status of an address in the official street naming and numbering register.",
"nullable": true
},
"paf_update_date": {
"type": "string",
"description": "The date on which a Royal Mail Delivery Point Address was last updated.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Quality Record."
},
"EnrichmentV2AprQualityResult": {
"type": "object",
"properties": {
"custodian": {
"$ref": "#/components/schemas/EnrichmentV2AprQualityCustodianResult"
},
"metadata": {
"$ref": "#/components/schemas/EnrichmentV2AprQualityMetadataResult"
},
"record": {
"$ref": "#/components/schemas/EnrichmentV2AprQualityRecordResult"
}
},
"additionalProperties": false,
"description": "Response for Addressbase Quality dataset."
},
"EnrichmentV2AprStreet": {
"enum": [
"grid",
"record",
"usrn"
],
"type": "string",
"description": "The dataset named Addressbase Street and its associated attributes."
},
"EnrichmentV2AprStreetGridResult": {
"type": "object",
"properties": {
"start_x_coordinate": {
"type": "number",
"description": "The Easting co-ordinate of the start point of the street.",
"format": "double",
"nullable": true
},
"start_y_coordinate": {
"type": "number",
"description": "The Northing co-ordinate of the start point of the street.",
"format": "double",
"nullable": true
},
"end_x_coordinate": {
"type": "number",
"description": "The Easting co-ordinate of the end point of the street.",
"format": "double",
"nullable": true
},
"end_y_coordinate": {
"type": "number",
"description": "The Northing co-ordinate of the end point of the street.",
"format": "double",
"nullable": true
},
"start_latitude": {
"type": "number",
"description": "Latitude of the start point of the street in accordance with the ETRS89 co-ordinate reference system.",
"format": "double",
"nullable": true
},
"start_longitude": {
"type": "number",
"description": "Longitude of the start point of the street in accordance with the ETRS89 co-ordinate reference system.",
"format": "double",
"nullable": true
},
"end_latitude": {
"type": "number",
"description": "Latitude of the end point of the street in accordance with the ETRS89 co-ordinate reference system.",
"format": "double",
"nullable": true
},
"end_longitude": {
"type": "number",
"description": "Longitude of the end point of the street in accordance with the ETRS89 co-ordinate reference system.",
"format": "double",
"nullable": true
},
"tolerance": {
"type": "string",
"description": "The potential variance in metres of the start and end co-ordinates of the street.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Street Grid."
},
"EnrichmentV2AprStreetMetadata": {
"type": "object",
"properties": {
"grid": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"record": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"usrn": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2AprStreetRecordResult": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Indicates the street type represented by the record.",
"nullable": true
},
"authority": {
"type": "string",
"description": "Indicates the Street Naming and Numbering Authority or Local Highway Authority.",
"nullable": true
},
"classification": {
"type": "string",
"description": "Indicates the classification of the street record.",
"nullable": true
},
"surface_type": {
"type": "string",
"description": "Shows the type of surface on the street.",
"nullable": true
},
"state": {
"type": "string",
"description": "Shows the current state of the street.",
"nullable": true
},
"state_date": {
"type": "string",
"description": "The date on which the street entered its current state.",
"nullable": true
},
"version": {
"type": "string",
"description": "Version number of the street record.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Street Record."
},
"EnrichmentV2AprStreetResult": {
"type": "object",
"properties": {
"grid": {
"$ref": "#/components/schemas/EnrichmentV2AprStreetGridResult"
},
"record": {
"$ref": "#/components/schemas/EnrichmentV2AprStreetRecordResult"
},
"usrn": {
"$ref": "#/components/schemas/EnrichmentV2AprStreetUsrnResult"
}
},
"additionalProperties": false,
"description": "Response for Addressbase Street dataset."
},
"EnrichmentV2AprStreetUsrnResult": {
"type": "object",
"properties": {
"usrn": {
"type": "string",
"description": "An 8-character code assigned to every street.",
"nullable": true
},
"usrn_match": {
"type": "string",
"description": "Indicates how the address was matched to the USRN (manual or spatial match).",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Street Usrn."
},
"EnrichmentV2AprTopography": {
"enum": [
"topographic_ids"
],
"type": "string",
"description": "The dataset named Addressbase Topography and its associated attributes."
},
"EnrichmentV2AprTopographyMetadata": {
"type": "object",
"properties": {
"topographic_ids": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2AprTopographyResult": {
"type": "object",
"properties": {
"topographic_ids": {
"$ref": "#/components/schemas/EnrichmentV2AprTopographyTopographicIdsResult"
}
},
"additionalProperties": false,
"description": "Response for Addressbase Topography dataset."
},
"EnrichmentV2AprTopographyTopographicIdsResult": {
"type": "object",
"properties": {
"addresslayer_2": {
"type": "string",
"description": "TOID of the nearest feature in OS MasterMap Address Layer 2, typically for buildings.",
"nullable": true
},
"topography_layer": {
"type": "string",
"description": "TOID of the nearest topographical feature in OS MasterMap Topographic Layer.",
"nullable": true
},
"integrated_transport_network": {
"type": "string",
"description": "TOID of the nearest transport feature, usually the road providing access to the object.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Topography TopographicIds."
},
"EnrichmentV2AprVoa": {
"enum": [
"primary_description",
"special_category"
],
"type": "string",
"description": "The dataset named Addressbase Voa and its associated attributes."
},
"EnrichmentV2AprVoaMetadata": {
"type": "object",
"properties": {
"primary_description": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"special_category": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2AprVoaPrimaryDescriptionResult": {
"type": "object",
"properties": {
"scheme": {
"type": "string",
"description": "Name of VOA classification scheme.",
"nullable": true
},
"version": {
"type": "string",
"description": "Version of VOA classification scheme.",
"nullable": true
},
"key": {
"type": "string",
"description": "Unique key of the classification record.",
"nullable": true
},
"code": {
"type": "string",
"description": "Code describing VOA classification.",
"nullable": true
},
"start_date": {
"type": "string",
"description": "Start date of classification record.",
"nullable": true
},
"end_date": {
"type": "string",
"description": "End date of classification record.",
"nullable": true
},
"update_date": {
"type": "string",
"description": "Last update date of classification record.",
"nullable": true
},
"entry_date": {
"type": "string",
"description": "Entry date of classification record.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Voa Primary Description."
},
"EnrichmentV2AprVoaResult": {
"type": "object",
"properties": {
"primary_description": {
"$ref": "#/components/schemas/EnrichmentV2AprVoaPrimaryDescriptionResult"
},
"special_category": {
"$ref": "#/components/schemas/EnrichmentV2AprVoaSpecialCategoryResult"
}
},
"additionalProperties": false,
"description": "Response for Addressbase Voa dataset."
},
"EnrichmentV2AprVoaSpecialCategoryResult": {
"type": "object",
"properties": {
"scheme": {
"type": "string",
"description": "Name of VOA special category scheme.",
"nullable": true
},
"version": {
"type": "string",
"description": "Version of VOA special category scheme.",
"nullable": true
},
"key": {
"type": "string",
"description": "Unique key of the classification record.",
"nullable": true
},
"code": {
"type": "string",
"description": "Code describing VOA special category.",
"nullable": true
},
"start_date": {
"type": "string",
"description": "Start date of classification record.",
"nullable": true
},
"end_date": {
"type": "string",
"description": "End date of classification record.",
"nullable": true
},
"update_date": {
"type": "string",
"description": "Last update date of classification record.",
"nullable": true
},
"entry_date": {
"type": "string",
"description": "Entry date of classification record.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for Addressbase Voa Special Category."
},
"EnrichmentV2AttributesAusRegionalGeocodes": {
"enum": [
"latitude",
"longitude",
"match_level",
"sa1",
"meshblock",
"lga_code",
"lga_name",
"street_pid",
"locality_pid",
"geocode_level_code",
"geocode_level_description",
"geocode_type_code",
"geocode_type_description",
"highest_level_longitude",
"highest_level_latitude",
"highest_level_elevation",
"highest_level_planimetric_accuracy",
"highest_level_boundary_extent",
"highest_level_geocode_reliability_code",
"highest_level_geocode_reliability_description",
"confidence_level_code",
"confidence_level_description",
"2021_meshblock_id",
"2021_meshblock_code",
"2021_meshblock_match_code",
"2021_meshblock_match_description",
"2016_meshblock_id",
"2016_meshblock_code",
"2016_meshblock_match_code",
"2016_meshblock_match_description",
"address_type_code",
"primary_address_pid",
"address_join_type",
"collector_district_id",
"collector_district_code",
"commonwealth_electoral_boundary_id",
"commonwealth_electoral_boundary_name",
"statistical_local_area_id",
"statistical_local_area_code",
"statistical_local_area_name",
"state_electoral_boundary_id",
"state_electoral_boundary_name",
"state_electoral_effective_start",
"state_electoral_effective_end",
"state_electoral_new_pid",
"state_electoral_new_name",
"state_electoral_new_effective_start",
"state_electoral_new_effective_end",
"address_level_longitude",
"address_level_latitude",
"address_level_elevation",
"address_level_planimetric_accuracy",
"address_level_boundary_extent",
"address_level_geocode_reliability_code",
"address_level_geocode_reliability_description",
"street_level_longitude",
"street_level_latitude",
"street_level_planimetric_accuracy",
"street_level_boundary_extent",
"street_level_geocode_reliability_code",
"street_level_geocode_reliability_description",
"locality_level_longitude",
"locality_level_latitude",
"locality_level_planimetric_accuracy",
"locality_level_geocode_reliability_code",
"locality_level_geocode_reliability_description",
"gnaf_legal_parcel_identifier",
"locality_class_code"
],
"type": "string",
"description": "The dataset named AUS Regional Geocodes its associated attributes."
},
"EnrichmentV2AttributesGbAdditionalBusinessAddressValidate": {
"enum": [
"urn",
"commercial_mosaic",
"registration",
"phone",
"number_of_employees",
"location",
"standard_industry_classification",
"non_limited_company_key"
],
"type": "string",
"description": "The dataset named what3words and its associated attributes."
},
"EnrichmentV2AttributesGbrGovernment": {
"enum": [
"eer_code",
"eer_code_pre_2011",
"eer_name",
"gor_code",
"gor_code_pre_2011",
"gor_name",
"lea_code",
"lea_name",
"la_code",
"la_code_pre_2011",
"la_name",
"ward_code",
"ward_code_pre_2011",
"ward_name",
"cens_out_area"
],
"type": "string",
"description": "The dataset named GBR Government and its associated attributes."
},
"EnrichmentV2AttributesGbrHealth": {
"enum": [
"authority_code",
"authority_code_2011",
"authority_name",
"pclh_code",
"pclh_code_2011",
"pclh_name",
"ward_code",
"ward_code_2011",
"ward_name",
"ccg_code",
"ccg_name",
"doh_code"
],
"type": "string",
"description": "The dataset named GBR Health and its associated attributes."
},
"EnrichmentV2AttributesGbrRegionalGeocode": {
"enum": [
"latitude",
"longitude",
"match_level",
"udprn",
"uprn",
"x_coordinate",
"y_coordinate"
],
"type": "string",
"description": "The dataset named GBR Regional Geocodes its associated attributes."
},
"EnrichmentV2AttributesGeocode": {
"enum": [
"latitude",
"longitude",
"match_level"
],
"type": "string",
"description": "The dataset named Geocodes and its associated attributes."
},
"EnrichmentV2AttributesNzlRegionalGeocodes": {
"enum": [
"front_of_property_nztm_x_coordinate",
"front_of_property_nztm_y_coordinate",
"centroid_of_property_nztm_x_coordinate",
"centroid_of_property_nztm_y_coordinate",
"linz_parcel_id",
"property_purpose_type",
"addressable",
"mesh_block_code",
"territorial_authority_code",
"territorial_authority_name",
"regional_council_code",
"regional_council_name",
"general_electorate_code",
"general_electorate_name",
"maori_electorate_code",
"maori_electorate_name",
"front_of_property_latitude",
"front_of_property_longitude",
"centroid_of_property_latitude",
"centroid_of_property_longitude",
"match_level"
],
"type": "string",
"description": "The dataset named NZL Regional Geocodes its associated attributes."
},
"EnrichmentV2AttributesPremiumLocationInsight": {
"enum": [
"geocodes",
"geocodes_building_xy",
"geocodes_access",
"time"
],
"type": "string",
"description": "The dataset named Premium Location Insight and its associated attributes.\n\n (The time attribute is excluded in Premium Location Insight Lite.) "
},
"EnrichmentV2AttributesUkLocationComplete": {
"enum": [
"latitude",
"longitude",
"match_level",
"udprn",
"uprn",
"x_coordinate",
"y_coordinate"
],
"type": "string",
"description": "The dataset named UK Location Complete its associated attributes."
},
"EnrichmentV2AttributesUkLocationEssential": {
"enum": [
"latitude",
"longitude",
"match_level",
"udprn",
"uprn",
"x_coordinate",
"y_coordinate"
],
"type": "string",
"description": "The dataset named UK Location Essential its associated attributes."
},
"EnrichmentV2AttributesUsaRegionalGeocodes": {
"enum": [
"latitude",
"longitude",
"match_level",
"census_tract",
"census_block",
"core_based_statistical_area",
"congressional_district_code",
"county_code"
],
"type": "string",
"description": "The dataset named USA Regional Geocodes its associated attributes."
},
"EnrichmentV2AttributesWhat3Words": {
"enum": [
"latitude",
"longitude",
"name",
"description"
],
"type": "string",
"description": "The dataset named what3words and its associated attributes."
},
"EnrichmentV2AusRegionalGeocodesMetadata": {
"type": "object",
"properties": {
"latitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"longitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"match_level": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"sa1": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"meshblock": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"lga_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"lga_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"street_pid": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"locality_pid": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"geocode_level_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"geocode_level_description": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"geocode_type_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"geocode_type_description": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"highest_level_longitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"highest_level_latitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"highest_level_elevation": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"highest_level_planimetric_accuracy": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"highest_level_boundary_extent": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"highest_level_geocode_reliability_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"highest_level_geocode_reliability_description": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"confidence_level_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"confidence_level_description": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"2021_meshblock_id": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"2021_meshblock_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"2021_meshblock_match_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"2021_meshblock_match_description": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"2016_meshblock_id": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"2016_meshblock_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"2016_meshblock_match_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"2016_meshblock_match_description": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"address_type_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"primary_address_pid": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"address_join_type": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"collector_district_id": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"collector_district_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"commonwealth_electoral_boundary_id": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"commonwealth_electoral_boundary_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"statistical_local_area_id": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"statistical_local_area_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"statistical_local_area_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"state_electoral_boundary_id": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"state_electoral_boundary_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"state_electoral_effective_start": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"state_electoral_effective_end": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"state_electoral_new_pid": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"state_electoral_new_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"state_electoral_new_effective_start": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"state_electoral_new_effective_end": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"address_level_longitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"address_level_latitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"address_level_elevation": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"address_level_planimetric_accuracy": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"address_level_boundary_extent": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"address_level_geocode_reliability_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"address_level_geocode_reliability_description": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"street_level_longitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"street_level_latitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"street_level_planimetric_accuracy": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"street_level_boundary_extent": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"street_level_geocode_reliability_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"street_level_geocode_reliability_description": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"locality_level_longitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"locality_level_latitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"locality_level_planimetric_accuracy": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"locality_level_geocode_reliability_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"locality_level_geocode_reliability_description": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"gnaf_legal_parcel_identifier": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"locality_class_code": {
"$ref": "#/components/schemas/DatasetMetadata"
}
},
"additionalProperties": false,
"description": "Attribute-level metadata for the AUS Regional Geocodes dataset."
},
"EnrichmentV2DatasetAttributes": {
"type": "object",
"properties": {
"geocodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesGeocode"
},
"description": "The dataset named Geocodes and its associated attributes.",
"nullable": true,
"xml": {
"name": "geocodes",
"wrapped": true
}
},
"usa_regional_geocodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesUsaRegionalGeocodes"
},
"description": "The dataset named USA Regional Geocodes and its associated attributes.",
"nullable": true,
"xml": {
"name": "usa_regional_geocodes",
"wrapped": true
}
},
"aus_regional_geocodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesAusRegionalGeocodes"
},
"description": "The dataset named AUS Regional Geocodes and its associated attributes.",
"nullable": true,
"xml": {
"name": "aus_regional_geocodes",
"wrapped": true
}
},
"nzl_regional_geocodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesNzlRegionalGeocodes"
},
"description": "The dataset named NZL Regional Geocodes and its associated attributes.",
"nullable": true,
"xml": {
"name": "nzl_regional_geocodes",
"wrapped": true
}
},
"uk_location_complete": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesUkLocationComplete"
},
"description": "The dataset named UK Location Complete and its associated attributes.",
"nullable": true,
"xml": {
"name": "uk_location_complete",
"wrapped": true
}
},
"uk_location_essential": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesUkLocationEssential"
},
"description": "The dataset named UK Location Essential and its associated attributes.",
"nullable": true,
"xml": {
"name": "uk_location_essential",
"wrapped": true
}
},
"gbr_government": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesGbrGovernment"
},
"description": "The dataset named GBR Government and its associated attributes.",
"nullable": true,
"xml": {
"name": "gbr_government",
"wrapped": true
}
},
"gbr_health": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesGbrHealth"
},
"description": "The dataset named GBR Health and its associated attributes.",
"nullable": true,
"xml": {
"name": "gbr_health",
"wrapped": true
}
},
"premium_location_insight": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesPremiumLocationInsight"
},
"description": "The dataset named Premium Location Insight and its associated attributes.",
"nullable": true,
"xml": {
"name": "premium_location_insight",
"wrapped": true
}
},
"what3words": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentV2AttributesWhat3Words"
},
"description": "The dataset named what3words and its associated attributes.",
"nullable": true,
"xml": {
"name": "what3words",
"wrapped": true
}
}
},
"additionalProperties": false,
"description": "Datasets and their specific attributes."
},
"EnrichmentV2DatasetAusRegionalGeocodes": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "Latitude of the address in degrees.",
"format": "double",
"nullable": true,
"example": -31.067406
},
"longitude": {
"type": "number",
"description": "Longitude of the address in degrees.",
"format": "double",
"nullable": true,
"example": 152.83315
},
"match_level": {
"type": "string",
"description": "Specifies the accuracy of the coordinates for the specified address.",
"nullable": true,
"example": "building"
},
"sa1": {
"type": "string",
"description": "7 digit SA1 code.",
"nullable": true,
"example": "1115514"
},
"meshblock": {
"type": "string",
"description": "11 digit meshblock code.",
"nullable": true,
"example": "10402970000"
},
"lga_code": {
"type": "string",
"description": "5-digit LGA code.",
"nullable": true,
"example": "14350"
},
"lga_name": {
"type": "string",
"description": "The name of the Local Government Area.",
"nullable": true,
"example": "Kempsey (A)"
},
"street_pid": {
"type": "string",
"description": "This is a unique street persistent identifier.",
"nullable": true,
"example": "NSW2838126"
},
"locality_pid": {
"type": "string",
"description": "This is a unique locality persistent identifier.",
"nullable": true,
"example": "NSW4281"
},
"geocode_level_code": {
"type": "string",
"description": "This is the geocode level code. The value is a number between 0 and 7.",
"nullable": true,
"example": "7"
},
"geocode_level_description": {
"type": "string",
"description": "This is the geocode level description.",
"nullable": true,
"example": "Locality, street and parcel level geocodes"
},
"geocode_type_code": {
"type": "string",
"description": "This is the geocode type code. The value is 2-4 alphabetic characters in uppercase.",
"nullable": true,
"example": "PC"
},
"geocode_type_description": {
"type": "string",
"description": "This is the geocode type description.",
"nullable": true,
"example": "Property centroid"
},
"highest_level_longitude": {
"type": "number",
"description": "The highest-level longitude in degrees.",
"format": "double",
"nullable": true,
"example": 152.83315
},
"highest_level_latitude": {
"type": "number",
"description": "The highest-level latitude in degrees.",
"format": "double",
"nullable": true,
"example": -31.067406
},
"highest_level_elevation": {
"type": "string",
"description": "The highest-level elevation.",
"nullable": true
},
"highest_level_planimetric_accuracy": {
"type": "string",
"description": "The highest-level planimetric accuracy.",
"nullable": true
},
"highest_level_boundary_extent": {
"type": "string",
"description": "The highest-level boundary extent.",
"nullable": true
},
"highest_level_geocode_reliability_code": {
"type": "string",
"description": "The highest-level geocode reliability code.",
"nullable": true,
"example": "2"
},
"highest_level_geocode_reliability_description": {
"type": "string",
"description": "The highest-level geocode reliability description.",
"nullable": true,
"example": "Geocode accuracy sufficient to place centroid within address site boundary"
},
"confidence_level_code": {
"type": "string",
"description": "This is the confidence level code. The value is numerical.",
"nullable": true,
"example": "2"
},
"confidence_level_description": {
"type": "string",
"description": "This is the confidence level descriptor. The value is alphabetic.",
"nullable": true,
"example": "All three contributors have supplied an identical address"
},
"2021_meshblock_id": {
"type": "string",
"description": "The 2021 version of the Mesh Block ID. This element consists of 15 alpha numeric characters: a 4 character descriptor, followed by the 11 digit Mesh Block Code.",
"nullable": true,
"example": "MB2110402970000"
},
"2021_meshblock_code": {
"type": "string",
"description": "The 11-digit 2021 version of the Mesh Block Code.",
"nullable": true,
"example": "10402970000"
},
"2021_meshblock_match_code": {
"type": "string",
"description": "The code for the level of matching to 2021 Mesh Blocks.",
"nullable": true,
"example": "1"
},
"2021_meshblock_match_description": {
"type": "string",
"description": "The description of the 2021 Mesh Block match level.",
"nullable": true,
"example": "Parcel level match"
},
"2016_meshblock_id": {
"type": "string",
"description": "The 2016 version of the Mesh Block ID. This element consists of 15 alpha numeric characters: a 4 character descriptor, followed by the 11 digit Mesh Block Code.",
"nullable": true,
"example": "MB1610402970000"
},
"2016_meshblock_code": {
"type": "string",
"description": "The 11-digit 2016 version of the Mesh Block Code.",
"nullable": true,
"example": "10402970000"
},
"2016_meshblock_match_code": {
"type": "string",
"description": "The code for the level of matching to 2016 Mesh Blocks.",
"nullable": true,
"example": "1"
},
"2016_meshblock_match_description": {
"type": "string",
"description": "The description of the 2016 Mesh Block match level.",
"nullable": true,
"example": "Parcel level match"
},
"address_type_code": {
"type": "string",
"description": "Returns the Address Type, indicating if the address is a Primary or Secondary address. If the Primary/Secondary relationship does not exist, then this element would be blank, otherwise the possible values are P and S: P:PrimaryAddress; S:SecondaryAddress.",
"nullable": true
},
"primary_address_pid": {
"type": "string",
"description": "This element will only be populated if the input address is a secondary address. In that case, this element would contain the PID of the primary address.",
"nullable": true
},
"address_join_type": {
"type": "string",
"description": "Returns the JoinType Code. The possible values are 1 or 2: 1:Both parent and child have the same root address; 2: Parent and child may or may not have the same root address.",
"nullable": true
},
"collector_district_id": {
"type": "string",
"description": "This is a unique Collector District persistent identifier.",
"nullable": true,
"example": "NSW1081403"
},
"collector_district_code": {
"type": "string",
"description": "This is the Collector District Code.",
"nullable": true,
"example": "1081403"
},
"commonwealth_electoral_boundary_id": {
"type": "string",
"description": "This is a unique Commonwealth Electoral Boundary persistent identifier.",
"nullable": true,
"example": "NSW32"
},
"commonwealth_electoral_boundary_name": {
"type": "string",
"description": "This is the Commonwealth Electoral Boundary name.",
"nullable": true,
"example": "COWPER"
},
"statistical_local_area_id": {
"type": "string",
"description": "This is a Statistical Local Area persistent identifier.",
"nullable": true,
"example": "NSW125104350"
},
"statistical_local_area_code": {
"type": "string",
"description": "9-digit SLA code.",
"nullable": true,
"example": "125104350"
},
"statistical_local_area_name": {
"type": "string",
"description": "This is a Statistical Local Area name.",
"nullable": true,
"example": "KEMPSEY (A)"
},
"state_electoral_boundary_id": {
"type": "string",
"description": "This is a State Electoral Boundary persistent identifier.",
"nullable": true,
"example": "NSW231"
},
"state_electoral_boundary_name": {
"type": "string",
"description": "This is a State Electoral Boundary name.",
"nullable": true,
"example": "OXLEY"
},
"state_electoral_effective_start": {
"type": "string",
"description": "This is the date that the electorate becomes effective.",
"nullable": true,
"example": "24/03/2007 00:00:00"
},
"state_electoral_effective_end": {
"type": "string",
"description": "This is the end date when electorate is no longer in effect.",
"nullable": true,
"example": "28/03/2015 00:00:00"
},
"state_electoral_new_pid": {
"type": "string",
"description": "This is the State Electoral Boundary identifier for new electorate that will be in effect.",
"nullable": true,
"example": "NSW242"
},
"state_electoral_new_name": {
"type": "string",
"description": "This is the State Electoral Boundary name for new electorate that will be in effect.",
"nullable": true,
"example": "OXLEY"
},
"state_electoral_new_effective_start": {
"type": "string",
"description": "This is the start date that the new electorate will become effective.",
"nullable": true,
"example": "28/03/2015 00:00:00"
},
"state_electoral_new_effective_end": {
"type": "string",
"description": "This is the end date when the new electorate will no longer be in effect.",
"nullable": true
},
"address_level_longitude": {
"type": "number",
"description": "The address-level longitude in degrees.",
"format": "double",
"nullable": true,
"example": 152.83315
},
"address_level_latitude": {
"type": "number",
"description": "The address-level latitude in degrees.",
"format": "double",
"nullable": true,
"example": -31.067406
},
"address_level_elevation": {
"type": "string",
"description": "The address-level elevation.",
"nullable": true
},
"address_level_planimetric_accuracy": {
"type": "string",
"description": "The address-level planimetric accuracy.",
"nullable": true
},
"address_level_boundary_extent": {
"type": "string",
"description": "The address-level boundary extent.",
"nullable": true
},
"address_level_geocode_reliability_code": {
"type": "string",
"description": "The address-level geocode reliability code.",
"nullable": true,
"example": "2"
},
"address_level_geocode_reliability_description": {
"type": "string",
"description": "The address-level geocode reliability description.",
"nullable": true,
"example": "Geocode accuracy sufficient to place centroid within address site boundary"
},
"street_level_longitude": {
"type": "number",
"description": "The street-level longitude in degrees.",
"format": "double",
"nullable": true,
"example": 152.8311
},
"street_level_latitude": {
"type": "number",
"description": "The street-level latitude in degrees.",
"format": "double",
"nullable": true,
"example": -31.062723
},
"street_level_planimetric_accuracy": {
"type": "string",
"description": "The street-level planimetric accuracy.",
"nullable": true
},
"street_level_boundary_extent": {
"type": "string",
"description": "The street-level boundary extent.",
"nullable": true,
"example": "651"
},
"street_level_geocode_reliability_code": {
"type": "string",
"description": "The street-level geocode reliability code. The value of this is either “4”, or blank.",
"nullable": true,
"example": "4"
},
"street_level_geocode_reliability_description": {
"type": "string",
"description": "The street-level geocode reliability description. If the reliability code is “4”, this is “Geocode accuracy sufficient to associate address site with a unique road feature”.",
"nullable": true,
"example": "Geocode accuracy sufficient to associate address site with a unique road feature"
},
"locality_level_longitude": {
"type": "number",
"description": "The locality-level longitude in degrees.",
"format": "double",
"nullable": true,
"example": 152.82999
},
"locality_level_latitude": {
"type": "number",
"description": "The locality-level latitude in degrees.",
"format": "double",
"nullable": true,
"example": -31.059824
},
"locality_level_planimetric_accuracy": {
"type": "string",
"description": "The locality-level planimetric accuracy.",
"nullable": true
},
"locality_level_geocode_reliability_code": {
"type": "string",
"description": "The locality-level geocode reliability code. The value of this is either “5”, “6”, or blank.",
"nullable": true,
"example": "5"
},
"locality_level_geocode_reliability_description": {
"type": "string",
"description": "The locality-level geocode reliability description.",
"nullable": true,
"example": "Geocode accuracy sufficient to associate address site with a unique locality or neighbourhood"
},
"gnaf_legal_parcel_identifier": {
"type": "string",
"description": "The Legal Parcel Id field is populated with the cadastral information using the same concatenations (where applicable) as adopted for the Jurisdiction Id used in the Cadastre theme (CAD table) of the CadLite product.",
"nullable": true,
"example": "B/366584"
},
"locality_class_code": {
"type": "string",
"description": "Describes the class of locality (e.g. Gazetted, topographic feature, indigenous location and etc.).",
"nullable": true,
"example": "G"
}
},
"additionalProperties": false,
"description": "Enrichment attributes that can be returned, based on the AUS Regional Geocodes dataset."
},
"EnrichmentV2DatasetGbAdditionalBusinessAddressValidate": {
"type": "object",
"properties": {
"urn": {
"type": "string",
"description": "The latitude.",
"nullable": true,
"example": "51.751172"
},
"commercial_mosaic": {
"$ref": "#/components/schemas/CommercialMosaicElements"
},
"registration": {
"type": "string",
"description": "The longitude.",
"nullable": true,
"example": "-1.24623"
},
"non_limited_company_key": {
"type": "string",
"description": "The longitude.",
"nullable": true,
"example": "-1.24623"
},
"phone": {
"type": "string",
"description": "The longitude.",
"nullable": true,
"example": "-1.24623"
},
"number_of_employees": {
"type": "string",
"description": "The longitude.",
"nullable": true,
"example": "-1.24623"
},
"standard_industry_classification": {
"$ref": "#/components/schemas/StandardIndustryClassificationElements"
},
"location": {
"$ref": "#/components/schemas/LocationElements"
}
},
"additionalProperties": false,
"description": "Enrichment attributes that can be returned, based on the what3words dataset."
},
"EnrichmentV2DatasetGbrGovernment": {
"type": "object",
"properties": {
"eer_code": {
"type": "string",
"description": "European Electoral Region Code.",
"nullable": true,
"example": "E15000007"
},
"eer_code_pre_2011": {
"type": "string",
"description": "European Electoral Region Code Pre-2011.",
"nullable": true,
"example": "07"
},
"eer_name": {
"type": "string",
"description": "European Electoral Region Name.",
"nullable": true,
"example": "London"
},
"gor_code": {
"type": "string",
"description": "Government Office for Region Code.",
"nullable": true,
"example": "E12000007"
},
"gor_code_pre_2011": {
"type": "string",
"description": "Government Office for Region Code Pre-2011.",
"nullable": true,
"example": "H"
},
"gor_name": {
"type": "string",
"description": "Government Office for Region Name.",
"nullable": true,
"example": "London"
},
"lea_code": {
"type": "string",
"description": "Local Education Authority Code.",
"nullable": true,
"example": "210"
},
"lea_name": {
"type": "string",
"description": "Local Education Authority Name.",
"nullable": true,
"example": "Southwark"
},
"la_code": {
"type": "string",
"description": "Local Authority Code.",
"nullable": true,
"example": "E09000028"
},
"la_code_pre_2011": {
"type": "string",
"description": "Local Authority Code Pre-2011.",
"nullable": true,
"example": "00BE"
},
"la_name": {
"type": "string",
"description": "Local Authority Name.",
"nullable": true,
"example": "Southwark"
},
"ward_code": {
"type": "string",
"description": "Local Authority Ward Code.",
"nullable": true,
"example": "E05011095"
},
"ward_code_pre_2011": {
"type": "string",
"description": "Local Authority Ward Code Pre-2011.",
"nullable": true,
"example": "00AXGN"
},
"ward_name": {
"type": "string",
"description": "Local Authority Ward Name.",
"nullable": true,
"example": "Borough & Bankside"
},
"cens_out_area": {
"type": "string",
"description": "Census Output Area.",
"nullable": true,
"example": "E00019790"
}
},
"additionalProperties": false,
"description": "Enrichment attributes that can be returned, based on the GBR Government dataset."
},
"EnrichmentV2DatasetGbrHealth": {
"type": "object",
"properties": {
"authority_code": {
"type": "string",
"description": "NHS Authority Code.",
"nullable": true,
"example": "Q36"
},
"authority_code_2011": {
"type": "string",
"description": "NHS Authority Code 2011.",
"nullable": true,
"example": "E18000007"
},
"authority_name": {
"type": "string",
"description": "NHS Authority Name.",
"nullable": true,
"example": "London"
},
"pclh_code": {
"type": "string",
"description": "Primary Care/Local Health Code.",
"nullable": true,
"example": "5LE"
},
"pclh_code_2011": {
"type": "string",
"description": "Primary Care/Local Health Code 2011.",
"nullable": true,
"example": "E16000059"
},
"pclh_name": {
"type": "string",
"description": "Primary Care/Local Health Name.",
"nullable": true,
"example": "Southwark"
},
"ward_code": {
"type": "string",
"description": "Local Authority Ward Code.",
"nullable": true,
"example": "E05011095"
},
"ward_code_2011": {
"type": "string",
"description": "Local Authority Ward Code 2011.",
"nullable": true,
"example": "E05011095"
},
"ward_name": {
"type": "string",
"description": "Local Authority Ward Name.",
"nullable": true,
"example": "Borough & Bankside"
},
"ccg_code": {
"type": "string",
"description": "CCG Current Area Code.",
"nullable": true,
"example": "E38000244"
},
"ccg_name": {
"type": "string",
"description": "CCG Current Area Name.",
"nullable": true,
"example": "NHS South East London CCG"
},
"doh_code": {
"type": "string",
"description": "CCG Former/DH Area Code.",
"nullable": true,
"example": "72Q"
}
},
"additionalProperties": false,
"description": "Enrichment attributes that can be returned, based on the GBR Health dataset."
},
"EnrichmentV2DatasetGbrRegionalGeocodes": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "The latitude.",
"format": "double",
"nullable": true,
"example": 51.501427
},
"longitude": {
"type": "number",
"description": "The longitude.",
"format": "double",
"nullable": true,
"example": -0.104257
},
"match_level": {
"type": "string",
"description": "Specifies the accuracy of the coordinates for the specified address.",
"nullable": true,
"example": "Building"
},
"udprn": {
"type": "string",
"description": "The udprn.",
"nullable": true,
"example": "55244256"
},
"uprn": {
"type": "string",
"description": "The uprn.",
"nullable": true,
"example": "010091977422"
},
"x_coordinate": {
"type": "number",
"description": "The X coordinate.",
"format": "double",
"nullable": true,
"example": 531677.94
},
"y_coordinate": {
"type": "number",
"description": "The Y coordinate.",
"format": "double",
"nullable": true,
"example": 179757.6
}
},
"additionalProperties": false,
"description": "Enrichment attributes that can be returned, based on the GBR Regional Geocodes dataset."
},
"EnrichmentV2DatasetGeocodes": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "The latitude.",
"format": "double",
"nullable": true,
"example": 52.9413
},
"longitude": {
"type": "number",
"description": "The longitude.",
"format": "double",
"nullable": true,
"example": 1.16312
},
"match_level": {
"type": "string",
"description": "Specifies the accuracy of the coordinates for the specified address.",
"nullable": true,
"example": "Premises"
}
},
"additionalProperties": false,
"description": "Enrichment attributes that can be returned, based on the Geocodes dataset."
},
"EnrichmentV2DatasetKeys": {
"required": [
"global_address_key"
],
"type": "object",
"properties": {
"global_address_key": {
"minLength": 1,
"type": "string",
"description": "A unique Experian identifier.",
"example": "aWQ9fDEgQXVkcmV5IFphcHAgRHJpdmV8SHVkc29ufEplcnNleSBDaXR5LCBOSiAwNzMwNX5mb3JtYXRJZD0xMjM0NX5RTD05fmdlbz0w"
}
},
"additionalProperties": false,
"description": "Keys you can use to search datasets."
},
"EnrichmentV2DatasetNzlRegionalGeocodes": {
"type": "object",
"properties": {
"front_of_property_nztm_x_coordinate": {
"type": "number",
"description": "The Geocode 'X' coordinate for the front of the building.",
"format": "double",
"nullable": true,
"example": 1757352.8
},
"front_of_property_nztm_y_coordinate": {
"type": "number",
"description": "The Geocode 'Y' coordinate for the front of the building.",
"format": "double",
"nullable": true,
"example": 5920390.5
},
"centroid_of_property_nztm_x_coordinate": {
"type": "number",
"description": "The Geocode 'X' coordinate for the centre of the property.",
"format": "double",
"nullable": true,
"example": 1757328.4
},
"centroid_of_property_nztm_y_coordinate": {
"type": "number",
"description": "The Geocode 'Y' coordinate for the centre of the property.",
"format": "double",
"nullable": true,
"example": 5920400
},
"linz_parcel_id": {
"type": "string",
"description": "This is a unique identifier of the address record.",
"nullable": true,
"example": "5047052"
},
"property_purpose_type": {
"type": "string",
"description": "The type of property, the possible values are: Business, Farm, Holiday Home, Residential or Empty section.",
"nullable": true,
"example": "Business"
},
"addressable": {
"type": "string",
"description": "This defines whether the address is deliverable or not. The possible values are \"Y\" or \"N\".",
"nullable": true,
"example": "N"
},
"mesh_block_code": {
"type": "string",
"description": "The unique identifier assigned to each Mesh Block.",
"nullable": true,
"example": "434000"
},
"territorial_authority_code": {
"type": "string",
"description": "The unique identifier assigned to the Territorial Authority.",
"nullable": true,
"example": "76"
},
"territorial_authority_name": {
"type": "string",
"description": "The name assigned to the Territorial Authority.",
"nullable": true,
"example": "Auckland"
},
"regional_council_code": {
"type": "string",
"description": "The unique identifier assigned to the Regional Council.",
"nullable": true,
"example": "2"
},
"regional_council_name": {
"type": "string",
"description": "The name assigned to the Regional Council.",
"nullable": true,
"example": "Auckland Region"
},
"general_electorate_code": {
"type": "string",
"description": "The unique identifier assigned to the General Electorate.",
"nullable": true,
"example": "001"
},
"general_electorate_name": {
"type": "string",
"description": "The name assigned to the General Electorate.",
"nullable": true,
"example": "Auckland Central"
},
"maori_electorate_code": {
"type": "string",
"description": "The unique identifier assigned to the Maori Electorate.",
"nullable": true,
"example": "3"
},
"maori_electorate_name": {
"type": "string",
"description": "The name assigned to the Maori Electorate.",
"nullable": true,
"example": "Tamaki Makaurau"
},
"front_of_property_latitude": {
"type": "number",
"description": "The latitude for the front of the building.",
"format": "double",
"nullable": true,
"example": -36.849308
},
"front_of_property_longitude": {
"type": "number",
"description": "The longitude for the front of the building.",
"format": "double",
"nullable": true,
"example": 174.76492
},
"centroid_of_property_latitude": {
"type": "number",
"description": "The latitude for the centre of the property.",
"format": "double",
"nullable": true,
"example": -36.849228
},
"centroid_of_property_longitude": {
"type": "number",
"description": "The longitude for the centre of the property.",
"format": "double",
"nullable": true,
"example": 174.76465
},
"match_level": {
"type": "string",
"description": "Specifies the accuracy of the coordinates for the specified address.",
"nullable": true,
"example": "Building"
}
},
"additionalProperties": false,
"description": "Enrichment attributes that can be returned, based on the NZL Regional Geocodes dataset."
},
"EnrichmentV2DatasetPremiumLocationInsight": {
"type": "object",
"properties": {
"geocodes": {
"$ref": "#/components/schemas/PremiumLocationInsightGeocodes"
},
"geocodes_building_xy": {
"$ref": "#/components/schemas/PremiumLocationInsightGeocodesBuildingXy"
},
"geocodes_access": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PremiumLocationInsightGeocodesAccess"
},
"description": "Access geocode for the specified address.",
"nullable": true,
"xml": {
"name": "geocodes_access",
"wrapped": true
}
},
"time": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PremiumLocationInsightTime"
},
"description": "Time zone information returned based on a specified address. (This attribute is excluded in Premium Location Insight Lite.)",
"nullable": true,
"xml": {
"name": "time",
"wrapped": true
}
}
},
"additionalProperties": false,
"description": "Enrichment attributes that can be returned, based on the Premium Location Insight dataset."
},
"EnrichmentV2DatasetUkLocationComplete": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "The latitude.",
"format": "double",
"nullable": true,
"example": 51.50112
},
"longitude": {
"type": "number",
"description": "The longitude.",
"format": "double",
"nullable": true,
"example": -0.1041234
},
"match_level": {
"type": "string",
"description": "Specifies the accuracy of the coordinates for the specified address.",
"nullable": true,
"example": "Building"
},
"udprn": {
"type": "string",
"description": "Specifies the UDPRN for the specified address.",
"nullable": true,
"example": "55244256"
},
"uprn": {
"type": "string",
"description": "Specifies the UPRN for the specified address.",
"nullable": true,
"example": "010091977422"
},
"x_coordinate": {
"type": "number",
"description": "The x coordinate.",
"format": "double",
"nullable": true,
"example": 531677.94
},
"y_coordinate": {
"type": "number",
"description": "The y coordinate.",
"format": "double",
"nullable": true,
"example": 179757.6
}
},
"additionalProperties": false,
"description": "Enrichment attributes that can be returned, based on the UK Location Complete dataset."
},
"EnrichmentV2DatasetUkLocationEssential": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "The latitude.",
"format": "double",
"nullable": true,
"example": 51.50112
},
"longitude": {
"type": "number",
"description": "The longitude.",
"format": "double",
"nullable": true,
"example": -0.1041234
},
"match_level": {
"type": "string",
"description": "Specifies the accuracy of the coordinates for the specified address.",
"nullable": true,
"example": "Building"
},
"udprn": {
"type": "string",
"description": "The UDPRN.",
"nullable": true,
"example": "55244256"
},
"uprn": {
"type": "string",
"description": "The UPRN.",
"nullable": true,
"example": "010091977422"
},
"x_coordinate": {
"type": "number",
"description": "The x coordinate.",
"format": "double",
"nullable": true,
"example": 531677.94
},
"y_coordinate": {
"type": "number",
"description": "The y coordinate.",
"format": "double",
"nullable": true,
"example": 179757.6
}
},
"additionalProperties": false,
"description": "Enrichment attributes that can be returned, based on the UK Location Essential dataset."
},
"EnrichmentV2DatasetUsaRegionalGeocodes": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "The latitude.",
"format": "double",
"nullable": true,
"example": 33.693283
},
"longitude": {
"type": "number",
"description": "The longitude.",
"format": "double",
"nullable": true,
"example": -117.87428
},
"match_level": {
"type": "string",
"description": "Specifies the accuracy of the coordinates for the specified address.",
"nullable": true,
"example": "Street"
},
"census_tract": {
"type": "string",
"description": "Geographical region defined by US Census Bureau for the purpose of taking a census (6 digits).",
"nullable": true,
"example": "050210"
},
"census_block": {
"type": "string",
"description": "Smallest geographical unit used by US Census Bureau for the purpose of taking a census; sub-division of a tract (4 digits).",
"nullable": true,
"example": "2025"
},
"core_based_statistical_area": {
"type": "string",
"description": "Geographical area maintained by US Office of Management and Budget (OMB) which consists of one or more counties anchored by an urban center.\nCBSAs are categorized as Metropolitan (at least one urbanized area of 50,000+ inhabitants) or Micropolitan (at least one urban cluster of between 10,000 and 50,000 inhabitants);\nthese are also referred to as MSAs (5 digits).",
"nullable": true,
"example": "12060"
},
"congressional_district_code": {
"type": "string",
"description": "US Federal Information Processing Standards (FIPS) codes to identify US electoral divisions (7 digits). The first two digits represent the state,\nthe second two digits represent the congressional district, and the final three digits designate the number of the Congress.",
"nullable": true,
"example": "1307116"
},
"county_code": {
"type": "string",
"description": "County code within a US state or possession (3 digits).",
"nullable": true,
"example": "135"
}
},
"additionalProperties": false,
"description": "Enrichment attributes that can be returned, based on the USA Regional Geocodes dataset."
},
"EnrichmentV2DatasetWhat3Words": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "The latitude.",
"format": "double",
"nullable": true,
"example": 51.75117
},
"longitude": {
"type": "number",
"description": "The longitude.",
"format": "double",
"nullable": true,
"example": -1.24623
},
"name": {
"type": "string",
"description": "The what3words location.",
"nullable": true,
"example": "pretty.needed.chill"
},
"description": {
"type": "string",
"description": "The nearest place",
"nullable": true,
"example": "near Oxford, Oxfordshire"
}
},
"additionalProperties": false,
"description": "Enrichment attributes that can be returned, based on the what3words dataset."
},
"EnrichmentV2GbrAlias": {
"enum": [
"aliases"
],
"type": "string",
"description": "The dataset named GBR Alias and its associated attributes."
},
"EnrichmentV2GbrAliasElementsResult": {
"type": "object",
"properties": {
"building_name": {
"type": "string",
"description": "PAF Building Name Delivery Point Alias.",
"nullable": true
},
"also_known_as": {
"type": "string",
"description": "PAF Also Known As Delivery Point Alias.",
"nullable": true
},
"department": {
"type": "string",
"description": "PAF Department Delivery Point Alias.",
"nullable": true
},
"organization_description": {
"type": "string",
"description": "PAF Organization Description Delivery Point Alias.",
"nullable": true
},
"organization_at_residential": {
"type": "string",
"description": "PAF Organization Residential Delivery Point Alias.",
"nullable": true
},
"trading_name": {
"type": "string",
"description": "PAF Trading Name Delivery Point Alias.",
"nullable": true
},
"misc": {
"type": "string",
"description": "PAF Miscellaneous Delivery Point Alias.",
"nullable": true
},
"welsh_alternative": {
"type": "string",
"description": "PAF Welsh Alternative Delivery Point Alias.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for GBR PAF."
},
"EnrichmentV2GbrAliasMetadata": {
"type": "object",
"properties": {
"aliases": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2GbrAliasResult": {
"type": "object",
"properties": {
"aliases": {
"$ref": "#/components/schemas/EnrichmentV2GbrAliasElementsResult"
}
},
"additionalProperties": false,
"description": "Response for GBR Alias dataset."
},
"EnrichmentV2GbrCommonElementsResult": {
"type": "object",
"properties": {
"type_code": {
"type": "string",
"description": "Type Code.",
"nullable": true
},
"type": {
"type": "string",
"description": "Type Name.",
"nullable": true
},
"group_code": {
"type": "string",
"description": "Group Code.",
"nullable": true
},
"group": {
"type": "string",
"description": "Group Name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for dataset consisting of type code, type, group code and group elements."
},
"EnrichmentV2GbrCommonElementsWithVersionResult": {
"type": "object",
"properties": {
"version": {
"type": "string",
"nullable": true
},
"type_code": {
"type": "string",
"description": "Type Code.",
"nullable": true
},
"type": {
"type": "string",
"description": "Type Name.",
"nullable": true
},
"group_code": {
"type": "string",
"description": "Group Code.",
"nullable": true
},
"group": {
"type": "string",
"description": "Group Name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for dataset with versioning consisting of type code, type, group code and group elements."
},
"EnrichmentV2GbrGovernmentMetadata": {
"type": "object",
"properties": {
"eer_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"eer_code_pre_2011": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"eer_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"gor_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"gor_code_pre_2011": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"gor_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"lea_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"lea_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"la_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"la_code_pre_2011": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"la_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"ward_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"ward_code_pre_2011": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"ward_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"cens_out_area": {
"$ref": "#/components/schemas/DatasetMetadata"
}
},
"additionalProperties": false,
"description": "Attribute-level metadata for the GBR Government dataset."
},
"EnrichmentV2GbrHealthMetadata": {
"type": "object",
"properties": {
"authority_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"authority_code_2011": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"authority_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"pclh_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"pclh_code_2011": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"pclh_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"ward_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"ward_code_2011": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"ward_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"ccg_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"ccg_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"doh_code": {
"$ref": "#/components/schemas/DatasetMetadata"
}
},
"additionalProperties": false,
"description": "Attribute-level metadata for the GBR Health dataset."
},
"EnrichmentV2GbrLocationGrid": {
"enum": [
"postzon",
"codepoint"
],
"type": "string",
"description": "The dataset named GBR Location Grid and its associated attributes."
},
"EnrichmentV2GbrLocationGridCodepointResult": {
"type": "object",
"properties": {
"x_coordinate": {
"type": "number",
"description": "Native OS or OSNI grid-reference.",
"format": "double",
"nullable": true
},
"y_coordinate": {
"type": "number",
"description": "Native OS or OSNI grid-reference.",
"format": "double",
"nullable": true
},
"pqi": {
"type": "string",
"description": "Assesses the quality of the grid based on the quality of the AddressPoints used.",
"nullable": true
},
"is_delivery_service": {
"type": "string",
"description": "Value is always \"Yes\" or \"No\", depending on whether the postcode is a PO Box.",
"nullable": true
},
"ndp": {
"type": "string",
"description": "Indicates the number of delivery points on PAF for the current postcode.",
"nullable": true
},
"ndp_pqi": {
"type": "string",
"description": "Represents the number of matched addresses within the\npostcode that have the same PQI in AddressPoint as the PQI given to this postcode.",
"nullable": true
},
"ndp_domestic": {
"type": "string",
"description": "Represents the number of non-PO Box delivery points with no PAF organization name.",
"nullable": true
},
"ndp_commercial": {
"type": "string",
"description": "Represents the number of non-PO Box delivery points which have a PAF organization name.",
"nullable": true
},
"ndp_delivery_service": {
"type": "string",
"description": "Represents the number of PO Box delivery points.",
"nullable": true
},
"ndp_matched": {
"type": "string",
"description": "Represents the number of good AddressPoints after de-duplication of AddressPoints with the same coordinates.",
"nullable": true
},
"ndp_unmatched": {
"type": "string",
"description": "Represents the number of Delivery Points on PAF unmatched to OS data.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for GBR CodePoint Grid."
},
"EnrichmentV2GbrLocationGridMetadata": {
"type": "object",
"properties": {
"postzon": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"codepoint": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2GbrLocationGridPostzonResult": {
"type": "object",
"properties": {
"x_coordinate": {
"type": "number",
"description": "Native OS or OSNI grid-reference.",
"format": "double",
"nullable": true
},
"y_coordinate": {
"type": "number",
"description": "Native OS or OSNI grid-reference.",
"format": "double",
"nullable": true
},
"os_x_coordinate": {
"type": "number",
"description": "100m OS Easting grid-reference.",
"format": "double",
"nullable": true
},
"os_y_coordinate": {
"type": "number",
"description": "100m OS Northing grid-reference.",
"format": "double",
"nullable": true
},
"latitude": {
"type": "number",
"description": "WGS84 projection compatible with the GPS system and returned to six decimal places.",
"format": "double",
"nullable": true
},
"longitude": {
"type": "number",
"description": "WGS84 projection compatible with the GPS system and returned to six decimal places.",
"format": "double",
"nullable": true
},
"os_landranger": {
"type": "string",
"description": "OS Land-ranger format derived from OS East and OS North.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for GBR 100m Postzon Grid."
},
"EnrichmentV2GbrLocationGridResult": {
"type": "object",
"properties": {
"postzon": {
"$ref": "#/components/schemas/EnrichmentV2GbrLocationGridPostzonResult"
},
"codepoint": {
"$ref": "#/components/schemas/EnrichmentV2GbrLocationGridCodepointResult"
}
},
"additionalProperties": false,
"description": "Response for GBR Location Grid dataset."
},
"EnrichmentV2GbrMosaic": {
"enum": [
"household",
"postal_code"
],
"type": "string",
"description": "The dataset named GBR Mosaic and its associated attributes."
},
"EnrichmentV2GbrMosaicFinancial": {
"enum": [
"postal_code",
"household"
],
"type": "string",
"description": "The dataset named GBR Mosaic Financial and its associated attributes."
},
"EnrichmentV2GbrMosaicFinancialMetadata": {
"type": "object",
"properties": {
"postal_code": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"household": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2GbrMosaicFinancialResult": {
"type": "object",
"properties": {
"postal_code": {
"$ref": "#/components/schemas/EnrichmentV2GbrCommonElementsResult"
},
"household": {
"$ref": "#/components/schemas/EnrichmentV2GbrCommonElementsResult"
}
},
"additionalProperties": false,
"description": "Response for GBR Mosaic Financial dataset."
},
"EnrichmentV2GbrMosaicMetadata": {
"type": "object",
"properties": {
"household": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"postal_code": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2GbrMosaicResult": {
"type": "object",
"properties": {
"household": {
"$ref": "#/components/schemas/EnrichmentV2GbrCommonElementsWithVersionResult"
},
"postal_code": {
"$ref": "#/components/schemas/EnrichmentV2GbrCommonElementsWithVersionResult"
}
},
"additionalProperties": false,
"description": "Response for GBR Mosaic dataset."
},
"EnrichmentV2GbrParliament": {
"enum": [
"westminster",
"scotland"
],
"type": "string",
"description": "The dataset named GBR Parliament and its associated attributes."
},
"EnrichmentV2GbrParliamentMetadata": {
"type": "object",
"properties": {
"westminster": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"scotland": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2GbrParliamentResult": {
"type": "object",
"properties": {
"westminster": {
"$ref": "#/components/schemas/EnrichmentV2GbrParliamentWestminsterResult"
},
"scotland": {
"$ref": "#/components/schemas/EnrichmentV2GbrParliamentScotlandResult"
}
},
"additionalProperties": false,
"description": "Response for GBR Parliament dataset."
},
"EnrichmentV2GbrParliamentScotlandResult": {
"type": "object",
"properties": {
"constituency_code": {
"type": "string",
"description": "Official code given to the Scottish Parliamentary Constituency.",
"nullable": true
},
"constituency": {
"type": "string",
"description": "Official name given to the Scottish Parliamentary Constituency.",
"nullable": true
},
"region": {
"type": "string",
"description": "Official name given to the Scottish Parliament electoral region.",
"nullable": true
},
"region_code": {
"type": "string",
"description": "Official code given to the Scottish Parliament electoral region.",
"nullable": true
},
"mp": {
"type": "string",
"description": "Name of the MSP representing the constituency.",
"nullable": true
},
"mp_party": {
"type": "string",
"description": "Name of the party to which the MSP belongs.",
"nullable": true
},
"regional_msp1": {
"type": "string",
"description": "Name of the first MSP representing the electoral region.",
"nullable": true
},
"regional_msp1_party": {
"type": "string",
"description": "Name of the party to which the first regional MSP belongs.",
"nullable": true
},
"regional_msp2": {
"type": "string",
"description": "Name of the second MSP representing the electoral region.",
"nullable": true
},
"regional_msp2_party": {
"type": "string",
"description": "Name of the party to which the second regional MSP belongs.",
"nullable": true
},
"regional_msp3": {
"type": "string",
"description": "Name of the third MSP representing the electoral region.",
"nullable": true
},
"regional_msp3_party": {
"type": "string",
"description": "Name of the party to which the third regional MSP belongs.",
"nullable": true
},
"regional_msp4": {
"type": "string",
"description": "Name of the fourth MSP representing the electoral region.",
"nullable": true
},
"regional_msp4_party": {
"type": "string",
"description": "Name of the party to which the fourth regional MSP belongs.",
"nullable": true
},
"regional_msp5": {
"type": "string",
"description": "Name of the fifth MSP representing the electoral region.",
"nullable": true
},
"regional_msp5_party": {
"type": "string",
"description": "Name of the party to which the fifth regional MSP belongs.",
"nullable": true
},
"regional_msp6": {
"type": "string",
"description": "Name of the sixth MSP representing the electoral region.",
"nullable": true
},
"regional_msp6_party": {
"type": "string",
"description": "Name of the party to which the sixth regional MSP belongs.",
"nullable": true
},
"regional_msp7": {
"type": "string",
"description": "Name of the seventh MSP representing the electoral region.",
"nullable": true
},
"regional_msp7_party": {
"type": "string",
"description": "Name of the party to which the seventh regional MSP belongs.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for GBR Scottish Parliament."
},
"EnrichmentV2GbrParliamentWestminsterResult": {
"type": "object",
"properties": {
"constituency_code": {
"type": "string",
"description": "Official code given to the Parliamentary Constituency.",
"nullable": true
},
"constituency": {
"type": "string",
"description": "Official name given to the Parliamentary Constituency.",
"nullable": true
},
"mp": {
"type": "string",
"description": "Name of the MP representing their constituency.",
"nullable": true
},
"mp_party": {
"type": "string",
"description": "Name of the party to which the MP belongs.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for GBR Westminster Parliament."
},
"EnrichmentV2GbrQuality": {
"enum": [
"record"
],
"type": "string",
"description": "The dataset named GBR Quality and its associated attributes."
},
"EnrichmentV2GbrQualityMetadata": {
"type": "object",
"properties": {
"record": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2GbrQualityRecordResult": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "PAF Quality of Address",
"nullable": true
},
"postal_code": {
"type": "string",
"description": "PAF Quality of Postcode",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for GBR PAF Match Quality."
},
"EnrichmentV2GbrQualityResult": {
"type": "object",
"properties": {
"record": {
"$ref": "#/components/schemas/EnrichmentV2GbrQualityRecordResult"
}
},
"additionalProperties": false,
"description": "Response for GBR Quality dataset."
},
"EnrichmentV2GbrRegionalGeocodesMetadata": {
"type": "object",
"properties": {
"latitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"longitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"match_level": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"udprn": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"uprn": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"x_coordinate": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"y_coordinate": {
"$ref": "#/components/schemas/DatasetMetadata"
}
},
"additionalProperties": false,
"description": "Attribute-level metadata for the GBR Regional Geocodes dataset."
},
"EnrichmentV2GeocodesMetadata": {
"type": "object",
"properties": {
"latitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"longitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"match_level": {
"$ref": "#/components/schemas/DatasetMetadata"
}
},
"additionalProperties": false,
"description": "Attribute-level metadata for the Geocodes dataset."
},
"EnrichmentV2IrlMosaic": {
"enum": [
"household"
],
"type": "string",
"description": "The dataset named IRL Mosaic and its associated attributes."
},
"EnrichmentV2IrlMosaicHouseholdResult": {
"type": "object",
"properties": {
"type_code": {
"type": "string",
"description": "MOSAIC Type Code.",
"nullable": true
},
"type": {
"type": "string",
"description": "MOSAIC Type Name.",
"nullable": true
},
"group_code": {
"type": "string",
"description": "MOSAIC Group Code.",
"nullable": true
},
"group": {
"type": "string",
"description": "MOSAIC Group Name.",
"nullable": true
},
"area_code": {
"type": "string",
"description": "MOSAIC Area Code.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for IRL Mosaic Household."
},
"EnrichmentV2IrlMosaicMetadata": {
"type": "object",
"properties": {
"household": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2IrlMosaicResult": {
"type": "object",
"properties": {
"household": {
"$ref": "#/components/schemas/EnrichmentV2IrlMosaicHouseholdResult"
}
},
"additionalProperties": false,
"description": "Response for IRL Mosaic dataset."
},
"EnrichmentV2Metadata": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Response-level metadata code.",
"nullable": true,
"example": "S200"
},
"message": {
"type": "string",
"description": "Response-level metadata message.",
"nullable": true,
"example": "Success"
},
"detail": {
"type": "string",
"description": "Response-level metadata detail.",
"nullable": true,
"example": "All requested attribute(s) retrieved."
},
"datasets": {
"$ref": "#/components/schemas/EnrichmentV2MetadataDatasets"
}
},
"additionalProperties": false,
"description": "The metadata model."
},
"EnrichmentV2MetadataDatasets": {
"type": "object",
"properties": {
"geocodes": {
"$ref": "#/components/schemas/EnrichmentV2GeocodesMetadata"
},
"usa_regional_geocodes": {
"$ref": "#/components/schemas/EnrichmentV2UsaRegionalGeocodesMetadata"
},
"aus_regional_geocodes": {
"$ref": "#/components/schemas/EnrichmentV2AusRegionalGeocodesMetadata"
},
"nzl_regional_geocodes": {
"$ref": "#/components/schemas/EnrichmentV2NzlRegionalGeocodesMetadata"
},
"uk_location_complete": {
"$ref": "#/components/schemas/EnrichmentV2UkLocationCompleteMetadata"
},
"uk_location_essential": {
"$ref": "#/components/schemas/EnrichmentV2UkLocationEssentialMetadata"
},
"gbr_government": {
"$ref": "#/components/schemas/EnrichmentV2GbrGovernmentMetadata"
},
"gbr_health": {
"$ref": "#/components/schemas/EnrichmentV2GbrHealthMetadata"
},
"premium_location_insight": {
"$ref": "#/components/schemas/EnrichmentV2PremiumLocationInsightMetadata"
},
"what3words": {
"$ref": "#/components/schemas/EnrichmentV2What3WordsMetadata"
}
},
"additionalProperties": false,
"description": "The dataset name and related attributes."
},
"EnrichmentV2NzlElementCodeResult": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Code.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for NZL Elements' Code."
},
"EnrichmentV2NzlHousehold": {
"enum": [
"head_of_household_age",
"children_at_address",
"household_composition",
"head_of_household_lifestage",
"adults_at_address"
],
"type": "string",
"description": "The dataset named NZL Household and its associated attributes."
},
"EnrichmentV2NzlHouseholdMetadata": {
"type": "object",
"properties": {
"head_of_household_age": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"children_at_address": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"household_composition": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"head_of_household_lifestage": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"adults_at_address": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2NzlHouseholdResult": {
"type": "object",
"properties": {
"head_of_household_age": {
"$ref": "#/components/schemas/EnrichmentV2NzlElementCodeResult"
},
"children_at_address": {
"$ref": "#/components/schemas/EnrichmentV2NzlElementCodeResult"
},
"household_composition": {
"$ref": "#/components/schemas/EnrichmentV2NzlElementCodeResult"
},
"head_of_household_lifestage": {
"$ref": "#/components/schemas/EnrichmentV2NzlElementCodeResult"
},
"adults_at_address": {
"$ref": "#/components/schemas/EnrichmentV2NzlElementCodeResult"
}
},
"additionalProperties": false,
"description": "Response for NZL Household dataset."
},
"EnrichmentV2NzlMosaic": {
"enum": [
"mosaic",
"mosaic_segment",
"factor_a",
"factor_b",
"factor_c",
"factor_d",
"factor_e",
"factor_f"
],
"type": "string",
"description": "The dataset named NZL Mosaic and its associated attributes."
},
"EnrichmentV2NzlMosaicElementResult": {
"type": "object",
"properties": {
"group_code": {
"type": "string",
"description": "Group Code.",
"nullable": true
},
"type_code": {
"type": "string",
"description": "Type Code.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for NZL Mosaic's Elements."
},
"EnrichmentV2NzlMosaicFactorResult": {
"type": "object",
"properties": {
"score": {
"type": "number",
"description": "Score.",
"format": "double",
"nullable": true
},
"percentile": {
"type": "number",
"description": "Percentile.",
"format": "double",
"nullable": true
},
"decile": {
"type": "number",
"description": "Decile.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for NZL Mosaic's Factor Elements."
},
"EnrichmentV2NzlMosaicMetadata": {
"type": "object",
"properties": {
"mosaic": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"mosaic_segment": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"factor_a": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"factor_b": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"factor_c": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"factor_d": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"factor_e": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"factor_f": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2NzlMosaicResult": {
"type": "object",
"properties": {
"mosaic": {
"$ref": "#/components/schemas/EnrichmentV2NzlMosaicElementResult"
},
"mosaic_segment": {
"$ref": "#/components/schemas/EnrichmentV2NzlElementCodeResult"
},
"factor_a": {
"$ref": "#/components/schemas/EnrichmentV2NzlMosaicFactorResult"
},
"factor_b": {
"$ref": "#/components/schemas/EnrichmentV2NzlMosaicFactorResult"
},
"factor_c": {
"$ref": "#/components/schemas/EnrichmentV2NzlMosaicFactorResult"
},
"factor_d": {
"$ref": "#/components/schemas/EnrichmentV2NzlMosaicFactorResult"
},
"factor_e": {
"$ref": "#/components/schemas/EnrichmentV2NzlMosaicFactorResult"
},
"factor_f": {
"$ref": "#/components/schemas/EnrichmentV2NzlMosaicFactorResult"
}
},
"additionalProperties": false,
"description": "Response for NZL Mosaic dataset."
},
"EnrichmentV2NzlProperty": {
"enum": [
"property_type",
"property_ownership",
"property_value",
"property_size",
"bedrooms",
"bathrooms"
],
"type": "string",
"description": "The dataset named NZL Property and its associated attributes."
},
"EnrichmentV2NzlPropertyMetadata": {
"type": "object",
"properties": {
"property_type": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"property_ownership": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"property_value": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"property_size": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"bedrooms": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"bathrooms": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2NzlPropertyResult": {
"type": "object",
"properties": {
"property_type": {
"$ref": "#/components/schemas/EnrichmentV2NzlElementCodeResult"
},
"property_ownership": {
"$ref": "#/components/schemas/EnrichmentV2NzlElementCodeResult"
},
"property_value": {
"$ref": "#/components/schemas/EnrichmentV2NzlElementCodeResult"
},
"property_size": {
"$ref": "#/components/schemas/EnrichmentV2NzlElementCodeResult"
},
"bedrooms": {
"$ref": "#/components/schemas/EnrichmentV2NzlElementCodeResult"
},
"bathrooms": {
"$ref": "#/components/schemas/EnrichmentV2NzlElementCodeResult"
}
},
"additionalProperties": false,
"description": "Response for NZL Property dataset."
},
"EnrichmentV2NzlRegionalGeocodesMetadata": {
"type": "object",
"properties": {
"front_of_property_nztm_x_coordinate": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"front_of_property_nztm_y_coordinate": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"centroid_of_property_nztm_x_coordinate": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"centroid_of_property_nztm_y_coordinate": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"linz_parcel_id": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"property_purpose_type": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"addressable": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"mesh_block_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"territorial_authority_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"territorial_authority_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"regional_council_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"regional_council_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"general_electorate_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"general_electorate_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"maori_electorate_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"maori_electorate_name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"front_of_property_latitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"front_of_property_longitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"centroid_of_property_latitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"centroid_of_property_longitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"match_level": {
"$ref": "#/components/schemas/DatasetMetadata"
}
},
"additionalProperties": false,
"description": "Attribute-level metadata for the NZL Regional Geocodes dataset."
},
"EnrichmentV2PremiumLocationInsightMetadata": {
"type": "object",
"properties": {
"geocodes": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"geocodes_building_xy": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"geocodes_access": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"time": {
"$ref": "#/components/schemas/DatasetMetadata"
}
},
"additionalProperties": false,
"description": "Attribute-level metadata for the Premium Location Insight dataset.\n\n (The time attribute is excluded in Premium Location Insight Lite.) "
},
"EnrichmentV2Request": {
"required": [
"attributes",
"keys"
],
"type": "object",
"properties": {
"country_iso": {
"maxLength": 3,
"minLength": 0,
"type": "string",
"description": "The 3-letter ISO country code.",
"nullable": true
},
"keys": {
"$ref": "#/components/schemas/EnrichmentV2DatasetKeys"
},
"attributes": {
"$ref": "#/components/schemas/EnrichmentV2DatasetAttributes"
}
},
"additionalProperties": false,
"description": "The request model.",
"xml": {
"name": "request"
}
},
"EnrichmentV2Response": {
"type": "object",
"properties": {
"reference_id": {
"type": "string",
"description": "If you chose to submit a \"Reference-Id\" in the response body, the value will be returned with the response.",
"nullable": true
},
"transaction_id": {
"type": "string",
"description": "Unique Experian-assigned transaction identifier.",
"nullable": true,
"example": "ab123ab1-abc1-1234-abcd-ab1a123a1a12"
},
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/EnrichmentV2Result"
},
"metadata": {
"$ref": "#/components/schemas/EnrichmentV2Metadata"
}
},
"additionalProperties": false,
"description": "The response model.",
"xml": {
"name": "response"
}
},
"EnrichmentV2Result": {
"type": "object",
"properties": {
"geocodes": {
"$ref": "#/components/schemas/EnrichmentV2DatasetGeocodes"
},
"usa_regional_geocodes": {
"$ref": "#/components/schemas/EnrichmentV2DatasetUsaRegionalGeocodes"
},
"aus_regional_geocodes": {
"$ref": "#/components/schemas/EnrichmentV2DatasetAusRegionalGeocodes"
},
"nzl_regional_geocodes": {
"$ref": "#/components/schemas/EnrichmentV2DatasetNzlRegionalGeocodes"
},
"uk_location_complete": {
"$ref": "#/components/schemas/EnrichmentV2DatasetUkLocationComplete"
},
"uk_location_essential": {
"$ref": "#/components/schemas/EnrichmentV2DatasetUkLocationEssential"
},
"gbr_government": {
"$ref": "#/components/schemas/EnrichmentV2DatasetGbrGovernment"
},
"gbr_health": {
"$ref": "#/components/schemas/EnrichmentV2DatasetGbrHealth"
},
"premium_location_insight": {
"$ref": "#/components/schemas/EnrichmentV2DatasetPremiumLocationInsight"
},
"what3words": {
"$ref": "#/components/schemas/EnrichmentV2DatasetWhat3Words"
}
},
"additionalProperties": false,
"description": "Details about the result. Includes the enriched data."
},
"EnrichmentV2ResultAddressValidate": {
"type": "object",
"properties": {
"geocodes": {
"$ref": "#/components/schemas/EnrichmentV2DatasetGeocodes"
},
"usa_regional_geocodes": {
"$ref": "#/components/schemas/EnrichmentV2DatasetUsaRegionalGeocodes"
},
"aus_regional_geocodes": {
"$ref": "#/components/schemas/EnrichmentV2DatasetAusRegionalGeocodes"
},
"nzl_regional_geocodes": {
"$ref": "#/components/schemas/EnrichmentV2DatasetNzlRegionalGeocodes"
},
"uk_location_complete": {
"$ref": "#/components/schemas/EnrichmentV2DatasetUkLocationComplete"
},
"uk_location_essential": {
"$ref": "#/components/schemas/EnrichmentV2DatasetUkLocationEssential"
},
"gbr_government": {
"$ref": "#/components/schemas/EnrichmentV2DatasetGbrGovernment"
},
"gbr_business": {
"$ref": "#/components/schemas/EnrichmentV2DatasetGbAdditionalBusinessAddressValidate"
},
"gbr_health": {
"$ref": "#/components/schemas/EnrichmentV2DatasetGbrHealth"
},
"premium_location_insight": {
"$ref": "#/components/schemas/EnrichmentV2DatasetPremiumLocationInsight"
},
"what3words": {
"$ref": "#/components/schemas/EnrichmentV2DatasetWhat3Words"
},
"gbr_location_grid": {
"$ref": "#/components/schemas/EnrichmentV2GbrLocationGridResult"
},
"gbr_parliament": {
"$ref": "#/components/schemas/EnrichmentV2GbrParliamentResult"
},
"gbr_mosaic": {
"$ref": "#/components/schemas/EnrichmentV2GbrMosaicResult"
},
"gbr_mosaic_financial": {
"$ref": "#/components/schemas/EnrichmentV2GbrMosaicFinancialResult"
},
"gbr_alias": {
"$ref": "#/components/schemas/EnrichmentV2GbrAliasResult"
},
"gbr_quality": {
"$ref": "#/components/schemas/EnrichmentV2GbrQualityResult"
},
"addressbase_classification": {
"$ref": "#/components/schemas/EnrichmentV2AprClassificationResult"
},
"addressbase_cross_reference": {
"$ref": "#/components/schemas/EnrichmentV2AprCrossReferenceResult"
},
"addressbase_government": {
"$ref": "#/components/schemas/EnrichmentV2AprGovernmentResult"
},
"addressbase_health": {
"$ref": "#/components/schemas/EnrichmentV2AprHealthResult"
},
"addressbase_location_grid": {
"$ref": "#/components/schemas/EnrichmentV2AprLocationGridResult"
},
"addressbase_parliament": {
"$ref": "#/components/schemas/EnrichmentV2AprParliamentResult"
},
"addressbase_quality": {
"$ref": "#/components/schemas/EnrichmentV2AprQualityResult"
},
"addressbase_street": {
"$ref": "#/components/schemas/EnrichmentV2AprStreetResult"
},
"addressbase_topography": {
"$ref": "#/components/schemas/EnrichmentV2AprTopographyResult"
},
"addressbase_voa": {
"$ref": "#/components/schemas/EnrichmentV2AprVoaResult"
},
"irl_mosaic": {
"$ref": "#/components/schemas/EnrichmentV2IrlMosaicResult"
},
"nzl_household": {
"$ref": "#/components/schemas/EnrichmentV2NzlHouseholdResult"
},
"nzl_mosaic": {
"$ref": "#/components/schemas/EnrichmentV2NzlMosaicResult"
},
"nzl_property": {
"$ref": "#/components/schemas/EnrichmentV2NzlPropertyResult"
},
"sgp_mosaic": {
"$ref": "#/components/schemas/EnrichmentV2SgpMosaicResult"
}
},
"additionalProperties": false,
"description": "Details about the result. Includes the enriched data."
},
"EnrichmentV2ResultAddressValidateMetadata": {
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"datasets": {
"$ref": "#/components/schemas/EnrichmentV2ResultAddressValidateMetadataDatasets"
}
},
"additionalProperties": false
},
"EnrichmentV2ResultAddressValidateMetadataDatasets": {
"type": "object",
"properties": {
"geocodes": {
"$ref": "#/components/schemas/EnrichmentV2GeocodesMetadata"
},
"usa_regional_geocodes": {
"$ref": "#/components/schemas/EnrichmentV2UsaRegionalGeocodesMetadata"
},
"aus_regional_geocodes": {
"$ref": "#/components/schemas/EnrichmentV2AusRegionalGeocodesMetadata"
},
"nzl_regional_geocodes": {
"$ref": "#/components/schemas/EnrichmentV2NzlRegionalGeocodesMetadata"
},
"uk_location_complete": {
"$ref": "#/components/schemas/EnrichmentV2UkLocationCompleteMetadata"
},
"uk_location_essential": {
"$ref": "#/components/schemas/EnrichmentV2UkLocationEssentialMetadata"
},
"gbr_government": {
"$ref": "#/components/schemas/EnrichmentV2GbrGovernmentMetadata"
},
"gbr_health": {
"$ref": "#/components/schemas/EnrichmentV2GbrHealthMetadata"
},
"premium_location_insight": {
"$ref": "#/components/schemas/EnrichmentV2PremiumLocationInsightMetadata"
},
"what3words": {
"$ref": "#/components/schemas/EnrichmentV2What3WordsMetadata"
},
"gbr_location_grid": {
"$ref": "#/components/schemas/EnrichmentV2GbrLocationGridMetadata"
},
"gbr_parliament": {
"$ref": "#/components/schemas/EnrichmentV2GbrParliamentMetadata"
},
"gbr_mosaic": {
"$ref": "#/components/schemas/EnrichmentV2GbrMosaicMetadata"
},
"gbr_mosaic_financial": {
"$ref": "#/components/schemas/EnrichmentV2GbrMosaicFinancialMetadata"
},
"gbr_alias": {
"$ref": "#/components/schemas/EnrichmentV2GbrAliasMetadata"
},
"gbr_quality": {
"$ref": "#/components/schemas/EnrichmentV2GbrQualityMetadata"
},
"addressbase_classification": {
"$ref": "#/components/schemas/EnrichmentV2AprClassificationMetadata"
},
"addressbase_cross_reference": {
"$ref": "#/components/schemas/EnrichmentV2AprCrossReferenceMetadata"
},
"addressbase_government": {
"$ref": "#/components/schemas/EnrichmentV2AprGovernmentMetadata"
},
"addressbase_health": {
"$ref": "#/components/schemas/EnrichmentV2AprHealthMetadata"
},
"addressbase_location_grid": {
"$ref": "#/components/schemas/EnrichmentV2AprLocationGridMetadata"
},
"addressbase_parliament": {
"$ref": "#/components/schemas/EnrichmentV2AprParliamentMetadata"
},
"addressbase_quality": {
"$ref": "#/components/schemas/EnrichmentV2AprQualityMetadata"
},
"addressbase_street": {
"$ref": "#/components/schemas/EnrichmentV2AprStreetMetadata"
},
"addressbase_topography": {
"$ref": "#/components/schemas/EnrichmentV2AprTopographyMetadata"
},
"addressbase_voa": {
"$ref": "#/components/schemas/EnrichmentV2AprVoaMetadata"
},
"irl_mosaic": {
"$ref": "#/components/schemas/EnrichmentV2IrlMosaicMetadata"
},
"nzl_household": {
"$ref": "#/components/schemas/EnrichmentV2NzlHouseholdMetadata"
},
"nzl_mosaic": {
"$ref": "#/components/schemas/EnrichmentV2NzlMosaicMetadata"
},
"nzl_property": {
"$ref": "#/components/schemas/EnrichmentV2NzlPropertyMetadata"
},
"sgp_mosaic": {
"$ref": "#/components/schemas/EnrichmentV2SgpMosaicMetadata"
}
},
"additionalProperties": false
},
"EnrichmentV2SgpMosaic": {
"enum": [
"demographic_postal_code",
"residential_postal_code",
"affluence",
"life_stage"
],
"type": "string",
"description": "The dataset named SGP Mosaic and its associated attributes."
},
"EnrichmentV2SgpMosaicDemographicPostalCodeResult": {
"type": "object",
"properties": {
"type_code": {
"type": "string",
"description": "MOSAIC Type Code.",
"nullable": true
},
"type": {
"type": "string",
"description": "Name of MOSAIC Type.",
"nullable": true
},
"group_code": {
"type": "string",
"description": "MOSAIC Group Code.",
"nullable": true
},
"group": {
"type": "string",
"description": "Name of MOSAIC Group.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for SGP Mosaic Demographic Postal Code."
},
"EnrichmentV2SgpMosaicFactorResult": {
"type": "object",
"properties": {
"score": {
"type": "number",
"description": "Score.",
"format": "double",
"nullable": true
},
"percentile": {
"type": "number",
"description": "Percentile.",
"format": "double",
"nullable": true
},
"decile": {
"type": "number",
"description": "Decile.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for SGP Mosaic Elements that contains score, percentile and decile."
},
"EnrichmentV2SgpMosaicMetadata": {
"type": "object",
"properties": {
"demographic_postal_code": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"residential_postal_code": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"affluence": {
"$ref": "#/components/schemas/DatasetMetadataV2"
},
"life_stage": {
"$ref": "#/components/schemas/DatasetMetadataV2"
}
},
"additionalProperties": false
},
"EnrichmentV2SgpMosaicResidentialPostalCodeResult": {
"type": "object",
"properties": {
"households": {
"type": "string",
"description": "Residential Units.",
"nullable": true
},
"residents": {
"type": "string",
"description": "Population.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response for SGP Mosaic Residential Postal Code."
},
"EnrichmentV2SgpMosaicResult": {
"type": "object",
"properties": {
"demographic_postal_code": {
"$ref": "#/components/schemas/EnrichmentV2SgpMosaicDemographicPostalCodeResult"
},
"residential_postal_code": {
"$ref": "#/components/schemas/EnrichmentV2SgpMosaicResidentialPostalCodeResult"
},
"affluence": {
"$ref": "#/components/schemas/EnrichmentV2SgpMosaicFactorResult"
},
"life_stage": {
"$ref": "#/components/schemas/EnrichmentV2SgpMosaicFactorResult"
}
},
"additionalProperties": false,
"description": "Response for SGP Mosaic dataset."
},
"EnrichmentV2UkLocationCompleteMetadata": {
"type": "object",
"properties": {
"latitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"longitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"match_level": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"udprn": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"uprn": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"x_coordinate": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"y_coordinate": {
"$ref": "#/components/schemas/DatasetMetadata"
}
},
"additionalProperties": false,
"description": "Attribute-level metadata for the UK Location Complete dataset."
},
"EnrichmentV2UkLocationEssentialMetadata": {
"type": "object",
"properties": {
"latitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"longitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"match_level": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"udprn": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"uprn": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"x_coordinate": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"y_coordinate": {
"$ref": "#/components/schemas/DatasetMetadata"
}
},
"additionalProperties": false,
"description": "Attribute-level metadata for the UK Location Essential dataset."
},
"EnrichmentV2UsaRegionalGeocodesMetadata": {
"type": "object",
"properties": {
"latitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"longitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"match_level": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"census_tract": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"census_block": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"core_based_statistical_area": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"congressional_district_code": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"county_code": {
"$ref": "#/components/schemas/DatasetMetadata"
}
},
"additionalProperties": false,
"description": "Attribute-level metadata for the USA Regional Geocodes dataset."
},
"EnrichmentV2What3WordsMetadata": {
"type": "object",
"properties": {
"latitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"longitude": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"name": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"description": {
"$ref": "#/components/schemas/DatasetMetadata"
}
},
"additionalProperties": false,
"description": "Attribute-level metadata for the what3words dataset."
},
"HouseMember": {
"type": "object",
"properties": {
"firstname": {
"type": "string",
"description": "Gets or sets the First name.",
"nullable": true
},
"middlename": {
"type": "string",
"description": "Gets or sets the middle name initials.",
"nullable": true
},
"surname": {
"type": "string",
"description": "Gets or sets the Surname.",
"nullable": true
},
"name_title": {
"type": "string",
"description": "Gets or sets the name title.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Person names, registered at the formatted address."
},
"IdentityAppendAddressDetail": {
"type": "object",
"properties": {
"first_name_match": {
"type": "string",
"description": "Checks to see if the first name matches first names previously associated with that email.",
"nullable": true,
"example": "match"
},
"last_name_match": {
"type": "string",
"description": "Checks to see if the last name matches last names previously associated with that email.",
"nullable": true,
"example": "no_match"
},
"address_line_1_match": {
"type": "string",
"description": "Checks to see if the address line matches the address line previously associated with that email.",
"nullable": true,
"example": "no_data"
},
"town_match": {
"type": "string",
"description": "Checks to see if the town matches the town data previously associated with that email.",
"nullable": true,
"example": "no_data"
},
"postal_code_match": {
"type": "string",
"description": "Checks to see if the postal code matches the postal code data previously associated with that email.",
"nullable": true,
"example": "no_data"
},
"deliverability": {
"type": "string",
"description": "Checks if the address is deliverable.",
"nullable": true,
"example": "undeliverable"
},
"deliverability_detail": {
"type": "string",
"description": "Deliverable sub status.",
"nullable": true,
"example": "missing_primary"
},
"address_type": {
"$ref": "#/components/schemas/IdentityAppendAddressDetailAddressType"
}
},
"additionalProperties": false,
"description": "The Address Detail metadata."
},
"IdentityAppendAddressDetailAddressType": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Indicates the address type.",
"nullable": true,
"example": "S"
},
"description": {
"type": "string",
"description": "Indicates the description of the code.",
"nullable": true,
"example": "Street"
}
},
"additionalProperties": false,
"description": "The Address Detail metadata's address type information."
},
"IdentityAppendContactResponse": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "The first name of the individual.",
"nullable": true,
"example": "John"
},
"last_name": {
"type": "string",
"description": "The last name of the individual.",
"nullable": true,
"example": "Smith"
},
"address_line_1": {
"type": "string",
"description": "The first line of the individual’s address.",
"nullable": true,
"example": "1 Main Street"
},
"town": {
"type": "string",
"description": "The town, city or suburb of the individual’s address.",
"nullable": true,
"example": "Phoenix"
},
"region": {
"type": "string",
"description": "The state or province abbreviation of the individual’s address.",
"nullable": true,
"example": "AZ"
},
"postal_code": {
"type": "string",
"description": "The postal code of the individual’s address.",
"nullable": true,
"example": "94133"
},
"country_iso_3": {
"type": "string",
"description": "The country iso 3 of the individual’s address.",
"nullable": true,
"example": "USA"
}
},
"additionalProperties": false,
"description": "The individuals contact information matched to the email or phone supplied."
},
"IdentityAppendEmailDetail": {
"type": "object",
"properties": {
"email_type": {
"type": "string",
"description": "The type of email based on its classification of intended purpose, i.e. individual, business or education.",
"nullable": true,
"example": "individual"
},
"date_first_seen": {
"type": "string",
"description": "The date the email address first appeared in the records.",
"nullable": true,
"example": "2016-08-09"
},
"longevity": {
"type": "integer",
"description": "A score relating to when the email address was first discovered. From 0 (not discovered) to 3 (Discovered over a year ago).",
"format": "int32",
"nullable": true,
"example": "3"
},
"velocity": {
"type": "integer",
"description": "A score reflecting the activity of the email address over the last 6 months, from 0 (no activity) to 10 (most active).",
"format": "int32",
"nullable": true,
"example": "10"
},
"popularity": {
"type": "integer",
"description": "A score assessing the email address's visibility over the last 12 months based on the number of sources that have received the address, ranging from 0 (no sources) to 10 (most sources).",
"format": "int32",
"nullable": true,
"example": "10"
},
"domain": {
"$ref": "#/components/schemas/IdentityAppendEmailDetailDomain"
},
"confidence": {
"type": "string",
"description": "The outcome (confidence level) of the validation.",
"nullable": true,
"example": "verified"
},
"verbose_output": {
"type": "string",
"description": "The verbose output of the validation.",
"nullable": true,
"example": "verified"
},
"verbose_reason": {
"type": "string",
"description": "The verbose output description of the validation.",
"nullable": true,
"example": "Valid email address."
}
},
"additionalProperties": false,
"description": "Additional fields details that can be returned alongside the Identity Append result."
},
"IdentityAppendEmailDetailDomain": {
"type": "object",
"properties": {
"date_first_seen": {
"type": "string",
"description": "The date the domain first appeared in the records. The value \"now\" will be returned if the domain is new.",
"nullable": true,
"example": "now"
},
"longevity": {
"type": "integer",
"description": "A score relating to when the domain was first discovered. From 0 (not discovered) to 3 (Discovered over a year ago).",
"format": "int32",
"nullable": true,
"example": "3"
},
"velocity": {
"type": "integer",
"description": "A score reflecting the activity of the domain over the last 6 months, from 0 (no activity) to 10 (most active).",
"format": "int32",
"nullable": true,
"example": "10"
},
"popularity": {
"type": "integer",
"description": "A score assessing the domain's visibility over the last 12 months based on the number of sources that have received the address, ranging from 0 (no sources) to 10 (most sources).",
"format": "int32",
"nullable": true,
"example": "10"
},
"domain_type": {
"type": "string",
"description": "The type of domain.",
"nullable": true,
"example": "freeisp"
}
},
"additionalProperties": false,
"description": "The Email Detail metadata Domain info."
},
"IdentityAppendInputComponents": {
"type": "object",
"properties": {
"first_name": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The first name of the individual.",
"nullable": true,
"example": [
"John"
]
},
"middle_name": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The middle name of the individual.",
"nullable": true,
"example": [
"Abraham"
]
},
"last_name": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The last name of the individual.",
"nullable": true,
"example": [
"Smith"
]
},
"address_line_1": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The first line of the individual’s address.",
"nullable": true,
"example": [
"1 Main Street"
]
},
"town": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The town, city or suburb of the individual’s address.",
"nullable": true,
"example": [
"Phoenix"
]
},
"sub_region": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The county of the individual’s address.",
"nullable": true,
"example": [
"Yancey"
]
},
"region": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The state or province abbreviation of the individual’s address.",
"nullable": true,
"example": [
"AZ"
]
},
"postal_code": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The postal code of the individual’s address.",
"nullable": true,
"example": [
"94133"
]
},
"email": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The email of the individual.",
"nullable": true,
"example": [
"John.A.Smith@example.com"
]
},
"phone": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The phone number of the individual.",
"nullable": true,
"example": [
"1234567890"
]
},
"country_iso_2": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The country of the individual in two letter ISO code.",
"nullable": true,
"example": [
"US"
]
},
"ip_address": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The ip address of the individual.",
"nullable": true,
"example": [
"255.255.255.255"
]
},
"user_agent": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "The user agent of the individual.",
"nullable": true,
"example": [
"python-requests/2.27.1"
]
}
},
"additionalProperties": false,
"description": "The identity input component."
},
"IdentityAppendInputOptions": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the option.",
"nullable": true,
"example": "dnc_preference"
},
"value": {
"type": "string",
"description": "The value of the option.",
"nullable": true,
"example": "flag | exclude | only"
}
},
"additionalProperties": false,
"description": "The identity append request options."
},
"IdentityAppendIpDetail": {
"type": "object",
"properties": {
"routing_type": {
"type": "string",
"description": "Indicates the IP Routing Type (IPRT), which specifies how the connection is routed through the Internet and can be used to determine how close the user is to the public IP address.",
"nullable": true,
"example": "fixed"
},
"organization": {
"type": "string",
"description": "The registering organization, which can include many types of entities, including corporate, government, or educational entities, and ISPs managing the allocation and use of network blocks.",
"nullable": true,
"example": "experian"
},
"proxy_type": {
"type": "string",
"description": "The network or protocol utilized by the server to proxy the user connection is identified.",
"nullable": true,
"example": "tor"
},
"hosting_facility": {
"type": "boolean",
"description": "A value of \"true\" indicates that the IP address is associated with a hosting facility; otherwise the value is \"false\".",
"nullable": true,
"example": "true"
},
"latitude": {
"type": "number",
"description": "The latitude of the identified location.",
"format": "double",
"nullable": true,
"example": "38.89768"
},
"longitude": {
"type": "number",
"description": "The longitude of the identified location.",
"format": "double",
"nullable": true,
"example": "-77.03651"
}
},
"additionalProperties": false,
"description": "The Ip Address Detail metadata."
},
"IdentityAppendMetadata": {
"type": "object",
"properties": {
"email_detail": {
"$ref": "#/components/schemas/IdentityAppendEmailDetail"
},
"address_detail": {
"$ref": "#/components/schemas/IdentityAppendAddressDetail"
},
"ip_detail": {
"$ref": "#/components/schemas/IdentityAppendIpDetail"
},
"phone_detail": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityAppendPhoneDetail"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "The metadata model."
},
"IdentityAppendPhoneDetail": {
"type": "object",
"properties": {
"phone_type": {
"type": "string",
"description": "The type of phone based on its classification of intended purpose, i.e. mobile, landline, pager or unknown.",
"nullable": true,
"example": "mobile"
},
"number": {
"type": "string",
"description": "The phone number of the individual.",
"nullable": true,
"example": "123-456-7890"
},
"dnc": {
"type": "boolean",
"description": "A value of \"true\" indicates that the phone number appears on the Do Not Call list; otherwise the value is \"false\"",
"nullable": true,
"example": "true"
},
"dnc_date_revised": {
"type": "string",
"description": "The last date the phone number appeared on the Do Not Call list.",
"nullable": true,
"example": "2023-08-31"
},
"rank": {
"type": "integer",
"description": "The rank of the phone number most likely in use by the individual.",
"format": "int32",
"nullable": true,
"example": "0"
}
},
"additionalProperties": false,
"description": "The Phone Detail metadata."
},
"IdentityAppendRequest": {
"required": [
"attributes",
"components"
],
"type": "object",
"properties": {
"components": {
"$ref": "#/components/schemas/IdentityAppendInputComponents"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityAppendInputOptions"
},
"description": "The identity append request options.",
"nullable": true
},
"attributes": {
"maxItems": 1,
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "Type of the request.",
"example": [
"email"
]
}
},
"additionalProperties": false,
"description": "The request model.\n\nFor more information on what elements are mandatory or optional, please visit the Technical Documentation site for\nEmail Append, \nReverse Email Append, \nPhone Append\nand \nRisk Score."
},
"IdentityAppendResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/IdentityAppendResult"
},
"metadata": {
"$ref": "#/components/schemas/IdentityAppendMetadata"
}
},
"additionalProperties": false,
"description": "The response model."
},
"IdentityAppendResult": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email of the individual.",
"nullable": true,
"example": "John.A.Smith@example.com"
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityAppendContactResponse"
},
"nullable": true
},
"risk": {
"$ref": "#/components/schemas/EmailRiskResult"
},
"phones": {
"type": "array",
"items": {
"type": "string"
},
"description": "The matched phone number(s) of the individual.",
"nullable": true,
"example": "[ \"123-456-7890\", \"098-765-4321\"]"
}
},
"additionalProperties": false,
"description": "Details about the result, such as email, contact, or risk score."
},
"Key": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Gets or sets the key type",
"nullable": true,
"example": "postal_code"
},
"value": {
"type": "string",
"description": "Gets or sets the key value",
"nullable": true,
"example": "NN14 4RX"
}
},
"additionalProperties": false,
"description": "The key of the postal code."
},
"LocalityComponents": {
"type": "object",
"properties": {
"region": {
"$ref": "#/components/schemas/LocalityItem"
},
"sub_region": {
"$ref": "#/components/schemas/LocalityItem"
},
"town": {
"$ref": "#/components/schemas/LocalityItem"
},
"district": {
"$ref": "#/components/schemas/LocalityItem"
},
"sub_district": {
"$ref": "#/components/schemas/LocalityItem"
},
"type": {
"type": "string",
"description": "Addresses type. Specific for Japan.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The locality of the suggestion."
},
"LocalityItem": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Gets or sets the locality name",
"nullable": true
},
"code": {
"type": "string",
"description": "Gets or sets the locality code",
"nullable": true
},
"description": {
"type": "string",
"description": "Gets or sets the locality description",
"nullable": true
}
},
"additionalProperties": false,
"description": "Initializes a new instance of the Experian.Hub.Feature.AddressValidate.GfoClients.GfoRest.Models.GfoRestSearchV2ResponseModel.LocalityItem class."
},
"LocationElements": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The code of a business.",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of a business.",
"nullable": true
},
"small_or_home_office": {
"type": "boolean",
"description": "Is a business small or home office one."
}
},
"additionalProperties": false,
"description": "The location elements of a business."
},
"MatchInfoFlags": {
"type": "object",
"properties": {
"postcode_action": {
"type": "string",
"description": "Postcode action info.",
"nullable": true
},
"address_action": {
"type": "string",
"description": "Address action info.",
"nullable": true
},
"generic_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "General match codes info.",
"nullable": true
},
"aus_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "AUS specific match codes info.",
"nullable": true
},
"deu_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "DEU specific match codes info.",
"nullable": true
},
"fra_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "FRA specific match codes info.",
"nullable": true
},
"gbr_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "GBR specific match codes info.",
"nullable": true
},
"nld_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "NLD specific match codes info.",
"nullable": true
},
"nzl_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "NZL specific match codes info.",
"nullable": true
},
"sgp_info": {
"type": "array",
"items": {
"type": "string"
},
"description": "SGP specific match codes info.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to map validation match info flags from proweb."
},
"PhoneValidationV2Confidence": {
"enum": [
"Verified",
"Absent",
"Teleservice not provisioned",
"Unverified",
"No coverage",
"Unknown",
"Dead"
],
"type": "string",
"description": "The outcome (confidence level) of the validation."
},
"PhoneValidationV2Metadata": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Ignore, currently not used.",
"nullable": true
},
"message": {
"type": "string",
"description": "Ignore, currently not used.",
"nullable": true
},
"phone_detail": {
"$ref": "#/components/schemas/PhoneValidationV2PhoneDetail"
}
},
"additionalProperties": false,
"description": "The metadata model."
},
"PhoneValidationV2PhoneDetail": {
"type": "object",
"properties": {
"original_operator_name": {
"type": "string",
"description": "The name of the MSISDN operator where the phone number was originally registered.",
"nullable": true,
"example": "T-Mobile"
},
"original_network_status": {
"type": "string",
"description": "The status of the network where the phone number was originally registered.",
"nullable": true,
"example": "Available"
},
"original_home_network_identity": {
"type": "string",
"description": "The Mobile Country Code (MCC) and Mobile Network Code (MNC) where the phone number was originally registered.",
"nullable": true,
"example": "310200"
},
"original_country_prefix": {
"type": "string",
"description": "The international calling code of the country where the phone number was originally registered.",
"nullable": true,
"example": "1"
},
"original_country_name": {
"type": "string",
"description": "The name of the country where the phone number was originally registered.",
"nullable": true,
"example": "United States of America"
},
"original_country_iso": {
"type": "string",
"description": "The 3-letter ISO code of the country where the phone number was originally registered.",
"nullable": true,
"example": "USA"
},
"operator_name": {
"type": "string",
"description": "The name of the MSISDN operator where the phone number is currently registered.",
"nullable": true,
"example": "Verizon"
},
"network_status": {
"type": "string",
"description": "The status of the network where the phone number is currently registered.",
"nullable": true,
"example": "Available"
},
"home_network_identity": {
"type": "string",
"description": "The Mobile Country Code (MCC) and Mobile Network Code (MNC) where the phone number is currently registered.",
"nullable": true,
"example": "311480"
},
"country_prefix": {
"type": "string",
"description": "The international calling code of the country where the phone number is currently registered.",
"nullable": true,
"example": "1"
},
"country_name": {
"type": "string",
"description": "The name of the country where the phone number is currently registered.",
"nullable": true,
"example": "United States of America"
},
"country_iso": {
"type": "string",
"description": "The 3-letter ISO code of the country where the phone number is currently registered.",
"nullable": true,
"example": "USA"
},
"is_ported": {
"type": "string",
"description": "Indicates whether the phone number is ported or not.",
"nullable": true,
"example": "Yes"
},
"cache_value_days": {
"type": "integer",
"description": "The requested number of days to look back in the cache for this phone number.",
"format": "int32",
"nullable": true,
"example": 0
},
"date_cached": {
"type": "string",
"description": "The last date this phone number was checked.",
"nullable": true,
"example": "2020-04-22"
},
"email_to_sms_address": {
"type": "string",
"description": "Email address which can be used to send SMS messages to this phone number.",
"nullable": true,
"example": "7087694383@vtext.com"
},
"email_to_mms_address": {
"type": "string",
"description": "Email address which can be used to send MMS messages to this phone number.",
"nullable": true,
"example": "7087694383@vzwpix.com"
}
},
"additionalProperties": false,
"description": "Metadata fields and values that can be returned, in addition to the main core information."
},
"PhoneValidationV2Request": {
"required": [
"number"
],
"type": "object",
"properties": {
"number": {
"minLength": 1,
"type": "string",
"description": "The phone number that is the subject of the validation.",
"example": "17087694383"
},
"output_format": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The desired format of the phone number: E164, PLUS_E164, NATIONAL, any 3-letter ISO country code.\nIf not specified, the default format, E164, will be used.",
"nullable": true,
"example": "NATIONAL"
},
"cache_value_days": {
"maximum": 30,
"minimum": 0,
"type": "integer",
"description": "The number of days to look back in cache for the validation result for this phone number.\nIf the result is cached, the response will be returned faster. Acceptable values from 0 (no cache)\nto 30. If not specified, the default value, 7, will be used.",
"format": "int32",
"nullable": true,
"example": 0
},
"country_iso": {
"maxLength": 3,
"minLength": 0,
"type": "string",
"description": "You can indicate the 3-letter ISO country code if the phone number that is subject to validation doesn't contain a phone country code.",
"nullable": true
},
"get_ported_date": {
"type": "boolean",
"description": "The date the phone number was last ported, returned only if the number has been moved to a different network.\nThis is an optional field and is included only when get_ported_date is set to true, which incurs an additional click.",
"example": true
},
"get_disposable_number": {
"type": "boolean",
"description": "A boolean indicator to attempt to verify if the number is known to be disposable.\nA disposable number is a shared mobile(or landline) that can be used to receive a text, or phone call.",
"nullable": true,
"example": true
},
"supplementary_live_status": {
"$ref": "#/components/schemas/PhoneValidationV2SupplementaryLiveStatus"
}
},
"additionalProperties": false,
"description": "The request model.",
"xml": {
"name": "request"
}
},
"PhoneValidationV2Response": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/PhoneValidationV2Result"
},
"metadata": {
"$ref": "#/components/schemas/PhoneValidationV2Metadata"
}
},
"additionalProperties": false,
"description": "The response model.",
"xml": {
"name": "response"
}
},
"PhoneValidationV2Result": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The phone number that is the subject of the validation.",
"nullable": true,
"example": "17087694383"
},
"validated_phone_number": {
"type": "string",
"description": "The validated phone number. Also includes the international country calling code. Note\nthat this field is returned even if the phone number has a confidence status of \"Invalid\".",
"nullable": true,
"example": "17087694383"
},
"formatted_phone_number": {
"type": "string",
"description": "The phone number in the format you specified in \"output_format\".",
"nullable": true,
"example": "(708) 769-4383"
},
"phone_type": {
"type": "string",
"description": "The type of phone number. Note: Landline is only supported in North America.",
"nullable": true,
"example": "Mobile"
},
"confidence": {
"$ref": "#/components/schemas/PhoneValidationV2Confidence"
},
"ported_date": {
"type": "string",
"description": "The date the phone number was last ported, returned only if the number has been moved to a different network. \nThis is an optional field and is included only when get_ported_date is set to true, which incurs an additional click.",
"nullable": true,
"example": "2012-06-27T09:32:09Z"
},
"disposable_number": {
"type": "string",
"description": "Indicates whether the phone number is a disposable number based on lookup list of disposable numbers.\nIf the number can be found in the lookup list, the value returned will be \"Yes\". Otherwise, the value returned\nwill be \"Unknown\". This value would be returned if the get_disposable_number boolean is set to true.",
"nullable": true,
"example": "Yes"
}
},
"additionalProperties": false,
"description": "Details about the result. Includes the validated data and its confidence level."
},
"PhoneValidationV2SupplementaryLiveStatus": {
"type": "object",
"properties": {
"mobile": {
"type": "array",
"items": {
"type": "string"
},
"description": "An indicator to attempt to get supplementary live status for Mobile Phone Number.",
"nullable": true,
"example": [
"USA"
]
},
"landline": {
"type": "array",
"items": {
"type": "string"
},
"description": "An indicator to attempt to get supplementary live status for Landline Phone Number.",
"nullable": true,
"example": [
"GBR"
]
}
},
"additionalProperties": false,
"description": "The supplementary live status request model. Please note that this feature has additional charge if requested.",
"xml": {
"name": "supplementarylivestatusrequest"
}
},
"PostalCode": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"description": "Gets or sets the full postal code",
"nullable": true
},
"primary": {
"type": "string",
"description": "Gets or sets the postal code primary",
"nullable": true
},
"secondary": {
"type": "string",
"description": "Gets or sets the postal code secondary",
"nullable": true
}
},
"additionalProperties": false,
"description": "The postal code of the suggestion."
},
"PremiumLocationInsightGeocodes": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "The latitude of the property.",
"format": "double",
"nullable": true,
"example": 52.9413
},
"longitude": {
"type": "number",
"description": "The longitude of the property.",
"format": "double",
"nullable": true,
"example": 1.16312
},
"match_level": {
"type": "string",
"description": "Specifies the accuracy of the coordinates for the specified address.",
"nullable": true,
"example": "Building"
}
},
"additionalProperties": false,
"description": "Geocode attributes for the specified address."
},
"PremiumLocationInsightGeocodesAccess": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "The latitude of access geocode.",
"format": "double",
"nullable": true,
"example": 52.9413
},
"longitude": {
"type": "number",
"description": "The longitude of access geocode.",
"format": "double",
"nullable": true,
"example": 1.16312
}
},
"additionalProperties": false,
"description": "Access geocode for the specified address."
},
"PremiumLocationInsightGeocodesBuildingXy": {
"type": "object",
"properties": {
"x_coordinate": {
"type": "number",
"description": "The Geocode 'X' coordinate for the centre of the property.",
"format": "double",
"nullable": true,
"example": 152718.84
},
"y_coordinate": {
"type": "number",
"description": "The Geocode 'Y' coordinate for the centre of the property.",
"format": "double",
"nullable": true,
"example": 529726.56
}
},
"additionalProperties": false,
"description": "Building XY coordinate for the specified address."
},
"PremiumLocationInsightReferenceTime": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Time zone applicable based on current timestamp.",
"nullable": true,
"example": "EET"
},
"standard_offset": {
"type": "string",
"description": "Standard offset returned based on current timestamp.",
"nullable": true,
"example": "02:00:00"
},
"daylight_savings": {
"type": "string",
"description": "Daylight savings returned based on current timestamp.",
"nullable": true,
"example": "00:00:00"
},
"sunrise": {
"type": "string",
"description": "Sunrise time at the given time zone based on current timestamp.",
"nullable": true,
"example": "2023-04-07T03:38:08.767292+00:00"
},
"sunset": {
"type": "string",
"description": "Sunset time at the given time zone based on current timestamp.",
"nullable": true,
"example": "2023-04-07T16:16:40.8507771+00:00"
}
},
"additionalProperties": false,
"description": "Time zone information returned based on current timestamp."
},
"PremiumLocationInsightTime": {
"type": "object",
"properties": {
"time_zone_id": {
"type": "string",
"description": "Time zone id.",
"nullable": true,
"example": "Africa/Cairo"
},
"generic": {
"type": "string",
"description": "Generic time zone name.",
"nullable": true,
"example": "Eastern European Time"
},
"standard": {
"type": "string",
"description": "Standard time zone name.",
"nullable": true,
"example": "Eastern European Standard Time"
},
"daylight": {
"type": "string",
"description": "Daylight time zone name.",
"nullable": true,
"example": "Eastern European Summer Time"
},
"reference_time": {
"$ref": "#/components/schemas/PremiumLocationInsightReferenceTime"
},
"time_transition": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PremiumLocationInsightTimeTransition"
},
"description": "Daylight savings time (DST) transitions information returned based on a specified address.",
"nullable": true,
"xml": {
"name": "time_transition",
"wrapped": true
}
}
},
"additionalProperties": false,
"description": "Time zone information returned based on a specified address."
},
"PremiumLocationInsightTimeTransition": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Time zone applicable based on a specified UTC start time and end time.",
"nullable": true,
"example": "EET"
},
"standard_offset": {
"type": "string",
"description": "Standard offset returned based on a specified UTC start time and end time.",
"nullable": true,
"example": "02:00:00"
},
"daylight_savings": {
"type": "string",
"description": "Daylight savings returned based on a specified UTC start time and end time.",
"nullable": true,
"example": "00:00:00"
},
"utc_start": {
"type": "string",
"description": "Starting time of this UTC offset and DST.",
"nullable": true,
"example": "2014-09-25T21:00:00Z"
},
"utc_end": {
"type": "string",
"description": "Ending time of this UTC offset and DST.",
"nullable": true,
"example": "2023-04-27T22:00:00Z"
}
},
"additionalProperties": false,
"description": "Daylight savings time (DST) transitions information returned based on a specified address."
},
"ResponseError": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "A link to documentation that provides more details about the error you’ve encountered.",
"nullable": true
},
"title": {
"type": "string",
"description": "The title of the error.",
"nullable": true,
"example": "Bad Request"
},
"detail": {
"type": "string",
"description": "A description of the error.",
"nullable": true,
"example": "The request body was malformed."
},
"instance": {
"type": "string",
"description": "The endpoint that returned the error.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Error model containing the error details."
},
"RpaV1Address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string",
"description": "The first line of the address.",
"nullable": true,
"example": "NO 12345"
},
"address_line2": {
"type": "string",
"description": "The second line of the address.",
"nullable": true,
"example": "APT 6789"
},
"city": {
"type": "string",
"description": "The city.",
"nullable": true,
"example": "TINLEY PARK"
},
"state": {
"type": "string",
"description": "The state.",
"nullable": true,
"example": "IL"
},
"zip5": {
"type": "string",
"description": "The Zip5 of the address.",
"nullable": true,
"example": "12345"
},
"zip4": {
"type": "string",
"description": "The Zip4 of the address.",
"nullable": true,
"example": "6789"
},
"confidence": {
"$ref": "#/components/schemas/RpaV1AddressConfidence"
}
},
"additionalProperties": false,
"description": "Reverse Phone Append Address."
},
"RpaV1AddressConfidence": {
"enum": [
"Verified",
"Unverified"
],
"type": "string"
},
"RpaV1Metadata": {
"type": "object",
"properties": {
"phone_detail": {
"$ref": "#/components/schemas/RpaV1PhoneDetail"
}
},
"additionalProperties": false
},
"RpaV1PhoneConfidence": {
"enum": [
"Verified",
"Unverified"
],
"type": "string"
},
"RpaV1PhoneDetail": {
"type": "object",
"properties": {
"input_phone_type": {
"$ref": "#/components/schemas/RpaV1PhoneType"
}
},
"additionalProperties": false,
"description": "Reverse Phone Append Phone details."
},
"RpaV1PhoneType": {
"enum": [
"Landline",
"Mobile",
"Other"
],
"type": "string"
},
"RpaV1Request": {
"required": [
"number"
],
"type": "object",
"properties": {
"number": {
"minLength": 1,
"pattern": "^\\d{10}$",
"type": "string",
"description": "10-digit unformatted phone number. This value cannot contain non-numeric characters such as parentheses, dashes, or spaces",
"example": "1234567890"
}
},
"additionalProperties": false,
"description": "Reverse Phone Append request."
},
"RpaV1Response": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ResponseError"
},
"result": {
"$ref": "#/components/schemas/RpaV1Result"
},
"metadata": {
"$ref": "#/components/schemas/RpaV1Metadata"
}
},
"additionalProperties": false,
"description": "Reverse Phone Append response."
},
"RpaV1Result": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The phone number.",
"nullable": true,
"example": "1234567890"
},
"confidence": {
"$ref": "#/components/schemas/RpaV1PhoneConfidence"
},
"first_name": {
"type": "string",
"description": "The first name.",
"nullable": true,
"example": "JOE"
},
"middle_name": {
"type": "string",
"description": "The middle name.",
"nullable": true,
"example": "JR"
},
"last_name": {
"type": "string",
"description": "The last name.",
"nullable": true,
"example": "DOE"
},
"address": {
"$ref": "#/components/schemas/RpaV1Address"
}
},
"additionalProperties": false,
"description": "Reverse Phone Append result."
},
"StandardIndustryClassificationElements": {
"type": "object",
"properties": {
"sic_2007_code": {
"type": "string",
"description": "The sic 2007 code.",
"nullable": true
},
"sic_2007_description": {
"type": "string",
"description": "The sic 2007 description.",
"nullable": true
},
"thomson_code": {
"type": "string",
"description": "The Thomson code.",
"nullable": true
},
"thomson_description": {
"type": "string",
"description": "The Thomson description.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The standard industry classification elements of a business."
},
"Suggestion": {
"type": "object",
"properties": {
"locality": {
"$ref": "#/components/schemas/LocalityComponents"
},
"postal_code": {
"$ref": "#/components/schemas/PostalCode"
},
"postal_code_key": {
"type": "string",
"description": "Gets or sets the suggestion postal code key (to do postal code enrichment requests)",
"nullable": true
},
"locality_key": {
"type": "string",
"description": "Gets or sets the suggestion locality key (to do centroid enrichment requests)",
"nullable": true
},
"what3words": {
"$ref": "#/components/schemas/What3WordsComponent"
}
},
"additionalProperties": false,
"description": "The suggestions that match the address search input."
},
"What3WordsComponent": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Gets or sets the name;",
"nullable": true
},
"description": {
"type": "string",
"description": "Gets or sets the description",
"nullable": true
}
},
"additionalProperties": false,
"description": "What3Words address suggestion."
},
"EmailValidationV2Request": {
"required": [
"email"
],
"type": "object",
"properties": {
"email": {
"maxLength": 320,
"type": "string",
"description": "The email address that is the subject of the validation. Maximum local part length is 64 and maximum domain part length is 255",
"example": "support@experian.com"
}
},
"additionalProperties": false,
"description": "The request model."
},
"EmailValidationV2Confidence": {
"enum": [
"verified",
"undeliverable",
"unreachable",
"illegitimate",
"disposable",
"unknown"
],
"type": "string",
"description": "The outcome (confidence level) of the validation."
},
"EmailValidationV2Response": {
"type": "object",
"properties": {
"result": {
"$ref": "#/components/schemas/EmailValidationV2Result"
},
"metadata": {
"$ref": "#/components/schemas/EmailValidationV2Metadata"
},
"error": {
"$ref": "#/components/schemas/ResponseError"
}
},
"additionalProperties": false,
"description": "The response model."
},
"EmailValidationV2Metadata": {
"type": "object",
"properties": {
"domain_detail": {
"$ref": "#/components/schemas/EmailValidationV2DomainDetail"
},
"normalized_email": {
"type": "string",
"description": "The normalized version of the request email.",
"nullable": true,
"example": "support@experian.com"
}
},
"additionalProperties": false,
"description": "Details about all properties that metadata includes."
},
"EmailValidationV2DomainDetail": {
"type": "object",
"properties": {
"type": {
"enum": [
"consumer",
"business"
],
"type": "string",
"description": "Type field value:\n * consumer - returned for \"free\" domains\n * business - returned for \"business\" domains\n * Omit the field \"type\" when we are unable to provide a value (either through DB issues, not having the domain in our DB, or other)\n"
}
},
"additionalProperties": false,
"description": "Details about the domain."
},
"EmailValidationV2VerboseOutput": {
"enum": [
"verified",
"mailboxDisabled",
"mailboxDoesNotExist",
"mailboxFull",
"syntaxFailure",
"internationalCharactersUnsupported",
"unreachable",
"illegitimate",
"roleAccount",
"typoDomain",
"localPartSpamTrap",
"Profanity",
"disposable",
"unknown",
"timeout",
"acceptAll",
"relayDenied",
"BLANK"
],
"type": "string",
"description": "Verbose output field value:\n * verified - The mailbox exists, is reachable, and is not known to be illegitimate or disposable.\n * mailboxDisabled - The mailbox is disabled.\n * mailboxDoesNotExist - The mailbox does not exist.\n * mailboxFull - The mailbox is full.\n * syntaxFailure - The syntax of the specified email address is incorrect.\n * internationalCharactersUnsupported - The email provider does not support international characters.\n * unreachable - The domain is not responding to validation requests or does not have any active mail severs.\n * illegitimate - Seed, spamtrap, black hole, technical role account or inactive domain.\n * roleAccount - Role accounts such as support, sales, info etc.\n * typoDomain - The domain of the email address you've provided was close to a common domain and, although it exists, it is highly unlikely to be correct.\n * localPartSpamTrap - Known local portions of the email address that may indicate spam traps.\n * Profanity - The email address contains profanity.\n * disposable - The domain is administered by a disposable email provider (e.g. Mailinator).\n * unknown - We were unable to conclusively verify or invalidate the email address.\n * timeout - The request timed out due to the host domain not responding in time.\n * acceptAll - The domain is accept-all, so the email address cannot be validated.\n * relayDenied - The result was validated at the incorrect mail exchanger.\n * BLANK - You are submitting requests at a faster rate than allowed by the email service providers for the domains you are checking.\n"
},
"EmailValidationV2Result": {
"type": "object",
"properties": {
"confidence": {
"$ref": "#/components/schemas/EmailValidationV2Confidence"
},
"did_you_mean": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of more likely email addresses. Suggestions include fixes to syntax errors in the provided email address, typos in domains etc.",
"nullable": true
},
"verbose_output": {
"$ref": "#/components/schemas/EmailValidationV2VerboseOutput"
},
"email": {
"type": "string",
"description": "The email address that is the subject of the validation.",
"example": "support@experian.com"
}
},
"additionalProperties": false,
"description": "Details about the result. Includes the validated data and its confidence level."
}
},
"securitySchemes": {
"OAuth2": {
"type": "http",
"description": "Token URL: https://sso.experianaperture.io/oauth2/aust0wkxjeKyT3HRO4x7/v1/token \n\n Flow: clientCredentials",
"scheme": "Bearer",
"bearerFormat": "JWT"
},
"Auth-Token": {
"type": "apiKey",
"description": "Your unique key, called a token, that is required to submit an API request.",
"name": "Auth-Token",
"in": "header"
},
"x-app-key": {
"type": "apiKey",
"description": "Alternative Auth Token header.",
"name": "x-app-key",
"in": "header"
}
},
"headers": {
"Transaction-Id": {
"schema": {
"type": "string",
"description": "Unique Experian-assigned transaction identifier.",
"example": "ab123ab1-abc1-1234-abcd-ab1a123a1a12"
}
},
"Reference-Id": {
"schema": {
"type": "string",
"description": "If you chose to submit a \"Reference-Id\" in the response body, the value will be returned with the response.",
"nullable": true
}
}
}
},
"servers": [
{
"url": "https://api.experianaperture.io/"
}
]
}