Social Security Number Verification
Overview
Verify your user's social security number with BlockID Social Security Number verification. Using our API, developers can quickly validate a user's social security number, ensuring that the SSN matches government records. Other information, such as the user's name and address, can also be verified.
Perform a Social Security Number Verification
To perform a social security verification, you will need to provide some required information for the type of verification performed. A social security verification requires the user's social security number, while visual face comparison and face liveness verifications require a user's facial photos.
Parameters
You can find your tenant information on the 1Kosmos Developer Dashboard
tenantInfo
dvcID: idverify (dvcID) numberdns: tenant domainlicenseKey: tenant license key
document:
id: identification number for internal trackingtype: ssn_verifyssn: social security number to verify
Request Format
All requests are plug-and-play, not copy-paste. Please ensure that you are replacing the parameters in the request format below with the actual values
First, we need to create a new session for the social security number verification. We've outlined an example request format below.
- NodeJS SDK
- Initialize the SDK and set tenant info
const BIDVerifyDocument = require('blockid-nodejs-helpers/BIDVerifyDocument');
const dvcId = "<dvcId>";
const document = {
"id": "<id>",
"type": "ssn_verify",
"ssn": "<ssn>"
};
const verifications = ["ssn_verify"];
const tenantInfo = {
dns: "blockid-trial.1kosmos.net",
communityName: "default",
licenseKey: "14cd5e85-a422-442a-9a8c-fc6e56082576"
}
- Perform the social security number verification
async function verifySSN(tenantInfo, dvcId, verifications, document) {
let ssnResponse = await BIDVerifyDocument.verifyDocument(tenantInfo, dvcId, verifications, document);
console.log('ssnResponse:::', JSON.stringify(ssnResponse));
}
verifySSN(tenantInfo, dvcId, verifications, document);
Example Request
Dummy information is provided in this example
- NodeJS SDK
const BIDVerifyDocument = require('blockid-nodejs-helpers/BIDVerifyDocument');
const dvcId = "devx_5701be37-ea59-45bb-ab17-000000000000";
const document = {
"id": "112312312",
"type": "ssn_verify",
"ssn": "123456789"
};
const verifications = ["ssn_verify"];
const tenantInfo = {
dns: "blockid-trial.1kosmos.net",
communityName: "default",
licenseKey: "14cd5e85-a422-442a-9a8c-000000000000"
}
async function verifySSN(tenantInfo, dvcId, verifications, document) {
let ssnResponse = await BIDVerifyDocument.verifyDocument(tenantInfo, dvcId, verifications, document);
console.log('ssnResponse:::', JSON.stringify(ssnResponse));
}
verifySSN(tenantInfo, dvcId, verifications, document);
Server Responses
A successful request will return information about the identity linked to the social security number entered.
Example Server Responses
- 200
- 401
- 403
- 404
{
"docId": "112312312",
"docType": "ssn_verify",
"certifications": [
{
"docType": "ssn_verify",
"docId": "112312312",
"type": "ssn_verify",
"ts": 1658755038503,
"verified": true,
"result": {},
"metadata": {
"verifiedPeople": [
{
"firstName": {
"value": "Giorgi",
"matchTypeCode": "NA"
},
"middleName": {
"value": "",
"matchTypeCode": "NA"
},
"lastName": {
"value": "Papidze",
"matchTypeCode": "NA"
},
"ssn": {
"value": "805-14-XXXX",
"matchTypeCode": "Match"
},
"dateOfBirth": {
"month": {
"value": "4",
"matchTypeCode": "NA"
},
"day": {
"value": "22",
"matchTypeCode": "NA"
},
"year": {
"value": "1993",
"matchTypeCode": "NA"
}
},
"age": {
"value": "29",
"matchTypeCode": "NA"
},
"addresses": [
{
"value": "8180 Mccullough Dr; New Castle, DE 19720-2066",
"matchTypeCode": "NA"
}
],
"emails": [],
"phones": [],
"dateofDeath": null,
"indicators": {
"hasBankruptcyRecords": 0,
"hasBusinessRecords": 0,
"hasDivorceRecords": 0,
"hasDomainsRecords": 0,
"hasEvictionsRecords": 0,
"hasFeinRecords": 0,
"hasForeclosuresRecords": 0,
"hasJudgmentRecords": 0,
"hasLienRecords": 0,
"hasMarriageRecords": 0,
"hasProfessionalLicenseRecords": 0,
"hasPropertyRecords": 0,
"hasVehicleRegistrationsRecords": 0,
"hasWorkplaceRecords": 0,
"hasDeaRecords": 0,
"hasPropertyV2Records": 0,
"hasUccRecords": 0,
"hasMobilePhones": 0,
"hasLandLines": 0,
"hasEmails": 0,
"hasAddresses": 1,
"hasCurrentAddresses": 1,
"hasHistoricalAddresses": 0,
"hasDebtRecords": 0
},
"isPublic": false,
"isOptedOut": false
},
{
"firstName": {
"value": "Aaron",
"matchTypeCode": "NA"
},
"middleName": {
"value": "",
"matchTypeCode": "NA"
},
"lastName": {
"value": "Randaall",
"matchTypeCode": "NA"
},
"ssn": {
"value": "805-14-XXXX",
"matchTypeCode": "Match"
},
"dateOfBirth": {
"month": {
"value": "10",
"matchTypeCode": "NA"
},
"day": {
"value": "14",
"matchTypeCode": "NA"
},
"year": {
"value": "1983",
"matchTypeCode": "NA"
}
},
"age": {
"value": "38",
"matchTypeCode": "NA"
},
"addresses": [
{
"value": "21 Libby Rd; Bedford, OH 44146-1208",
"matchTypeCode": "NA"
}
],
"emails": [],
"phones": [],
"dateofDeath": null,
"indicators": {
"hasBankruptcyRecords": 0,
"hasBusinessRecords": 0,
"hasDivorceRecords": 0,
"hasDomainsRecords": 0,
"hasEvictionsRecords": 0,
"hasFeinRecords": 0,
"hasForeclosuresRecords": 0,
"hasJudgmentRecords": 0,
"hasLienRecords": 0,
"hasMarriageRecords": 0,
"hasProfessionalLicenseRecords": 0,
"hasPropertyRecords": 0,
"hasVehicleRegistrationsRecords": 0,
"hasWorkplaceRecords": 0,
"hasDeaRecords": 0,
"hasPropertyV2Records": 0,
"hasUccRecords": 0,
"hasMobilePhones": 0,
"hasLandLines": 0,
"hasEmails": 0,
"hasAddresses": 1,
"hasCurrentAddresses": 1,
"hasHistoricalAddresses": 0,
"hasDebtRecords": 0
},
"isPublic": false,
"isOptedOut": false
}
],
"fraudAlerts": [],
"identityVerified": true,
"pagination": {
"currentPageNumber": 1,
"resultsPerPage": 10,
"totalPages": 1
},
"databaseQueryInfo": [],
"searchCriteria": [],
"totalRequestExecutionTimeMs": 209,
"requestId": "1cc1035f-ca58-44bb-aeb1-75eddabbcc09",
"requestTime": "2022-07-25T06:17:18.8796555-07:00",
"isError": false,
"error": {
"inputErrors": [],
"warnings": []
}
},
}
]
}
The API accepted the request and returned identity information for the provided social security number.
{
"error_code": 401,
"message":"Unauthorized"
}
The request was not authorized.
{
"error_code": 403,
"message":"Forbidden"
}
The user does not have appropriate permission to make this request. Please get in touch with your tenant or community administrator for support.
{
"error_code": 404,
"message":"Unable to load tenant/community"
}
If the user encounters the message "Unable to load tenant/community" during the SSN verification process, they can access the tenant and license key information configured on their user dashboard.