CRS logo

LexisNexis

REST API for LexisNexis

Business Instant ID (BIID) Verification via DTODeprecated

Request
path Parameters
config
required
string
Request Body schema: application/json
Array of objects (Person)
Array of objects (Business)
object (BIIDSettingsDTO)
Responses
200

OK

post/biid/new-request/{config}
Request samples
application/json
{
  • "Persons": [
    ],
  • "Businesses": [
    ],
  • "Settings": {
    }
}

Business Instant ID (BIID) Verification via DTODeprecated

Request
path Parameters
config
required
string
Request Body schema: application/json
Array of objects (Person)
Array of objects (Business)
object (BIIDSettingsDTO)
Responses
200

OK

post/biid/new-request
Request samples
application/json
{
  • "Persons": [
    ],
  • "Businesses": [
    ],
  • "Settings": {
    }
}

Business Instant ID2 PDF Report

Executes a Business Instant ID2 verification on the provided business and associated subjects

SecurityAuthorization Token
Request
Request Body schema: application/json
object (User)
object (BIID20Options)
object (BIID20SearchBy)
Responses
200

OK

post/vfps/biid2/pdf
Request samples
application/json

Sample 1

{
  • "searchBy": {
    }
}

Business Instant ID2 PDF Report

Executes a Business Instant ID2 verification on the provided business and associated subjects

SecurityAuthorization Token
Request
path Parameters
config
required
string
Request Body schema: application/json
object (User)
object (BIID20Options)
object (BIID20SearchBy)
Responses
200

OK

post/vfps/biid2/pdf/{config}
Request samples
application/json

Sample 1

{
  • "searchBy": {
    }
}

Business Instant ID2 Verification via Data Elements

Executes a Business Instant ID2 verification on the provided business and associated subjects

SecurityAuthorization Token
Request
Request Body schema: application/json
object (User)
object (BIID20Options)
object (BIID20SearchBy)
Responses
200

Successful Business Instant ID2 Verification via Data Elements Response

post/vfps/biid2
Request samples
application/json

Sample 1

{
  • "searchBy": {
    }
}
Response samples
application/json
{
  • "response": {
    }
}

Business Instant ID2 Verification via Data Elements

Executes a Business Instant ID2 verification on the provided business and associated subjects

SecurityAuthorization Token
Request
path Parameters
config
required
string
Request Body schema: application/json
object (User)
object (BIID20Options)
object (BIID20SearchBy)
Responses
200

Successful Business Instant ID2 Verification via Data Elements Response

post/vfps/biid2/{config}
Request samples
application/json

Sample 1

{
  • "searchBy": {
    }
}
Response samples
application/json
{
  • "response": {
    }
}

Instant ID (IID)Deprecated

Request
path Parameters
config
required
string
Request Body schema: application/json
Array of objects (Person)
object (IIDSettingsDTO)
Responses
200

OK

post/iid/new-request
Request samples
application/json
{
  • "Persons": [
    ],
  • "Settings": {
    }
}

Instant ID (IID)Deprecated

Request
path Parameters
config
required
string
Request Body schema: application/json
Array of objects (Person)
object (IIDSettingsDTO)
Responses
200

OK

post/iid/new-request/{config}
Request samples
application/json
{
  • "Persons": [
    ],
  • "Settings": {
    }
}

RiskView Data

Executes a RiskView Request on the provided subjects

SecurityAuthorization Token
Request
Request Body schema: application/json
firstName
required
string (First Name) [ 0 .. 20 ] characters
middleName
string (Middle Name) [ 0 .. 20 ] characters
lastName
required
string (Last Name) [ 0 .. 32 ] characters
nameSuffix
string (Generation Suffix) [ 0 .. 3 ] characters
Enum: "Sr" "Jr" "III" "IV" "V" "VI" "VII" "VIII" "IX" "X"
dob
string <date> (Date of Birth)
ssn
string (Social Security Number) [ 4 .. 11 ] characters
phone
string (Phone Number) = 5 characters
street1
required
string (Street Address) [ 0 .. 48 ] characters
city
required
string (City) [ 0 .. 28 ] characters
state
required
string (State) = 2 characters
zip
required
string (Zip Code) [ 5 .. 10 ] characters
street2
required
string (Street Address 2) [ 0 .. 48 ] characters
Responses
200

Successful RiskView Data Response

post/riskview/basic/data
Request samples
application/json

Sample 1

{
  • "firstName": "alan",
  • "middleName": "",
  • "lastName": "smith",
  • "nameSuffix": "",
  • "street1": "1142 BUNKER HILL RD",
  • "street2": "",
  • "state": "OH",
  • "city": "Troy",
  • "zip": "45373",
  • "dob": "1955-07-01",
  • "ssn": "574808624",
  • "phone": "6023732213"
}
Response samples
application/json
{
  • "uniqueId": "string",
  • "inputEcho": {
    },
  • "models": {
    },
  • "attributesGroup": {
    },
  • "alerts": {
    },
  • "report": {
    },
  • "consumerStatements": {
    },
  • "liensJudgmentsReports": {
    }
}

RiskView Data & PDF

Executes a RiskView Request on the provided subjects

SecurityAuthorization Token
Request
Request Body schema: application/json
firstName
required
string (First Name) [ 0 .. 20 ] characters
middleName
string (Middle Name) [ 0 .. 20 ] characters
lastName
required
string (Last Name) [ 0 .. 32 ] characters
nameSuffix
string (Generation Suffix) [ 0 .. 3 ] characters
Enum: "Sr" "Jr" "III" "IV" "V" "VI" "VII" "VIII" "IX" "X"
dob
string <date> (Date of Birth)
ssn
string (Social Security Number) [ 4 .. 11 ] characters
phone
string (Phone Number) = 5 characters
street1
required
string (Street Address) [ 0 .. 48 ] characters
city
required
string (City) [ 0 .. 28 ] characters
state
required
string (State) = 2 characters
zip
required
string (Zip Code) [ 5 .. 10 ] characters
street2
required
string (Street Address 2) [ 0 .. 48 ] characters
Responses
200

Successful RiskView Data & PDF Response

post/riskview/basic
Request samples
application/json

Sample 1

{
  • "firstName": "alan",
  • "middleName": "",
  • "lastName": "smith",
  • "nameSuffix": "",
  • "street1": "1142 BUNKER HILL RD",
  • "street2": "",
  • "state": "OH",
  • "city": "Troy",
  • "zip": "45373",
  • "dob": "1955-07-01",
  • "ssn": "574808624",
  • "phone": "6023732213"
}
Response samples
application/json
{
  • "response": {