PostcodeAnywhere/Interactive/RetrieveByIdWithEmail (v 1.00)
Returns the full address details based on the Id and validates the given email address.
REST code samples & end points
Choose a code sample language below.
Select an end point to view an example.
Try it
Enter your values in the form below to try the service for yourself. We've put some example values in already to get you started.
* Optional - if left blank the default is used.
Parameters
Each request to the web service requires a number of parameters, all of which are listed below. All requests require a key which was generated when you registered. You can create any number of keys, each of which can be reported on individually and have specific security settings.
| Name |
Type |
Description |
Default |
Values |
Example |
|
Key |
String |
The key to use to authenticate to the service. |
|
|
AA11-AA11-AA11-AA11 |
|
Id |
String |
The Id from a Find method to retrieve the details for. |
|
|
23747212.00 |
|
Email |
String |
The email address to verify. |
|
|
info@google.com |
|
Timeout * |
Integer |
How long to wait (in seconds) for the email server to respond. |
3 |
|
3 |
|
UserName * |
String |
The username associated with the Royal Mail license (not required for click licenses). |
|
|
David |
* Optional - if left blank the default is used.
Optional filter parameters
Use these parameters to further tailor the results.
| Name |
Type |
Description |
Default |
Values |
Example |
| $Top |
Integer |
The maximum number of rows to return. |
|
|
10 |
| $OrderBy |
String |
A list of columns to order the results by. |
|
|
Id, Name DESC |
| $Filter |
String |
A SQL-style WHERE filter to apply to the result. |
|
|
Name LIKE 'a%' |
| $PageNumber |
Integer |
Returns the relevant page from the results, 1 being the first. Must be used in conjunction with $PageSize. |
|
|
5 |
| $PageSize |
Integer |
Selects the appropriate results per page size to use. |
|
|
10 |
Fields
The response from the web service is a table with the specification below. Where no items are found, the response will be empty (although all endpoints specify the columns). If an error occurs, the response will not follow this format. Instead the response will be an error table (see general and specific errors).
| Name |
Type |
Description |
Values |
Example |
|
Udprn |
Integer |
The Royal Mail UDPRN (Unique Delivery Point Reference Number) for the address. |
|
0 |
|
Company |
String |
The name of the company. |
|
|
|
Department |
String |
Department name (rarely used). |
|
|
|
Line1 |
String |
Line 1 of the address. |
|
|
|
Line2 |
String |
Line 2 of the address. |
|
|
|
Line3 |
String |
Line 3 of the address (rarely used). |
|
|
|
Line4 |
String |
Line 4 of the address (rarely used). |
|
|
|
Line5 |
String |
Line 5 of the address (rarely used). |
|
|
|
PostTown |
String |
The post town for the address. |
|
|
|
County |
String |
The postal county for the address. |
|
|
|
Postcode |
String |
The postcode for the address. |
|
|
|
Mailsort |
Integer |
The mailsort code for the address. |
|
0 |
|
Barcode |
String |
The barcode for the address. |
|
() |
|
Type |
String |
The type of address. |
Residential | SmallBusiness | LargeBusiness | Unknown |
Unknown |
|
DeliveryPointSuffix |
String |
The 2 character delivery point suffix. |
|
|
|
SubBuilding |
String |
The name of the sub building (flat / unit etc). |
|
|
|
BuildingName |
String |
The building name if present. |
|
|
|
BuildingNumber |
String |
The number (or number range) of the building. |
|
|
|
PrimaryStreet |
String |
The primary thoroughfare name. |
|
|
|
SecondaryStreet |
String |
The secondary thoroughfare name. Usually a small street off the primary. |
|
|
|
DoubleDependentLocality |
String |
The least significant locality (rarely used), possibly a hamlet. |
|
|
|
DependentLocality |
String |
Less significant locality name, possibly a village. |
|
|
|
PoBox |
String |
The number of the PO Box if present (may contain non numeric items). |
|
|
|
Email |
String |
The address the email was sent to. |
|
info@google.com |
|
MailServer |
String |
The mail server that was used to perform the server and account validation steps on. Not populated if the DNS record was not found. |
|
google.com.s9a1.psmtp.com |
|
ValidFormat |
Boolean |
Indicates that the format of the email appears valid. |
|
True |
|
FoundDnsRecord |
Boolean |
Indicates that a valid DNS record was found for the email. |
|
True |
|
FoundServer |
Boolean |
Indicates that an SMTP connection to the server was made. |
|
True |
|
FoundAccount |
Boolean |
Indicates that the account was found on the server. |
|
True |
Prices
This table will outline the credit costs or required licenses for this web service. Many web services support both credit or licenses while many are free!
| |
£25
Plan |
£50
Plan |
£100
Plan |
£250
Plan |
£500
Plan |
£1,000
Plan |
£2,500
Plan |
| UK Address Look-up |
8.3p |
5.0p |
4.0p |
3.3p |
2.8p |
2.2p |
1.9p |
| UK Internal Address Look-up |
31.3p |
25.0p |
20.0p |
17.9p |
16.7p |
15.4p |
14.3p |
| UK Street Level Address Look-up |
4.2p |
2.5p |
2.0p |
1.7p |
1.4p |
1.1p |
0.9p |
| UK Internal Street Level Address Look-up |
15.6p |
12.5p |
10.0p |
8.9p |
8.3p |
7.7p |
7.1p |
Response Errors
Below are the errors which are specific to this web service (more general errors are listed below). If an error occurs, an error table like the one below will be returned (developers should test for a 4 column table with columns "Error", "Description", "Cause" and "Resolution". An error response will only contain a single row.
| Error |
Description |
Cause |
Resolution |
|
1001 |
Id Required |
The Id parameter was not supplied. |
Please ensure that you supply the Id parameter and try again. |
|
1002 |
Id Invalid |
The Id parameter was not valid. |
The Id parameter should be an Id from a Find method. It may contain unusual formatting characters, all of which must be presented. |
|
1003 |
Invalid Timeout |
The Timeout is invalid. |
Check that the timeout is a positive integer and try again. |
General Errors
These errors are general service errors and may be returned by any web service. Note that general errors are all below 100 while service specific errors start at 1000.
| Error |
Description |
Cause |
Resolution |
|
-1 |
Unknown error |
The cause of the error is unknown but details have been passed to our support staff who will investigate. |
These problems are typically short lived and are often resolved by trying again in a few minutes. |
|
2 |
Unknown key |
The key you are using to access the service was not found. |
Please check that the key is correct. It should be in the form AA11-AA11-AA11-AA11. |
|
3 |
Account out of credit |
Your account is either out of credit or has insufficient credit to service this request. |
Please check your account balance and top it up if necessary. |
|
4 |
Request not allowed from this IP |
The request was disallowed from the IP address. |
Check the security settings on the key first. If they look fine, please contact support as it may be from an IP address on our blacklist. |
|
5 |
Request not allowed from this URL |
The request was disallowed from the URL. |
Check the security settings on the key first. If they look fine, please contact support as it may be from a URL on our blacklist. |
|
6 |
Web service not available on this key |
The requested web service is disallowed on this key. |
Check the security settings on the key first. You can limit a key to certain web services. |
|
7 |
Web service not available on your plan |
The requested web service is not currently available on your payment plan. |
Some services are only available in specific regions due to licensing restrictions. Please contact us for more information. |
|
8 |
Key daily limit exceeded |
The daily limit on the key has been exceeded. |
Alter the daily limit on the key. Check the usage details first to see if usage is normal. |
|
9 |
Surge protector running |
The surge protector is currently enabled and has temporarily suspended access to the account. |
You can disable the surge protector at any time, but this is only recommended if you are running through a batch of requests. |
|
10 |
Surge protector triggered |
An unusually large number of requests have been processed for your account so the surge protector has been enabled. |
You can disable the surge protector at any time but this is only recommended if you are running through a batch of requests. |
|
11 |
No valid license available |
The request requires a valid license but none were found. |
Please check your purchase history. You may be using a license that is no longer valid or of an incorrect type. |
|
12 |
Management key required |
To use this web service you require a management key. Management can be enabled on any key, but we advise you to use management keys with care. |
Sign in to the website and create a new management key or change an existing key. |
|
13 |
Demo limit exceeded |
The daily demonstration limit for this service or account has been exceeded. |
The limit will be reset at midnight tonight. If you would like the limit increased, please contact us. |
|
14 |
Free service limit exceeded |
You have used too many free web services. |
Our web services are designed to operate in stages. The first is usually a Find service followed by a Retrieve. If you use too many Finds without the corresponding number of Retrieves you will receive this error. For more information, please contact us. |
|
15 |
Wrong type of key |
The type of key you're using isn't supported by this web service. |
This usually happens if you're using a user or server license with a web service that only supports transactional keys. Please use another key and try again. |
|
16 |
Key expired |
The key you are trying to use has expired. |
Please check that you are using the right key. A new one may have been issued if you recently renewed your key. Contact us if you have any questions. |