Name Match

The Name Match module determines whether the subject’s name matches the name extracted from a document. The comparison accounts for nicknames and abbreviations of the target name, for example matching “Bill” against an extracted “William”. This module is typically placed after a Document Extraction or Document Verification module in a journey, since it requires extracted document data as an input. Required inputs: Full name, primary document extraction data.

Capabilities

Capability	Type	Range/Values	Description
Does name match	Boolean	`true`, `false`	Whether the input name matches the name extracted from the document.
Match score	Integer	0–100	The confidence score of the name match. Higher values indicate a closer match.

Default outcomes

The outcome logic uses only the boolean match result. The match score is available for custom evaluation rules, for example to set a minimum confidence threshold.

Outcome	Condition	Description
`IsNameMatch`	Does name match is `true`	The subject’s name matches the name extracted from the document.
`IsNotNameMatch`	Does name match is `false`	The subject’s name doesn’t match the extracted name.
`Error`	Default (no conditions matched)	An error occurred during the name matching process.

Input payload

The following is a sample payload used to submit subject details to the Name Match module for processing.

JSON

{
  "resourceId": "<resourceId>",
  "context": {
    "subject": {
      "identity": {
        "firstName": "John",
        "lastNames": ["Doe"]
      }
    }
  }
}

Field	Required	Description
`identity.firstName`	Yes	First name of the subject.
`identity.lastNames`	Yes	Array containing the last names of the subject.

Sample response

The following is a sample response for a successful name match.

JSON

{
  "response": {
    "advice": {
      "contains": {
        "name_matched": true
      }
    },
    "outcome": "IsNameMatch"
  }
}

Get Started

Platform

Developer Integration

Digital IDs

Resources

Capabilities

Default outcomes

Input payload

Sample response

​Capabilities

​Default outcomes

​Input payload

​Sample response

Capabilities

Default outcomes

Input payload

Sample response