SSN verification extension contract reference

The SSN verification extension enables real-time verification of an individual’s Social Security number. This extension can only be used to verify a Social Security number issued by the United States Social Security Administration to U.S. citizens and residents.

You can include this extension when you register an extension app. If you register the extension app using a form, select the Data Verification extension in the form-based UI. Then select a verification type of Social Security Number.

If you register the extension app using an app manifest file, set the extensions.template value in your app manifest to Verify.Version3.SocialSecurityNumber.

This extension has one action. The action name you specify when you register an extension app depends on whether you register the app using a form or using an app manifest file. The app manifest file value listed here appears in the actions.template property.

You provide the details required for action execution when you register an extension app. See Update extension and action settings for information about defining actions using the form-based registration process. See Action schema for information about action properties in the app manifest file.

Action contracts

{
	"socialSecurityNumber": "123-45-6789",
	"firstName": "Francis",
	"lastName": "Beagle",
	"dateOfBirth": "2015-10-09"
}

{
   "verified": true,
   "responseCode": 'VERIFIED',
   "providerResponseCode": 'OK',
}

{
   "verified": false,
   "responseCode": 'NOT_VERIFIED',
   "providerResponseCode": 'FAILED_BECAUSE_REASONS',
}