IDV Match

POST /v1/IdentityVerification/IDVMatch

Parameters

Name	In	Type	Required
`sendSmsVerification`	query	boolean	optional
`performKnowledgeBasedAuthentication`	query	boolean	optional
`traceId`	query	string	optional

Request body

optional (15)

Name	Type	Required
`socialSecurityNumber`	string	optional
`firstName`	string	optional
`middleName`	string	optional
`lastName`	string	optional
`dateOfBirth`	string	optional
`addressLine1`	string	optional
`addressLine2`	string	optional
`addressCity`	string	optional
`addressState`	string	optional
`addressPostalCode`	string	optional
`driverLicenseNumber`	string	optional
`dateOfDeath`	string	optional
`email`	string / email	optional
`phoneNumber`	string / tel	optional
`issuingJurisdictionCode`	string	optional

Code sample language

curl -X POST "{{API.SANDBOX_BASE_URL}}/IdentityVerification/IDVMatch" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "socialSecurityNumber": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "dateOfBirth": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressCity": "string",
  "addressState": "string",
  "addressPostalCode": "string",
  "driverLicenseNumber": "string",
  "dateOfDeath": "string",
  "email": "string",
  "phoneNumber": "string",
  "issuingJurisdictionCode": "string"
}'

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
var content = new StringContent(@"{
  ""socialSecurityNumber"": ""string"",
  ""firstName"": ""string"",
  ""middleName"": ""string"",
  ""lastName"": ""string"",
  ""dateOfBirth"": ""string"",
  ""addressLine1"": ""string"",
  ""addressLine2"": ""string"",
  ""addressCity"": ""string"",
  ""addressState"": ""string"",
  ""addressPostalCode"": ""string"",
  ""driverLicenseNumber"": ""string"",
  ""dateOfDeath"": ""string"",
  ""email"": ""string"",
  ""phoneNumber"": ""string"",
  ""issuingJurisdictionCode"": ""string""
}", System.Text.Encoding.UTF8, "application/json");
var response = await client.PostAsync("{{API.SANDBOX_BASE_URL}}/IdentityVerification/IDVMatch", content);
var result = await response.Content.ReadAsStringAsync();

import requests

headers = {"x-api-key": "YOUR_API_KEY"}
payload = {
  "socialSecurityNumber": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "dateOfBirth": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressCity": "string",
  "addressState": "string",
  "addressPostalCode": "string",
  "driverLicenseNumber": "string",
  "dateOfDeath": "string",
  "email": "string",
  "phoneNumber": "string",
  "issuingJurisdictionCode": "string"
}
response = requests.post("{{API.SANDBOX_BASE_URL}}/IdentityVerification/IDVMatch", headers=headers, json=payload)
print(response.json())

const response = await fetch("{{API.SANDBOX_BASE_URL}}/IdentityVerification/IDVMatch", {
  method: "POST",
  headers: { "x-api-key": "YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    "socialSecurityNumber": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "dateOfBirth": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressPostalCode": "string",
    "driverLicenseNumber": "string",
    "dateOfDeath": "string",
    "email": "string",
    "phoneNumber": "string",
    "issuingJurisdictionCode": "string"
  })
});
const result = await response.json();

Responses

`200`	OK