Soft ID Verification
Soft ID Verification (a.k.a. Soft KYC, eIDV, 2x2 verification) is a feature that enables cross-checking data against official/registry sources. The feature functionality is simple and straightforward: all you need to do is to provide the individual personal details and retrieve the results if it match or not.
Generate requests
The request must contain basic auth headers where username is API key and password is API secret. Two main endpoints are used to list/retrieve and perform Soft ID Verification.
Perform Soft ID verification check
Examples
- Official Civil Register and Consumer Credit - US_1
- Official Social Security (enables SSN verification) - US_4
- Credit and US Identity Graph - US_15
Send a HTTP POST request to: https://ivs.idenfy.com/api/v2/registry-center-checks/
Possible values:
JSON key | Required | Type | Explanation/Possible values |
---|---|---|---|
firstName | Yes | String | First name of the person. |
lastName | Yes | String | Last name of the person. |
state | Yes | String | - Possible values: AL , AZ , AR , CA , CO , CT , DE , DC , FL , GA , ID , IL , IN , IA , KS , KY , LA , ME , MD , MA , MI , MN , MS , MO , MT , NE , NV , NH , NJ , NM , NY , NC , ND , OH , OK , OR , PA , RI , SC , SD , TN , TX , UT , VT , VA , WA , WV , WI , WY , AK , HI . |
database | Yes | String | Database type, provide US_1 for this request. |
dob | No | String | - Format: YYYY-MM-DD; - Lowest value: 1900-01-02. |
middleName | No | String | Middle name of the person. |
yob | No | Integer | - Possible values: [1901..2050]. |
gender | No | String | - Possible values: MALE /FEMALE . |
address | No | String | Address of the person. |
city | No | String | City of the person. |
zip | No | String | Zip code of the area, numbers allowed only. |
phone | No | String | Format should include country, area and telephone number, e.g.: "+1 (416) 555-5678" . |
maritalStatus | No | String | - Possible values: MARRIED /NOT_MARRIED . |
- Request
- Response
{
"firstName": "John",
"lastName": "Smith",
"state": "CA",
"database": "US_1",
"middleName": "Adrian",
"yob": 1980,
"gender": "MALE",
"city": "San Jose",
"zip": "95128"
}
{
"id": "5da1a4b8-9d5b-425f-9b84-8511c1fff2fe",
"firstName": "John",
"lastName": "Smith",
"state": "CA",
"middleName": "Adrian",
"dob": null,
"yob": 1980,
"gender": "MALE",
"address": null,
"city": "San Jose",
"zip": "95128",
"phone": null,
"maritalStatus": null,
"firstNameStatus": "MATCH",
"lastNameStatus": "MATCH",
"stateStatus": "MATCH",
"middleNameStatus": "NO_DATA",
"dobStatus": null,
"yobStatus": "MATCH",
"genderStatus": "MATCH",
"addressStatus": null,
"cityStatus": "MATCH",
"zipStatus": "NO_MATCH",
"phoneStatus": null,
"maritalStatusStatus": null,
"database": "US_1"
}
Send a HTTP POST request to: https://ivs.idenfy.com/api/v2/registry-center-checks/
Possible values:
JSON key | Required | Type | Explanation/Possible values |
---|---|---|---|
firstName | Yes | String | First name of the person |
lastName | Yes | String | Last name of the person |
state | Yes | String | - Possible values: AL , AZ , AR , CA , CO , CT , DE , DC , FL , GA , ID , IL , IN , IA , KS , KY , LA , ME , MD , MA , MI , MN , MS , MO , MT , NE , NV , NH , NJ , NM , NY , NC , ND , OH , OK , OR , PA , RI , SC , SD , TN , TX , UT , VT , VA , WA , WV , WI , WY , AK , HI . |
database | Yes | String | Database type, provide US_4 for this request |
idNum | No | String | Full SSN number or only last 4 digits |
dob | No | String | - Format: YYYY-MM-DD; - Lowest value: 1900-01-02. |
yob | No | Integer | - Possible values: [1901..2050]. |
middleName | No | String | Middle name of the person. |
address | No | String | Address of the person. |
city | No | String | City of the person. |
zip | No | String | Zip code of the area, numbers allowed only. |
phone | No | String | Format should include country, area and telephone number, e.g.: "+1 (416) 555-5678" |
- Request
- Response
{
"firstName": "John",
"lastName": "Smith",
"state": "CA",
"database": "US_4",
"yob": 1980,
"dob": "1990-09-09",
"city": "San Jose",
"zip": "95128",
"phone": "+1 (416) 555-5678",
"id_num": "897884526"
}
{
"id": "077997fe-791c-4181-a097-8a48dfdf51fc",
"firstName": "John",
"lastName": "Smith",
"state": "CA",
"middleName": null,
"dob": "1990-09-09",
"yob": 1980,
"address": null,
"city": "San Jose",
"zip": "95128",
"phone": "+14165555678",
"idNum": "897884526",
"firstNameStatus": "MATCH",
"lastNameStatus": "MATCH",
"middleNameStatus": null,
"dobStatus": "NO_MATCH",
"yobStatus": null,
"addressStatus": null,
"cityStatus": "MATCH",
"zipStatus": "NO_MATCH",
"phoneStatus": "NO_MATCH",
"idNumStatus": "NO_MATCH",
"database": "US_4"
}
Send a HTTP POST request to: https://ivs.idenfy.com/api/v2/registry-center-checks/
Either dob
or idNum
(full SSN or last 4 digits) is mandatory to provide.
Possible values:
JSON key | Required | Type | Explanation/Possible values |
---|---|---|---|
firstName | Yes | String | First name of the person. |
lastName | Yes | String | Last name of the person. |
database | Yes | String | Database type, provide US_15 for this request. |
dob | Yes (if idNum is not provided) | String | - Format: YYYY-MM-DD; - Lowest value: 1900-01-02. |
idNum | Yes (if dob is not provided) | String | Full SSN number or only last 4 digits. |
state | No | String | - Possible values: AL , AZ , AR , CA , CO , CT , DE , DC , FL , GA , ID , IL , IN , IA , KS , KY , LA , ME , MD , MA , MI , MN , MS , MO , MT , NE , NV , NH , NJ , NM , NY , NC , ND , OH , OK , OR , PA , RI , SC , SD , TN , TX , UT , VT , VA , WA , WV , WI , WY , AK , HI . |
middleName | No | String | Middle name of the person. |
yob | No | Integer | - Possible values: [1901..2050]. |
address1 | No | String | Street/avenue/boulvar, e.g.: "Benson str", "124th East Ave". |
address2 | No | String | Number of apartment/house, e.g.: "3914", "12272". |
city | No | String | City of the person. |
zip | No | String | Zip code of the area, numbers allowed only. |
phone | No | String | Format should include country, area and telephone number, e.g.: "+1 (416) 555-5678" . |
email | No | String | Email address of the person. |
- Request
- Response
{
"firstName": "John",
"lastName": "Smith",
"state": "CA",
"database": "US_15",
"yob": 1980,
"dob": "1990-09-09",
"city": "San Jose",
"address1": "Benson str",
"address2": "3914",
"zip": "95128",
"phone": "+1 (416) 555-5678",
"id_num": "897884526",
"email": "example.email@domain.com"
}
{
"id": "94f63296-7f3a-46d2-8558-ebd89224cb19",
"firstName": "John",
"lastName": "Smith",
"middleName": null,
"dob": "1990-09-09",
"yob": 1980,
"address1": "Benson str",
"address2": "3914",
"city": "San Jose",
"state": "CA",
"zip": "95128",
"idNum": "897884526",
"phone": "+14165555678",
"email": "example.email@gmail.com",
"firstNameStatus": "NO_MATCH",
"lastNameStatus": "NO_MATCH",
"middleNameStatus": null,
"dobStatus": "NO_MATCH",
"yobStatus": null,
"address1Status": "NO_MATCH",
"address2Status": "NO_MATCH",
"cityStatus": "NO_MATCH",
"stateStatus": "NO_MATCH",
"zipStatus": "NO_MATCH",
"idNumStatus": "NO_MATCH",
"phoneStatus": "NO_MATCH",
"emailStatus": "NO_MATCH",
"database": "US_15"
}
List/retrieve Soft ID verification checks
To retrieve all performed Soft ID verification checks, send GET request at: https://ivs.idenfy.com/api/v2/registry-center-checks/
Response example
Toggle to open
[
{
"id": "13c7c069-d4d8-405b-a442-3fe483068ca5",
"firstName": "Jay Alan",
"lastName": "Neander",
"state": "IL",
"middleName": null,
"dob": "1981-08-31",
"yob": null,
"gender": "MALE",
"address": null,
"city": "Chocago",
"zip": "60646",
"phone": null,
"maritalStatus": "MARRIED",
"firstNameStatus": "NO_MATCH",
"lastNameStatus": "NO_MATCH",
"stateStatus": "NO_MATCH",
"middleNameStatus": null,
"dobStatus": "NO_MATCH",
"yobStatus": null,
"genderStatus": "NO_MATCH",
"addressStatus": null,
"cityStatus": "NO_MATCH",
"zipStatus": "NO_MATCH",
"phoneStatus": null,
"maritalStatusStatus": "NO_DATA",
"database": "US_1"
},
{
"id": "83cb0614-ff58-41e6-afac-6f24b8ff0072",
"firstName": "Jay Adomas",
"lastName": "NEander",
"state": "IL",
"middleName": null,
"dob": null,
"yob": null,
"address": null,
"city": null,
"zip": null,
"phone": null,
"idNum": null,
"firstNameStatus": "MATCH",
"lastNameStatus": "MATCH",
"middleNameStatus": null,
"dobStatus": null,
"yobStatus": null,
"addressStatus": null,
"cityStatus": null,
"zipStatus": null,
"phoneStatus": null,
"idNumStatus": null,
"database": "US_4"
},
{
"id": "a86aff0a-95a2-46a3-a9fa-27fabfef37f6",
"firstName": "Thomas R",
"lastName": "Ahern",
"middleName": null,
"dob": "1979-02-24",
"yob": 1979,
"address1": null,
"address2": null,
"city": null,
"state": "NY",
"zip": null,
"idNum": null,
"phone": null,
"email": null,
"firstNameStatus": "MATCH",
"lastNameStatus": "MATCH",
"middleNameStatus": null,
"dobStatus": "MATCH",
"yobStatus": null,
"address1Status": null,
"address2Status": null,
"cityStatus": null,
"stateStatus": "MATCH",
"zipStatus": null,
"idNumStatus": null,
"phoneStatus": null,
"emailStatus": null,
"database": "US_15"
}
]
Results
Please note that only fields with a corresponding *Status
suffix are verified against the database, and their values indicate the outcome of this verification. Fields without a *Status
suffix are informational and reflect the data provided in the request.
The results are based on each value and there are no overall results *Status
: Appended to the name of each request information field (e.g., firstNameStatus
, lastNameStatus
, maritalStatusStatus
), these keys indicate the verification status of the corresponding data. Here are the possible results:
- Match - More than 85% Match.
- Partial Match - Less than 85% but greater than 50%.
- No Match - Less than 50%.
- Invalid - invalid format information provided.
- No Input - The requested input is blank data.
- No Data - No Match data was obtained from the source.
null
- No input.