July 25 Release

In our July 25th release, we rolled out some exciting new updates to our 2.0 REST API.

In This Release

New, simplified, powerful reporting endpoints

Now you can generate a verification report which can be downloaded later, check the status of the report, and retrieve it when it is ready.

Use the Generate a verification report endpoint to define the start and end dates for the report:

POST /rest/v2/report/verification HTTP/1.1
Content-Type: application/json

{
	"startDate": "2019-08-06",
	"endDate": "2019-08-08",
	"format": "CSV"
}

Use the status endpoint to retrieve your verification status:

GET /rest/v2/report/{reportId}/status HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN

And finally, retrieve data for a previously-generated report in CSV format:

GET /rest/v2/report//report/{reportId} HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN

Update verification metadata endpoint

Now you can update verification metadata for an ongoing verification.

PUT /rest/v2/verification​/{verificationId}​/metadata HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN

{
  "key": "value",
  "anotherKey": "another value"
}

Capture IP address in a verification

ipAddress is now an optional field in some verifications such as Submit Student Verification. You only need to provide an ipAddress in situations where the HTTP requests do not come directly from the end user.

POST /rest/v2/verification/{verificationID}/step/collectStudentPersonalInfo HTTP/1.1
Host: services.sheerid.com
Content-Type: application/json

{
	"firstName": "Jane",
	"lastName": "Ivy",
	"birthDate": "1990-01-01",
	"email": "jane@albanylaw.edu",
	"ipAddress": "204.120.0.15",
	"organization": {
		"id": 4597,
		"name": "ALBANY LAW SCHOOL"
	}
}