verification

Submit data to a Remember Me enabled program

Submit consumer data for a verification. The program must have the Remember Me function.

The request body is a flat union of fields. It contains all the fields that any audience can supply. It is not one fixed shape. The server changes the request body into the correct subject type, and the segment of the program controls this change.

The resolved subject type sets the required fields. This schema does not set them. One segment can require a field that a different segment ignores. The required list in this schema shows only the fields that all subject types require.

If you know the segment before you send the request, use the step for that audience. For example, use collectStudentPersonalInfo. The schema for each of those steps shows its required fields correctly. The VerificationSubject schema lists all the concrete shapes.

This step is different from the steps for one audience. This step does not accept the deprecated status field, which holds only one value. Use the statuses field. If you send status, the server rejects the request with an unrecognized property error.

post/verification/{verificationId}/step/collectPersonalInfo

Path parameters

verificationIdstring required

Unique identifier for the ongoing verification

Request body

firstNamestring required

The first name of the person being verified

lastNamestring required

The last name of the person being verified

address1string

The home street address of the person being verified. Required for instant verification.

citystring

The city of the person being verified.

statestring

The two character state code of the organization.

stateCodestring

The two character state code for the person being verified. Provide when open org is submitted, i.e. organization id = 0

deviceFingerprintHashstring

The device fingerprint collected for the person being verified

dischargeDatestring date

The date the person being verified was discharged from the military

driverLicenseNumberstring

The drivers license number of an individual; non-alphanumeric characters are ignored

activeDutyStartDatestring date

The date the person being verified started active duty in the military

countrystring nullable

The ISO 3166-1 alpha-2 country code of the person being verified. In a response, the value can be null if the verification has no country.

memberIdstring

The unique member ID number for the person being verified

postalCodestring

The postal code for the person being verified

trackingIdstring

The tracking ID that was assigned to this verification

ebtCardNumberstring

The number of an EBT card.

emailstring required

The email address of the person being verified

birthDatestring date required

The date of birth of the person being verified (format YYYY-MM-DD). Date must be greater than 1900-01-01.

ipAddressstring ipv4

The end-user's public IP address. This only needs to be provided in situations where the HTTP requests do not come directly from the end-user.

ipAddressExtendedstring ipv4,ipv6

The end-user's public IP address. This only needs to be provided in situations where the HTTP requests do not come directly from the end-user.

externalUserIdstring

An identifier stored with the verification for external reference

captchaTokenstring

The captcha token collected for the person being verified

phoneNumberstring

The phone number used for SMS messages

socialSecurityNumbernumber

The social security number of the person to be verified

localestring

The locale chosen by the user

metadataPersonalInfoMetadata

A collection of custom metadata to be stored with the verification

activeDutyEndDatestring date

The date the person being verified ended active duty in the military

cvecNumberstring

The unique CVEC number for the person being verified

Response

The result of the verification

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Changes

No recorded changes to this endpoint across all 1 revision of this API.