Data Validation (Older version)

Download OpenAPI specification:Download

Validate the identity data provided by your customers, such as their names, addresses, emails, and more. These APIs allow you to manage validation preferences, and run data validation processes.

A newer version of this API is available. This version is only supported for existing integrations.

Get preferences

Retrieves the configuration for data validation, including which providers (if any) are enabled for each type of data. It must be called from your backend.

SecurityOAuth2: oauth2

Responses

200

400

Bad request

401

Invalid authorization

get/v1/validation-preferences

Request samples

curl -i -X GET \
  https://dv.identity.security/v1/validation-preferences \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

application/json

{"address_providers": [{"provider_name": "GOOGLE",
"enabled": true
}
],
"email_providers": [{"provider_name": "EMAILHIPPO_E1",
"enabled": true
}
],
"phone_number_providers": [{"provider_name": "TELESIGN",
"enabled": true
}
],
"name_providers": [{"provider_name": "MELISSA",
"enabled": true
}
],
"ssn_providers": [{"provider_name": "MELISSA",
"enabled": true
}
],
"date_of_birth_providers": [{"provider_name": "MELISSA",
"enabled": true
}
],
"kba_providers": [{"provider_name": "IDOLOGY",
"enabled": true
}
]
}

Update preferences

Updates the data validation preferences, which controls which providers will be used to process a data validation request. All providers are disabled by default until they've been updated. It must be called from your backend.

SecurityOAuth2: oauth2

Request

Request Body schema: application/json

	Array of objects (AddressConfig) Address validation providers to update
	Array of objects (EmailConfig) Email validation providers to update
	Array of objects (PhoneConfig) Phone number validation providers to update
	Array of objects (NameConfig) Name validation providers to update
	Array of objects (SsnConfig) Social security number validation providers to update
	Array of objects (DateOfBirthConfig) Date of birth validation providers to update
	Array of objects (KbaConfig) All KBA (knowledge-base authentication) validation providers

Responses

200

400

Bad request

put/v1/validation-preferences

Request samples

application/json

{"address_providers": [{"provider_name": "GOOGLE",
"enabled": true
}
],
"email_providers": [{"provider_name": "EMAILHIPPO_E1",
"enabled": true
}
],
"phone_number_providers": [{"provider_name": "TELESIGN",
"enabled": true
}
],
"name_providers": [{"provider_name": "MELISSA",
"enabled": true
}
],
"ssn_providers": [{"provider_name": "MELISSA",
"enabled": true
}
],
"date_of_birth_providers": [{"provider_name": "MELISSA",
"enabled": true
}
],
"kba_providers": [{"provider_name": "IDOLOGY",
"enabled": true
}
]
}

Response samples

application/json

{"address_providers": [{"provider_name": "GOOGLE",
"enabled": true
}
],
"email_providers": [{"provider_name": "EMAILHIPPO_E1",
"enabled": true
}
],
"phone_number_providers": [{"provider_name": "TELESIGN",
"enabled": true
}
],
"name_providers": [{"provider_name": "MELISSA",
"enabled": true
}
],
"ssn_providers": [{"provider_name": "MELISSA",
"enabled": true
}
],
"date_of_birth_providers": [{"provider_name": "MELISSA",
"enabled": true
}
],
"kba_providers": [{"provider_name": "IDOLOGY",
"enabled": true
}
]
}

Validate data

Validate identity data provided by the user. Validations will be performed using the providers that were enabled for the requested data type, and the response will reflect the aggregated result. It must be called from the client backend. If Idology is enabled as a KBA provider, name and address are required.

SecurityOAuth2: oauth2

Request

Request Body schema: application/json

email	string User's email address
phone_number	string User's phone number (only digits, such as `12125556677`)
name	string User's full name
address	string User's full address (in a single line)
ssn	string User's social security number
date_of_birth	string User's date of birth, as yyyymmdd

Responses

200

400

Bad request

401

Invalid authorization

post/v1/api/validate-data

Request samples

application/json

{"email": "user@email.com",
"phone_number": "12125556677",
"name": "Holly Smith",
"address": "1234 Snowy Ridge Road Indianapolis, IN 5678",
"ssn": "123456789",
"date_of_birth": "19800101"
}

Response samples

application/json

{"mock_data": true,
"email": {"value": "user@email.com",
"result_data": [{"raw_data": { },
"provider_name": "EMAILHIPPO_E1"
}
]
},
"phone_number": {"value": "12125556677",
"result_data": [{"raw_data": { },
"provider_name": "TELESIGN"
}
]
},
"address": {"value": "1234 Snowy Ridge Road Indianapolis, IN 5678",
"result_data": [{"raw_data": { },
"provider_name": "GOOGLE"
}
]
},
"name": {"value": "Holly Smith",
"result_data": [{"raw_data": { },
"provider_name": "MELISSA"
}
]
},
"ssn": {"value": "123456789",
"result_data": [{"raw_data": { },
"provider_name": "MELISSA"
}
]
},
"date_of_birth": {"value": "19800101",
"result_data": [{"raw_data": { },
"provider_name": "MELISSA"
}
]
},
"kba": {"result_data": [{"id": "string",
"raw_data": { },
"provider_name": "IDOLOGY"
}
]
}
}

Submit KBA answers

Submit answers provided by the user for Idology's questions, which were returned in the /validate-data response.

SecurityOAuth2: oauth2

Request

Request Body schema: application/json

id	string ID of the validation request, which was returned in the KBA result data of the `/validate-data` response
	Array of objects User's answers

Responses

200

400

Bad request

401

Invalid authorization

post/v1/api/validate-data/idology-idliveq-answers

Request samples

application/json

{"id": "12345678",
"answers": [{"type": "city.of.residence",
"answer": "NEW YORK"
}
]
}

Response samples

application/json

{"id": "string",
"raw_data": { }
}