Parsing

Parse the personal and business names

This endpoint will parse the personal and business names and other terms in the name data field into their component parts. These parsed name elements are then subsequently available to other automated operations such as name matching, name standardization, or multiple-record name consolidation.

post/v1/names/parse

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/names/parse
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Headers

X-Request-Idstring

The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.

Request body

namestring required

The full name that needs to be parsed. It cannot be null or blank.

Example request

{
  "name": "Mr. Jack Lauren & Daniel Smith",
  "options": {
    "parseNaturalOrderPersonalNames": true
  }
}

Response

Parsed Successfully!

Example response

{
  "response": {
    "status": "OK",
    "result": {
      "accountDescription": "Business Account",
      "names": "Mr. John Smith",
      "parsedAs": "personal",
      "firmConjunction": "&",
      "firmName": "Acme Corporation",
      "firmSuffix": "LLC",
      "isFirm": "true",
      "conjunction": "and",
      "cultureCode": "en-US",
      "cultureCodeUsedToParse": "EN-US",
      "firstName": "Jane",
      "generalSuffix": "Sr.",
      "isParsed": "true",
      "isPersonal": "true",
      "isReverseOrder": "false",
      "lastName": "Smith",
      "leadingData": "Mr.",
      "maturitySuffix": "Jr.",
      "middleName": "M.",
      "name": "Mr. John Smith",
      "parsingScore": "95",
      "secondaryLastName": "Doe",
      "titleOfRespect": "Mr.",
      "trailingData": "PhD",
      "conjunction2": "&",
      "conjunction3": "&",
      "firmName2": "Acme Corporation",
      "firmSuffix2": "LLC",
      "firstName2": "John",
      "firstName3": "Sarah",
      "generalSuffix2": "Jr.",
      "generalSuffix3": "Sr.",
      "isConjoined": "true",
      "lastName2": "Smith",
      "lastName3": "Doe",
      "maturitySuffix2": "II",
      "maturitySuffix3": "III",
      "middleName2": "Allen",
      "middleName3": "Grace",
      "titleOfRespect2": "Dr.",
      "titleOfRespect3": "Mrs."
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.