Skip to main content
Requirements:
  • API key pair
  • Soft ID settings enabled (configured by iDenfy staff)
  • Finances added to your environment

​
Generate request

POST https://ivs.idenfy.com/api/v2/registry-center-checks/
Authorization: Basic {API_KEY}:{API_SECRET}
Content-Type: application/json
Either dob or idNum (full SSN or last 4 digits) is mandatory.

​
Request parameters

First name of the person to verify.
Last name of the person to verify.
Database identifier to check against (e.g., US_15).
Date of birth in YYYY-MM-DD format. Required if idNum is not provided.
Full SSN or last 4 digits. Required if dob is not provided.
Year of birth.
State code (e.g., CA).
City name.
Primary address line.
Secondary address line.
Postal/ZIP code.
Phone number.
Email address.

​
Request example

{
  "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"
}

​
Response example

{
  "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

GET https://ivs.idenfy.com/api/v2/registry-center-checks/
Authorization: Basic {API_KEY}:{API_SECRET}
Understanding response fields:In the response data, fields are categorized into two types:
  1. Informational fields: Names like firstName, lastName, etc. These directly mirror the data you provided in the request and are not verified against the database.
  2. Status fields: Names ending with *Status, like firstNameStatus, lastNameStatus. These indicate the outcome of verifying the corresponding informational field against the database.
Verification is performed individually for each applicable field; there is no single overall verification status for the entire request.

​
Possible status values

StatusDescriptionConfidence Level
MatchThe provided data closely matches the database record.85% or higher
Partial MatchThe provided data partially matches the database record.Between 50% and 85%
No MatchThe provided data does not match the database record or the match is very weak.50% or lower
InvalidThe format of the provided input data was invalid.N/A
No InputThe corresponding input field was provided but contained blank or empty data.N/A
No DataNo corresponding data was found in the database source for comparison.N/A
nullThe corresponding input field was not included in the request or was explicitly null.N/A

​
Response example

[
  {
    "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": "Chicago",
    "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"
  }
]