API Reference‎ > ‎People Service‎ > ‎

Resource: `idVerification`

Information about a person verified identity.

Schema

{
  "_type": "idVerification",
  "fingerprint": {string},
  "quizId": {string},
  "transactionId": {string},
  "attempts": {number},
  "status": {string},
  "method": {string},
  "score": {
    "nameFirst": {number},
    "nameMiddle": {number},
    "nameLast": {number},
    "nameSuffix": {number},
    "dobDay": {number},
    "dobMonth": {number},
    "dobYear": {number},
    "totalStrict": {number},
    "totalVariable": {number},
    "total": {number}
  },
  "identity": {
    "dob": {
      "day": {number},
      "month": {number},
      "year": {number}
    },
    "name": {
      "first": {string},
      "middle": {string},
      "last": {string}
    },
    "dod": {
      "day": {number},
      "month": {number},
      "year": {number}
    }
  },
  "input": {
    "dob": {
      "day": {number},
      "month": {number},
      "year": {number}
    },
    "name": {
      "first":{string},
      "last": {string},
      "middle": {string},
      "suffix": {string}
    },
    "address": {
      "street": {string},
      "city": {string},
      "state": {string},
      "zipCode": {string}
    }
  },
  "creationDate": {date},
  "dob": {
    "year": {number},
    "month": {number},
    "day": {number}
  },
  "name": {
    "full": {string},
    "suffix": {string},
    "last": {string},
    "middle": {string},
    "first": {string}
  },
  "id": {string},
  "_links": {object},
  "_actions": {object}
}

Links

Rel Description
self Link to the current resource.
home Link back to the root of the people api.
person Link to the person associated with the criminal check.

Actions

Global Request Parameters

These request parameters apply to all actions on this resource.

Parameter Type Location Required Description
username string path yes The username of the associated person.

Action: get

Fetches the identity verification information for a person.

Response

If successful, a idVerification resource will be returned in the response body.


Action: requestQuiz

Fetches a unique knowledge based authentication quiz for the person.

Request Parameters
Parameter Type Location Required Description
dobMonth int body yes Person’s date of birth month.
Min: 1 Max: 12
dobDay int body yes Person’s date of birth day.
Min: 1 Max: 31
dobYear int body yes Person’s date of birth year.
firstName string body yes Person’s first name.
middleName string body no Person’s middle name
lastName string body yes Person’s last name.
nameSuffix string body no Person’s name suffix, e.g. Jr., III.
addressStreet string body no Person’s home address street and house number.
addressCity string body no Person’s home address city.
addressState string body no Person’s home address state.
addressZip string body no Person’s home address zip code.
Response
TODO: Add response

Action: scoreQuiz

Submits the user’s quiz answers for scoring.

Request Parameters
Parameter Type Location Required Description
answers object body yes Object containing the question IDs as the keys and answer ID as the values.
Response
TODO: Add response

Comments