Skip to the content

FindYearOfBirth

Retrieves the year of birth of an individual.

Live Demo

To connect to this service you'll need to use one of these endpoints:

JSON
Open API
SOAP

Description

Gets the year of birth of the selected individual.

Note that the year of birth returned may be missing if the supplied individual could not be located on our data sources. The returned data may be estimated - in these cases the data has been shown to be accurate to within 5 years in 90% of cases.

Credit Usage

Each request to this method consumes 1 NameAppend credit.

Parameters

The following parameters can be supplied to this method

username

username

See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix apikey-, e.g. apikey-ABCD-1234-EFGH-5678
password

password

If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
record

record

Details of the name and address to check against the electoral roll. This value as the following properties:

  • Name - set the Title, Forename, MiddleName and Surname properties to indicate the name to validate
  • Address - set the Lines property to the address lines to validate

Advanced Options

The following options can be specified as part of the option parameter. Each option is specified as a key/value pair. The list of available names is shown below, along with a description of the allowable values for that name.

Common Options
Name Description
ApplicationName

ApplicationName

Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard

Results

This method returns an object containing the following fields:

Status

Status

Indicates whether the method call was successful, or if some error occurred. If the Success field is true, the other results described below can be used to get the results of the method. If Success is false, some error occurred in calling the method, such as the authentication failed or the account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored
YearOfBirth

YearOfBirth

Estimated year of birth, where available

Result

Result

Indicates if the person has been verified to be living at the requested address.

MatchLevel

MatchLevel

Indicates the level of match that was made to the electoral roll. Will be one of the following values:

  • Forename
  • Initial
  • Surname
  • Premise
  • None

Live Demo

record

Name

Sorry, this parameter type is not currently supported in Live Demo

Address

Sorry, this parameter type is not currently supported in Live Demo
options
Name Value
Common Options

Sample Code