API Request (v1)

{
	"identity": {
		"firstName": "Gabriel",
		"lastName": "Mitchell",
		"ssn": "900000001"
	},
	"emailAddress": "aaron53@adventure-works.com",
	"deviceId": "1674238924",
	"geoLocation": {
		"latitude": "18.375",
		"longitude": "28.375"
	},
	"mobileNumber": "9735550195",
	"address": {
		"line1": "1197 Santa Barbara",
		"city": "Santa Monica",
		"state": "CA",
		"zipCode": "90401"
	}
}

Request Field Information

Field Name Req Type Validations Description
identity yes obj not-empty The container for the Identity information
     identity.firstName yes string max-length=75 First Name
     identity.lastName yes string max-length=75 Last Name
     identity.ssn yes string length=10 or length=4 The Full SSN or Last 4 of SSN. When specifying the last 4, the dob field is required
     identity.dob cond* string exact-length=10 The DOB in of the format [MM/dd/yyyy] or [MM-dd-yyyy]. * The DOB field is required when using the SSN last four.
email no string max-length=320 valid-email A valid Email Address
mobileNumber no string max-length=10 numbers-only 10 digit Mobile Number
address no obj optional The container for the Address information
     address.line1 yes string max-length=150 The Address Line 1
     address.line2 no string max-length=150 The Address Line 2
     address.city yes string max-length=150 The City
     address.state yes string exact-length=2 valid-us-state The 2 character State code
     address.zipCode yes string exact-length=5 The 5 digit Zip Code
deviceId no string max-length=100 The DeviceId
geoLocation no obj optional The container for the Geo Location information
     geoLocation.latitude yes decimal(20,18) pre=2 scale=18, valid-latitude [-90 to 90] with a precision of 18
     geoLocation.longitude yes decimal(21,18) pre=3, scale=18, valid-longitude [-180 to 180] with a precision of 18

Request data will be stored and retained as per Ingo’s security and data retention policies