Name Match

Determine whether a subject’s name matches the name extracted from their document in GBG Go, accounting for nicknames and abbreviations.

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 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. If no document extraction data is available, then the module returns an Error outcome.

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 and a document image to the Name Match module for processing. A Document Extraction module earlier in the journey reads the name from the document image. The Name Match module then compares it with the subject’s name.

JSON

{
  "resourceId": "<resourceId>",
  "context": {
    "subject": {
      "identity": {
        "firstName": "AROHA",
        "lastNames": ["WATA"],
        "middleNames": ["MERE TERESA"]
      },
      "documents": [
        {
          "side1Image": "<base64-encoded string>"
        }
      ]
    }
  }
}

Field	Required	Description
identity.firstName	Yes	First name of the subject.
identity.lastNames	Yes	Array containing the last names of the subject.
identity.middleNames	No	Array containing the middle names of the subject.
documents[].side1Image	Yes	A base64-encoded string representing the image of the front side of the document.

Sample response

The following is a sample response where the subject’s name matches the name extracted from the document, which returns an IsNameMatch outcome.

JSON

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

Related guides and tutorials

The following guides and tutorials use this module or explain how to configure it.

How to configure module outcomes in Go

Customise default module outcomes.

How to configure evaluation decisions in Go

Customise evaluation decisions.