Skip to main content

Address and DOB Verification

Module ID

Name of the Module
usa_address_dob_verification

Module Description

Verify the address and the date of birth of an individual against the name.

Module Inputs

ALl of the following inputs are mandatory.

  • First Name
  • Last Name
  • Street Name
  • City
  • State Code
  • Zip
  • Date of Birth

Module Outputs

The following section provides the sample and the corresponding details of the various responses you can expect from the module.

Success Response Sample

You will receive a success response in a format similar to the following code sample if the request is correct.
  {
"module": "Address & DOB Verfication",
"moduleId": "usa_address_dob_verification",
"apiResponse": {
"status": "success",
"statusCode": "200",
"result": {
"details": {
"addressMatch": "fullMatch",
"dobMatch": "fullMatch"
},
"summary": {
"action": "pass",
"details": []
}
}
}
}

Here,

  1. addressMatch: Match on name + address

fullMatch: Exact match on address field partialMatch: Partial match on address field noMatch: No match on address field notFound: No record for name, as well as address dobMatch: Match on name + dob

  1. fullMatch: Exact match on dob field partialMatch: Partial match on dob field noMatch: No match on dob field notFound: No record for name, as well as dob

Error Response Samples

You will receive an error response in a format similar to the following code sample if the request is incorrect.
  {
"module": "Address & DOB Verfication",
"moduleId": "usa_address_dob_verification",
"apiResponse": {
"status": "failure",
"statusCode": "400",
"error": "streetName is required"
}
}

Possible Error Codes in the Summary Action:

  • 011: Address is not matching
  • 012: DoB is not matching
  • 013: Address and DoB are not found
Was this helpful?
Ask AIBeta
Hi! How can I help?
Ask me anything about HyperVerge products, APIs, and SDKs.
Try asking: