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

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

Path parameters

Parameter	Description	Example
`apikey`	Your API key	`PCW45-12345-12345-1234X`

Querystring parameters

Parameter	Description	Example
`format`	Sets the format of the response, xml or json (default unless "application/xml" header is detected)	`format=json`

Example request and response

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,
	"bankvalidation": "Ok",
	"emailvalidation": "Ok",
	"mobilevalidation": "Ok",
	"otpverification": "Ok",
	"countriesavailable": "UK",
	"eircode": "No Access",
	"addressbase": "No Access",
	"addressbasecore": "No Access",
	"bankvalidationaccess": "Full Access",
	"emailvalidationaccess": "Full Access",
	"mobilevalidationaccess": "Full Access",
	"otpverificationaccess": "Full Access"
}

Response fields

Field	Description	Example
`correctsearchkey`	A true or false to indicate whether the API key exists	true
`availablecredits`	The number of credits remaining	99999
`lookupservicesup`	A true or false to confirm the service is up and running	true
`state`	A description of the state of the service and / or the API key	Test Key
`currentipvalid`	A true or false to indicate whether the current IP address is authorised to make requests	true
`currentip`	The IP address of the device making this request	81.73.8.29
`overallstatus`	A true or false to indicate the overall status of the service	true
`evaluation`	A true or false to indicate whether the API key is in trial mode	false
`suspended`	A true or false to indicate whether the API key has been suspended	false
`bankvalidation`	The current status of the bank validation feature	Ok
`emailvalidation`	The current status of the email validation feature	Ok
`mobilevalidation`	The current status of the mobile validation feature	Ok
`otpverification`	The current status of the OTP verification feature	Ok
`countriesavailable`	The countries enabled on the API key	ALL
`eircode`	The API key's level of access to the Eircode dataset	No Access
`addressbase`	The API key's level of access to the AddressBase dataset	Full Access
`bankvalidationaccess`	The API key's level of access to the bank validation feature	No Access
`emailvalidationaccess`	The API key's level of access to the email validation feature	No Access
`mobilevalidationaccess`	The API key's level of access to the mobile validation feature	Full Access
`otpverificationaccess`	The API key's level of access to the OTP verification feature	Full 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.