Skip to the content

CleanName

Cleanse a given name and identify gender

Live Demo

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

WSDL
https://webservices.data-8.co.uk/namecleansing.asmx
JSON
https://webservices.data-8.co.uk/NameCleansing/CleanName.json

Description

Tidy the supplied name, standardising casing and punctuation. The gender is derived from the name where possible, and standard formal and informal salutations are generated.

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.
name

name

The name to clean, supplied in four separate fields:

  • Title
  • Forename
  • MiddleName
  • Surname

If you have a name in one field, use the ParseName method instead.

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
Name

Name

A tidied version of the supplied name

Gender

Gender

The gender that has been identified from the name. This can be one of the following values:

  • Male - the name is almost always male, e.g. "Mark"
  • Female - the name is almost always female, e.g. "Lucy"
  • Usually_Male - the name is usually male but can be female, e.g. "Alex"
  • Usually_Female - the name is usually female but can be male, e.g. "Carroll"
  • Unknown - we do not know the gender of this name, or it is ambiguous
FormalSalutation

FormalSalutation

The mode of address that should be used for this person in a formal situation.

InformalSalutation

InformalSalutation

The mode of address that should be used for this person in an informal situation.

Live Demo

name

Title

Forename

MiddleName

Surname

options No options are currently supported by this method
Credits Remaining Today: 5

Sample Code

Start a Free 30 Day Trial Today

Start a free trial today