SSN Verification

Module ID

usa_ssn_verification

info

What do these terms mean?

Module Description

Verifies the Social Security Number associated with an individual

Module Inputs

• First Name (mandatory)
• Last Name (mandatory)
• SSN (mandatory)

Module Configurations

No configurations are supported currently

Module Outputs

The following information is returned in the Results API

Success Scenario

{
  "module": "SSN Verification API",
  "moduleId": "usa_ssn_verification",
  "apiResponse": {
    "status": "success",
    "statusCode": "200",
    "result": 
  		{
        "ssnMatch": "fullMatch"
    	}
	}
}

Understanding the Response

Key	Description	Values Possible
moduleId	ID of the module	<Enter module ID>
module	Name of the module that was setup in your workflow config	<Enter module name>
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

Failure Scenarios

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

{
  "module": "SSN Verification API",
  "moduleId": "usa_ssn_verification",
  "apiResponse": {
    "status": "failure",
    "statusCode": "400",
    "error": "ssn is required"
	}
}

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	When required input is not present
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