Text Match

Module Description

Matches the text between given pairs of fields

Module Inputs

• Name1, Name2
• Address1, Address2 ...

Module Configurations

No configurations are supported currently

Module Outputs

The following information is returned in the Results API

Success Scenario

{
  "module": "Text Match API",
  "moduleId": "text_match_api",
  "apiResponse": {
    "status": "success",
    "statusCode": "200",
    "result": {
      "dob": true,
      "name": true,
      "all": true
    }
  }
}

Understanding the Response

Key	Description	Values Possible
moduleId	ID of the module	text_match_api
module	Name of the module that was setup in your workflow config	Text Match API
apiResponse	The API results provided by HyperVerge's backend. If there were multiple attempts made by the user, this key will contain the latest attempt	JSON

Understanding 'apiResponse'

Key	Description	Values Possible
result.field	The match result of the field. Here, field corresponds to any of the fields provided in the input	true/false

Failure Scenarios

Below is the response in Results API for a typical error scenario.

{
  "module": "Text Match API",
  "moduleId": "text_match_api",
  "apiResponse": {
    "status": "failure",
    "statusCode": "400",
    "error": "invalid dob value1"
  }
}

List of Errors Possible

Below are all the errors possible in this module. The 'statusCode' is present under apiResponse

StatusCode	Summary	Description
400	Input error	Error in the format of input keys or the request body
429	Rate limit error	When the number of requests per minute has crossed the set limit for your credentials
5xx	Server Error	Please reachout to HyperVerge