Cookie

We use cookies to improve your experience on our site, and to provide a live chat feature. To find out more please read our privacy policy.

status

This endpoint describes the status of Postcoder and the settings associated with your API key.

Status page: See the status page to view current and historic uptime.

Request URL

GET https://ws.postcoder.com/pcw/{apikey}/status

Path parameters

ParameterDescriptionExample
apikeyYour API keyPCW45-12345-12345-1234X

Querystring parameters

ParameterDescriptionExample
formatSets the format of the response, xml or json (default unless "application/xml" header is detected)format=json

Example request and response

GET https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/status?format=json

{
	"correctsearchkey": true,
	"availablecredits": 0,
	"lookupservicesup": true,
	"state": "Test Key",
	"currentipvalid": true,
	"currentip": "151.225.70.75",
	"overallstatus": true,
	"evaluation": false,
	"suspended": false,
	"emailvalidation": "Ok",
	"mobilevalidation": "Ok",
	"bankvalidation": "Ok",
	"countriesavailable": "UK",
	"eircode": "No Access",
	"addressbase": "No Access",
	"addressbasecore": "No Access",
	"emailvalidationaccess": "Full Access",
	"mobilevalidationaccess": "Full Access"
}

Response fields

FieldDescriptionExample
correctsearchkeyA true or false to indicate whether the API key existstrue
availablecreditsThe number of credits remaining99999
lookupservicesupA true or false to confirm the service is up and runningtrue
stateA description of the state of the service and / or the API keyTest Key
currentipvalidA true or false to indicate whether the current IP address is authorised to make lookupstrue
currentipThe IP address of the device making this request81.73.8.29
overallstatusA true or false to indicate the overall status of the servicetrue
evaluationA true or false to indicate whether the API key is in trial modefalse
suspendedA true or false to indicate whether the API key has been suspendedfalse
emailvalidationThe current status of the email validation serviceOk
mobilevalidationThe current status of the mobile validation serviceOk
countriesavailableThe countries enabled on the API keyALL
eircodeThe API key's level of access to the Eircode datasetNo Access
addressbaseThe API key's level of access to the AddressBase datasetFull Access
emailvalidationaccessThe API key's level of access to the email validation serviceNo Access
mobilevalidationaccessThe API key's level of access to the mobile validation serviceFull Access

Credit cost

This endpoint is free to use.

Buy a credit pack or set up a monthly plan for use with all Postcoder features