Skip to content
On this page

ID Check Name Lookup ​

Compatible Cases

About the service ​

IDCheckNameLookupService is a name verification service. It checks that the name is not salacious, incomplete or randomly typed characters.

Product Code: W2-DATA-SALACIOUS_NAME-023

Does this service leave a credit search Footprint? No

Request ​

The following properties pertain to this service.

Property NameTypeOptional/MandatoryNotes
NameQueryStringMandatory*Default field used for matching, can be blank if Forename/MiddleNames/Surname used instead
ForenameStringOptionalUsed when NameQuery is not specified
MiddleNamesStringOptionalUsed when NameQuery is not specified
SurnameStringOptionalUsed when NameQuery is not specified

Validation ​

It is mandatory to provide at least one of the above name fields.

NameQuery will take precedence over Forename, MiddleNames, and Surname.

If Name Query has no value, a combination of Forename, MiddleNames, and Surname will be used instead.

Response ​

ID Check Name Lookup example response:

json
"idCheckNameLookupResult": {
  "validationResultReason": "The name is not salacious"
}

Sandbox ​

To use sandbox the following example request can be used.

Remember to include the W2 provided API key in the Authorization Header.

json
{
    "Bundle": "IDCheckNameLookup",
    "Data": {
        "NameQuery": "John Smith"
    },
    "Options": {
        "Sandbox": "true"
    },
    "ClientReference": "your-client-reference"
}

If the Sandbox query option is set to "true" the following entries shown in Sandbox Examples below will be returned in the ServiceResult

Sandbox Examples ​

Example Response for "John Smith":

json
"idCheckNameLookupResult": {
  "validationResultReason": "The name is not salacious"
}

The corresponding ServiceTransactions will show the following properties:

PropertyValue
HaltTriggeredFalse
ServiceTransactionResult- Success
ServiceInterpretResult- Pass
ServiceTransactionResultMessage"This call was generated using sandbox mode"
ValidationResult- NotApplicable

Example Response for "Mickey Mouse":

json
"idCheckNameLookupResult": {
  "validationResultReason": "The name is flagged against our blacklist of known salacious words"
}

The corresponding ServiceTransactions will show the following properties:

PropertyValue
HaltTriggeredFalse
ServiceTransactionResult- Success
ServiceInterpretResult- Inconclusive
ServiceTransactionResultMessage"This call was generated using sandbox mode"
ValidationResult- NotApplicable

Example Response for "aabbccddee":

json
"idCheckNameLookupResult": {
	"validationResultReason": "The name appears to have been entered by hitting random keys"
}

The corresponding ServiceTransactions will show the following properties:

PropertyValue
HaltTriggeredFalse
ServiceTransactionResult- Success
ServiceInterpretResult- Inconclusive
ServiceTransactionResultMessage"This call was generated using sandbox mode"
ValidationResult- NotApplicable

The corresponding IDCheckNameLookupResult will show the following properties:

PropertyValue
HaltTriggeredFalse
ServiceTransactionResult- Success
ServiceInterpretResult- Pass
ServiceTransactionResultMessage"This call was generated using sandbox mode"
ValidationResult- NotApplicable