POST api/ApplicantScreening/IdentityVerify

Request Information

URI Parameters

None.

Body Parameters

IdentityRootRequest
NameDescriptionTypeAdditional information
ReferenceNumber

string

None.

CustomParameters

Collection of Object

None.

Applicant

IdentityApplicantRequest

None.

DeviceSessionId

string

None.

TUPropertyId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "referenceNumber": "sample string 1",
  "customParameters": [
    {},
    {}
  ],
  "applicant": {
    "firstName": "sample string 1",
    "lastName": "sample string 2",
    "middleName": "sample string 3",
    "suffix": "sample string 4",
    "birthDate": "sample string 5",
    "ssn": "sample string 6",
    "phone": "sample string 7",
    "emailAddress": "sample string 8",
    "identificationNumber": "sample string 9",
    "identificationType": "sample string 10",
    "identificationState": "sample string 11",
    "addresses": [
      {
        "streetAddress": "sample string 1",
        "city": "sample string 2",
        "state": "sample string 3",
        "postalCode": "sample string 4",
        "country": "sample string 5",
        "addressType": "sample string 6"
      },
      {
        "streetAddress": "sample string 1",
        "city": "sample string 2",
        "state": "sample string 3",
        "postalCode": "sample string 4",
        "country": "sample string 5",
        "addressType": "sample string 6"
      }
    ],
    "customParameters": [
      {},
      {}
    ]
  },
  "deviceSessionId": "sample string 2",
  "tuPropertyId": "sample string 3"
}

application/xml, text/xml

Sample:
<IdentityRootRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ReferenceNumber>sample string 1</ReferenceNumber>
  <CustomParameters>
    <anyType />
    <anyType />
  </CustomParameters>
  <Applicant>
    <FirstName>sample string 1</FirstName>
    <LastName>sample string 2</LastName>
    <MiddleName>sample string 3</MiddleName>
    <Suffix>sample string 4</Suffix>
    <BirthDate>sample string 5</BirthDate>
    <Ssn>sample string 6</Ssn>
    <Phone>sample string 7</Phone>
    <EmailAddress>sample string 8</EmailAddress>
    <IdentificationNumber>sample string 9</IdentificationNumber>
    <IdentificationType>sample string 10</IdentificationType>
    <IdentificationState>sample string 11</IdentificationState>
    <Addresses>
      <IdentityAddressRequest>
        <StreetAddress>sample string 1</StreetAddress>
        <City>sample string 2</City>
        <State>sample string 3</State>
        <PostalCode>sample string 4</PostalCode>
        <Country>sample string 5</Country>
        <AddressType>sample string 6</AddressType>
      </IdentityAddressRequest>
      <IdentityAddressRequest>
        <StreetAddress>sample string 1</StreetAddress>
        <City>sample string 2</City>
        <State>sample string 3</State>
        <PostalCode>sample string 4</PostalCode>
        <Country>sample string 5</Country>
        <AddressType>sample string 6</AddressType>
      </IdentityAddressRequest>
    </Addresses>
    <CustomParameters>
      <anyType />
      <anyType />
    </CustomParameters>
  </Applicant>
  <DeviceSessionId>sample string 2</DeviceSessionId>
  <TUPropertyId>sample string 3</TUPropertyId>
</IdentityRootRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'IdentityRootRequest'.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.