get /verifications
get /verifications/{id}/devices
get /verifications/{id}/document
get /verifications/{id}/document/scanned_image
get /verifications/{id}
get /verifications/{id}/masked_document
get /verifications/{id}/messages
get /verifications/{id}/messages/{messageId}
post /verifications/{id}/messages
get /verifications/{id}/risk_scores
get /verifications/{id}/verifier_checks
post /verifications/{id}/verifier_checks
get /verifications/{id}/verifier_checks/{verifierCheckId}
post /verifications
get /verifications
Retrieve a collection of verifications that have been created or updated since the specified time or verification ID.
The since
parameter can be either:
The response includes all verifications accessible to the authenticated user that were created after the specified time.
[ {
"documentType" : "US_CA_DL",
"devices" : [ {
"displayHeight" : 1080,
"dateTime" : "3/18/2025 08:25",
"browserTimeZone" : "America/Los_Angeles",
"country" : "United States",
"city" : "Phoenix",
"origin" : "example.com",
"isp" : "COMCAST Cable",
"latitude" : 33.4484,
"language" : "en-US",
"operatingSystem" : "Mac OS X 10.15",
"platform" : "MacIntel",
"via" : [ "via", "via" ],
"createdAt" : "2022-01-01T00:00:00Z",
"browser" : "Firefox 130.0",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"longitude" : -112.0741,
"offsetMinutes" : -360,
"browserHeight" : 1080,
"ipAddressTimeZone" : "America/Los_Angeles",
"browserDateTime" : "Tue Mar 18 2025 08:25:06 GMT-0600 (Mountain Daylight Time)",
"ipAddress" : "192.168.1.1",
"userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
"epochMilliseconds" : 1709000000000,
"displayWidth" : 1920,
"browserTimeZoneWithOffset" : "America/Denver (-06.00)",
"region" : "Arizona",
"asn" : "AS7922",
"browserWidth" : 1920
}, {
"displayHeight" : 1080,
"dateTime" : "3/18/2025 08:25",
"browserTimeZone" : "America/Los_Angeles",
"country" : "United States",
"city" : "Phoenix",
"origin" : "example.com",
"isp" : "COMCAST Cable",
"latitude" : 33.4484,
"language" : "en-US",
"operatingSystem" : "Mac OS X 10.15",
"platform" : "MacIntel",
"via" : [ "via", "via" ],
"createdAt" : "2022-01-01T00:00:00Z",
"browser" : "Firefox 130.0",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"longitude" : -112.0741,
"offsetMinutes" : -360,
"browserHeight" : 1080,
"ipAddressTimeZone" : "America/Los_Angeles",
"browserDateTime" : "Tue Mar 18 2025 08:25:06 GMT-0600 (Mountain Daylight Time)",
"ipAddress" : "192.168.1.1",
"userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
"epochMilliseconds" : 1709000000000,
"displayWidth" : 1920,
"browserTimeZoneWithOffset" : "America/Denver (-06.00)",
"region" : "Arizona",
"asn" : "AS7922",
"browserWidth" : 1920
} ],
"verifierChecks" : [ {
"lastName" : "lastName",
"createdAt" : "2022-01-01T00:00:00Z",
"mnoFallback" : true,
"verifier" : "SCAN",
"verifierResult" : "verifierResult",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"lastName" : "lastName",
"createdAt" : "2022-01-01T00:00:00Z",
"mnoFallback" : true,
"verifier" : "SCAN",
"verifierResult" : "verifierResult",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"updatedAt" : "2022-01-01T00:00:00Z"
} ],
"scores" : [ {
"score" : "score",
"reason" : "reason",
"createdAt" : "2022-01-01T00:00:00Z",
"robotRule" : true,
"verifier" : "DMV",
"ruleType" : "VERIFIER",
"rule" : "rule",
"id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
"riskyFields" : [ "riskyFields", "riskyFields" ],
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"score" : "score",
"reason" : "reason",
"createdAt" : "2022-01-01T00:00:00Z",
"robotRule" : true,
"verifier" : "DMV",
"ruleType" : "VERIFIER",
"rule" : "rule",
"id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
"riskyFields" : [ "riskyFields", "riskyFields" ],
"updatedAt" : "2022-01-01T00:00:00Z"
} ],
"reviewAccessExpiresAt" : "2022-01-01T00:00:00Z",
"linkUrlExpiresAt" : "2022-01-01T00:00:00Z",
"expiredLinkUrlAccess" : true,
"createdAt" : "2022-01-01T00:00:00Z",
"supportedVerifiers" : [ "DMV", "DMV" ],
"overallRisk" : "false",
"requestedMessages" : [ {
"phoneNumber" : "+12003004000",
"channel" : "SMS"
}, {
"phoneNumber" : "+12003004000",
"channel" : "SMS"
} ],
"portalUrl" : "https://portal.example.net/tenants/1C91D8B3-0F1F-40B7-BDB8-2E0B5395DE32/verifications/1C91D8B3-0F1F-40B7-BDB8-2E0B5395DE12",
"linkUrl" : "https://atop.example.net/identity/verifications/1C91D8B3-0F1F-40B7-BDB8-2E0B5395DE12",
"messages" : [ {
"createdAt" : "2022-01-01T00:00:00Z",
"phoneNumber" : "+12003004000",
"channel" : "SMS",
"id" : "id",
"status" : "status",
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"createdAt" : "2022-01-01T00:00:00Z",
"phoneNumber" : "+12003004000",
"channel" : "SMS",
"id" : "id",
"status" : "status",
"updatedAt" : "2022-01-01T00:00:00Z"
} ],
"callbackUrl" : "https://example.com/callback/unique/to/this/request/8b62142a99ba759d8c9153b68765513c62180891",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"expiredReviewAccess" : true,
"agentEmailAddress" : "agent@example.com",
"status" : "WAITING",
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"documentType" : "US_CA_DL",
"devices" : [ {
"displayHeight" : 1080,
"dateTime" : "3/18/2025 08:25",
"browserTimeZone" : "America/Los_Angeles",
"country" : "United States",
"city" : "Phoenix",
"origin" : "example.com",
"isp" : "COMCAST Cable",
"latitude" : 33.4484,
"language" : "en-US",
"operatingSystem" : "Mac OS X 10.15",
"platform" : "MacIntel",
"via" : [ "via", "via" ],
"createdAt" : "2022-01-01T00:00:00Z",
"browser" : "Firefox 130.0",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"longitude" : -112.0741,
"offsetMinutes" : -360,
"browserHeight" : 1080,
"ipAddressTimeZone" : "America/Los_Angeles",
"browserDateTime" : "Tue Mar 18 2025 08:25:06 GMT-0600 (Mountain Daylight Time)",
"ipAddress" : "192.168.1.1",
"userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
"epochMilliseconds" : 1709000000000,
"displayWidth" : 1920,
"browserTimeZoneWithOffset" : "America/Denver (-06.00)",
"region" : "Arizona",
"asn" : "AS7922",
"browserWidth" : 1920
}, {
"displayHeight" : 1080,
"dateTime" : "3/18/2025 08:25",
"browserTimeZone" : "America/Los_Angeles",
"country" : "United States",
"city" : "Phoenix",
"origin" : "example.com",
"isp" : "COMCAST Cable",
"latitude" : 33.4484,
"language" : "en-US",
"operatingSystem" : "Mac OS X 10.15",
"platform" : "MacIntel",
"via" : [ "via", "via" ],
"createdAt" : "2022-01-01T00:00:00Z",
"browser" : "Firefox 130.0",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"longitude" : -112.0741,
"offsetMinutes" : -360,
"browserHeight" : 1080,
"ipAddressTimeZone" : "America/Los_Angeles",
"browserDateTime" : "Tue Mar 18 2025 08:25:06 GMT-0600 (Mountain Daylight Time)",
"ipAddress" : "192.168.1.1",
"userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
"epochMilliseconds" : 1709000000000,
"displayWidth" : 1920,
"browserTimeZoneWithOffset" : "America/Denver (-06.00)",
"region" : "Arizona",
"asn" : "AS7922",
"browserWidth" : 1920
} ],
"verifierChecks" : [ {
"lastName" : "lastName",
"createdAt" : "2022-01-01T00:00:00Z",
"mnoFallback" : true,
"verifier" : "SCAN",
"verifierResult" : "verifierResult",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"lastName" : "lastName",
"createdAt" : "2022-01-01T00:00:00Z",
"mnoFallback" : true,
"verifier" : "SCAN",
"verifierResult" : "verifierResult",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"updatedAt" : "2022-01-01T00:00:00Z"
} ],
"scores" : [ {
"score" : "score",
"reason" : "reason",
"createdAt" : "2022-01-01T00:00:00Z",
"robotRule" : true,
"verifier" : "DMV",
"ruleType" : "VERIFIER",
"rule" : "rule",
"id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
"riskyFields" : [ "riskyFields", "riskyFields" ],
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"score" : "score",
"reason" : "reason",
"createdAt" : "2022-01-01T00:00:00Z",
"robotRule" : true,
"verifier" : "DMV",
"ruleType" : "VERIFIER",
"rule" : "rule",
"id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
"riskyFields" : [ "riskyFields", "riskyFields" ],
"updatedAt" : "2022-01-01T00:00:00Z"
} ],
"reviewAccessExpiresAt" : "2022-01-01T00:00:00Z",
"linkUrlExpiresAt" : "2022-01-01T00:00:00Z",
"expiredLinkUrlAccess" : true,
"createdAt" : "2022-01-01T00:00:00Z",
"supportedVerifiers" : [ "DMV", "DMV" ],
"overallRisk" : "false",
"requestedMessages" : [ {
"phoneNumber" : "+12003004000",
"channel" : "SMS"
}, {
"phoneNumber" : "+12003004000",
"channel" : "SMS"
} ],
"portalUrl" : "https://portal.example.net/tenants/1C91D8B3-0F1F-40B7-BDB8-2E0B5395DE32/verifications/1C91D8B3-0F1F-40B7-BDB8-2E0B5395DE12",
"linkUrl" : "https://atop.example.net/identity/verifications/1C91D8B3-0F1F-40B7-BDB8-2E0B5395DE12",
"messages" : [ {
"createdAt" : "2022-01-01T00:00:00Z",
"phoneNumber" : "+12003004000",
"channel" : "SMS",
"id" : "id",
"status" : "status",
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"createdAt" : "2022-01-01T00:00:00Z",
"phoneNumber" : "+12003004000",
"channel" : "SMS",
"id" : "id",
"status" : "status",
"updatedAt" : "2022-01-01T00:00:00Z"
} ],
"callbackUrl" : "https://example.com/callback/unique/to/this/request/8b62142a99ba759d8c9153b68765513c62180891",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"expiredReviewAccess" : true,
"agentEmailAddress" : "agent@example.com",
"status" : "WAITING",
"updatedAt" : "2022-01-01T00:00:00Z"
} ]
{
"error" : "error"
}
{
"error" : "error"
}
application/json
get /verifications/{id}/devices
[ {
"displayHeight" : 1080,
"dateTime" : "3/18/2025 08:25",
"browserTimeZone" : "America/Los_Angeles",
"country" : "United States",
"city" : "Phoenix",
"origin" : "example.com",
"isp" : "COMCAST Cable",
"latitude" : 33.4484,
"language" : "en-US",
"operatingSystem" : "Mac OS X 10.15",
"platform" : "MacIntel",
"via" : [ "via", "via" ],
"createdAt" : "2022-01-01T00:00:00Z",
"browser" : "Firefox 130.0",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"longitude" : -112.0741,
"offsetMinutes" : -360,
"browserHeight" : 1080,
"ipAddressTimeZone" : "America/Los_Angeles",
"browserDateTime" : "Tue Mar 18 2025 08:25:06 GMT-0600 (Mountain Daylight Time)",
"ipAddress" : "192.168.1.1",
"userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
"epochMilliseconds" : 1709000000000,
"displayWidth" : 1920,
"browserTimeZoneWithOffset" : "America/Denver (-06.00)",
"region" : "Arizona",
"asn" : "AS7922",
"browserWidth" : 1920
}, {
"displayHeight" : 1080,
"dateTime" : "3/18/2025 08:25",
"browserTimeZone" : "America/Los_Angeles",
"country" : "United States",
"city" : "Phoenix",
"origin" : "example.com",
"isp" : "COMCAST Cable",
"latitude" : 33.4484,
"language" : "en-US",
"operatingSystem" : "Mac OS X 10.15",
"platform" : "MacIntel",
"via" : [ "via", "via" ],
"createdAt" : "2022-01-01T00:00:00Z",
"browser" : "Firefox 130.0",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"longitude" : -112.0741,
"offsetMinutes" : -360,
"browserHeight" : 1080,
"ipAddressTimeZone" : "America/Los_Angeles",
"browserDateTime" : "Tue Mar 18 2025 08:25:06 GMT-0600 (Mountain Daylight Time)",
"ipAddress" : "192.168.1.1",
"userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
"epochMilliseconds" : 1709000000000,
"displayWidth" : 1920,
"browserTimeZoneWithOffset" : "America/Denver (-06.00)",
"region" : "Arizona",
"asn" : "AS7922",
"browserWidth" : 1920
} ]
application/json
get /verifications/{id}/document
{
"document" : {
"lastName" : "lastName",
"zipCode" : "zipCode",
"documentType" : "documentType",
"city" : "city",
"documentNumber" : "documentNumber",
"zip4" : "zip4",
"documentNumberSuffix" : "documentNumberSuffix",
"expiryDate" : "expiryDate",
"createdAt" : "2022-01-01T00:00:00Z",
"middleInitial" : "middleInitial",
"eyeColor" : "eyeColor",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"state" : "state",
"issueDate" : "issueDate",
"height" : "height",
"updatedAt" : "2022-01-01T00:00:00Z",
"placeOfBirth" : "placeOfBirth",
"address2" : "address2",
"address1" : "address1",
"sex" : "sex",
"weight" : "weight",
"dateOfBirth" : "dateOfBirth",
"firstName" : "firstName",
"issuingAuthority" : "issuingAuthority",
"nationality" : "nationality",
"middleName" : "middleName",
"age" : "age"
}
}
application/json
get /verifications/{id}/document/scanned_image
{
"data" : "UjBsR09EbGhBUUFCQUlBQUFBQUFBUC8vL3lINUJBRUFBQUFBTEFBQUFBQUJBQUVBQUFJQlJBQTc="
}
application/json
get /verifications/{id}
{
"documentType" : "US_CA_DL",
"devices" : [ {
"displayHeight" : 1080,
"dateTime" : "3/18/2025 08:25",
"browserTimeZone" : "America/Los_Angeles",
"country" : "United States",
"city" : "Phoenix",
"origin" : "example.com",
"isp" : "COMCAST Cable",
"latitude" : 33.4484,
"language" : "en-US",
"operatingSystem" : "Mac OS X 10.15",
"platform" : "MacIntel",
"via" : [ "via", "via" ],
"createdAt" : "2022-01-01T00:00:00Z",
"browser" : "Firefox 130.0",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"longitude" : -112.0741,
"offsetMinutes" : -360,
"browserHeight" : 1080,
"ipAddressTimeZone" : "America/Los_Angeles",
"browserDateTime" : "Tue Mar 18 2025 08:25:06 GMT-0600 (Mountain Daylight Time)",
"ipAddress" : "192.168.1.1",
"userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
"epochMilliseconds" : 1709000000000,
"displayWidth" : 1920,
"browserTimeZoneWithOffset" : "America/Denver (-06.00)",
"region" : "Arizona",
"asn" : "AS7922",
"browserWidth" : 1920
}, {
"displayHeight" : 1080,
"dateTime" : "3/18/2025 08:25",
"browserTimeZone" : "America/Los_Angeles",
"country" : "United States",
"city" : "Phoenix",
"origin" : "example.com",
"isp" : "COMCAST Cable",
"latitude" : 33.4484,
"language" : "en-US",
"operatingSystem" : "Mac OS X 10.15",
"platform" : "MacIntel",
"via" : [ "via", "via" ],
"createdAt" : "2022-01-01T00:00:00Z",
"browser" : "Firefox 130.0",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"longitude" : -112.0741,
"offsetMinutes" : -360,
"browserHeight" : 1080,
"ipAddressTimeZone" : "America/Los_Angeles",
"browserDateTime" : "Tue Mar 18 2025 08:25:06 GMT-0600 (Mountain Daylight Time)",
"ipAddress" : "192.168.1.1",
"userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
"epochMilliseconds" : 1709000000000,
"displayWidth" : 1920,
"browserTimeZoneWithOffset" : "America/Denver (-06.00)",
"region" : "Arizona",
"asn" : "AS7922",
"browserWidth" : 1920
} ],
"verifierChecks" : [ {
"lastName" : "lastName",
"createdAt" : "2022-01-01T00:00:00Z",
"mnoFallback" : true,
"verifier" : "SCAN",
"verifierResult" : "verifierResult",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"lastName" : "lastName",
"createdAt" : "2022-01-01T00:00:00Z",
"mnoFallback" : true,
"verifier" : "SCAN",
"verifierResult" : "verifierResult",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"updatedAt" : "2022-01-01T00:00:00Z"
} ],
"scores" : [ {
"score" : "score",
"reason" : "reason",
"createdAt" : "2022-01-01T00:00:00Z",
"robotRule" : true,
"verifier" : "DMV",
"ruleType" : "VERIFIER",
"rule" : "rule",
"id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
"riskyFields" : [ "riskyFields", "riskyFields" ],
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"score" : "score",
"reason" : "reason",
"createdAt" : "2022-01-01T00:00:00Z",
"robotRule" : true,
"verifier" : "DMV",
"ruleType" : "VERIFIER",
"rule" : "rule",
"id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
"riskyFields" : [ "riskyFields", "riskyFields" ],
"updatedAt" : "2022-01-01T00:00:00Z"
} ],
"reviewAccessExpiresAt" : "2022-01-01T00:00:00Z",
"linkUrlExpiresAt" : "2022-01-01T00:00:00Z",
"expiredLinkUrlAccess" : true,
"createdAt" : "2022-01-01T00:00:00Z",
"supportedVerifiers" : [ "DMV", "DMV" ],
"overallRisk" : "false",
"requestedMessages" : [ {
"phoneNumber" : "+12003004000",
"channel" : "SMS"
}, {
"phoneNumber" : "+12003004000",
"channel" : "SMS"
} ],
"portalUrl" : "https://portal.example.net/tenants/1C91D8B3-0F1F-40B7-BDB8-2E0B5395DE32/verifications/1C91D8B3-0F1F-40B7-BDB8-2E0B5395DE12",
"linkUrl" : "https://atop.example.net/identity/verifications/1C91D8B3-0F1F-40B7-BDB8-2E0B5395DE12",
"messages" : [ {
"createdAt" : "2022-01-01T00:00:00Z",
"phoneNumber" : "+12003004000",
"channel" : "SMS",
"id" : "id",
"status" : "status",
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"createdAt" : "2022-01-01T00:00:00Z",
"phoneNumber" : "+12003004000",
"channel" : "SMS",
"id" : "id",
"status" : "status",
"updatedAt" : "2022-01-01T00:00:00Z"
} ],
"callbackUrl" : "https://example.com/callback/unique/to/this/request/8b62142a99ba759d8c9153b68765513c62180891",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"expiredReviewAccess" : true,
"agentEmailAddress" : "agent@example.com",
"status" : "WAITING",
"updatedAt" : "2022-01-01T00:00:00Z"
}
application/json
get /verifications/{id}/masked_document
{
"document" : {
"lastName" : "lastName",
"zipCode" : "zipCode",
"documentType" : "documentType",
"city" : "city",
"documentNumber" : "documentNumber",
"zip4" : "zip4",
"documentNumberSuffix" : "documentNumberSuffix",
"expiryDate" : "expiryDate",
"createdAt" : "2022-01-01T00:00:00Z",
"middleInitial" : "middleInitial",
"eyeColor" : "eyeColor",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"state" : "state",
"issueDate" : "issueDate",
"height" : "height",
"updatedAt" : "2022-01-01T00:00:00Z",
"placeOfBirth" : "placeOfBirth",
"address2" : "address2",
"address1" : "address1",
"sex" : "sex",
"weight" : "weight",
"dateOfBirth" : "dateOfBirth",
"firstName" : "firstName",
"issuingAuthority" : "issuingAuthority",
"nationality" : "nationality",
"middleName" : "middleName",
"age" : "age"
}
}
application/json
get /verifications/{id}/messages
[ {
"createdAt" : "2022-01-01T00:00:00Z",
"phoneNumber" : "+12003004000",
"channel" : "SMS",
"id" : "id",
"status" : "status",
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"createdAt" : "2022-01-01T00:00:00Z",
"phoneNumber" : "+12003004000",
"channel" : "SMS",
"id" : "id",
"status" : "status",
"updatedAt" : "2022-01-01T00:00:00Z"
} ]
application/json
get /verifications/{id}/messages/{messageId}
{
"createdAt" : "2022-01-01T00:00:00Z",
"phoneNumber" : "+12003004000",
"channel" : "SMS",
"id" : "id",
"status" : "status",
"updatedAt" : "2022-01-01T00:00:00Z"
}
application/json
post /verifications/{id}/messages
application/json
{
"error" : "error"
}
{
"error" : "error"
}
application/json
get /verifications/{id}/risk_scores
[ {
"score" : "score",
"reason" : "reason",
"createdAt" : "2022-01-01T00:00:00Z",
"robotRule" : true,
"verifier" : "DMV",
"ruleType" : "VERIFIER",
"rule" : "rule",
"id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
"riskyFields" : [ "riskyFields", "riskyFields" ],
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"score" : "score",
"reason" : "reason",
"createdAt" : "2022-01-01T00:00:00Z",
"robotRule" : true,
"verifier" : "DMV",
"ruleType" : "VERIFIER",
"rule" : "rule",
"id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
"riskyFields" : [ "riskyFields", "riskyFields" ],
"updatedAt" : "2022-01-01T00:00:00Z"
} ]
application/json
get /verifications/{id}/verifier_checks
[ {
"lastName" : "lastName",
"createdAt" : "2022-01-01T00:00:00Z",
"mnoFallback" : true,
"verifier" : "SCAN",
"verifierResult" : "verifierResult",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"lastName" : "lastName",
"createdAt" : "2022-01-01T00:00:00Z",
"mnoFallback" : true,
"verifier" : "SCAN",
"verifierResult" : "verifierResult",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"updatedAt" : "2022-01-01T00:00:00Z"
} ]
application/json
post /verifications/{id}/verifier_checks
application/json
get /verifications/{id}/verifier_checks/{verifierCheckId}
{
"lastName" : "lastName",
"createdAt" : "2022-01-01T00:00:00Z",
"mnoFallback" : true,
"documentType" : "documentType",
"verifier" : "DMV",
"verifierResult" : "SUCCESS",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"matches" : {
"lastName" : true,
"zipCode" : true,
"documentType" : true,
"address2" : true,
"city" : true,
"documentNumber" : true,
"address1" : true,
"sex" : true,
"weight" : true,
"zip4" : true,
"dateOfBirth" : true,
"expiryDate" : true,
"firstName" : true,
"middleInitial" : true,
"eyeColor" : true,
"middleName" : true,
"state" : true,
"issueDate" : true,
"height" : true
},
"documentNumberSuffix" : "documentNumberSuffix",
"updatedAt" : "2022-01-01T00:00:00Z"
}
application/json
post /verifications
application/json
{
"documentType" : "US_CA_DL",
"devices" : [ {
"displayHeight" : 1080,
"dateTime" : "3/18/2025 08:25",
"browserTimeZone" : "America/Los_Angeles",
"country" : "United States",
"city" : "Phoenix",
"origin" : "example.com",
"isp" : "COMCAST Cable",
"latitude" : 33.4484,
"language" : "en-US",
"operatingSystem" : "Mac OS X 10.15",
"platform" : "MacIntel",
"via" : [ "via", "via" ],
"createdAt" : "2022-01-01T00:00:00Z",
"browser" : "Firefox 130.0",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"longitude" : -112.0741,
"offsetMinutes" : -360,
"browserHeight" : 1080,
"ipAddressTimeZone" : "America/Los_Angeles",
"browserDateTime" : "Tue Mar 18 2025 08:25:06 GMT-0600 (Mountain Daylight Time)",
"ipAddress" : "192.168.1.1",
"userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
"epochMilliseconds" : 1709000000000,
"displayWidth" : 1920,
"browserTimeZoneWithOffset" : "America/Denver (-06.00)",
"region" : "Arizona",
"asn" : "AS7922",
"browserWidth" : 1920
}, {
"displayHeight" : 1080,
"dateTime" : "3/18/2025 08:25",
"browserTimeZone" : "America/Los_Angeles",
"country" : "United States",
"city" : "Phoenix",
"origin" : "example.com",
"isp" : "COMCAST Cable",
"latitude" : 33.4484,
"language" : "en-US",
"operatingSystem" : "Mac OS X 10.15",
"platform" : "MacIntel",
"via" : [ "via", "via" ],
"createdAt" : "2022-01-01T00:00:00Z",
"browser" : "Firefox 130.0",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"longitude" : -112.0741,
"offsetMinutes" : -360,
"browserHeight" : 1080,
"ipAddressTimeZone" : "America/Los_Angeles",
"browserDateTime" : "Tue Mar 18 2025 08:25:06 GMT-0600 (Mountain Daylight Time)",
"ipAddress" : "192.168.1.1",
"userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
"epochMilliseconds" : 1709000000000,
"displayWidth" : 1920,
"browserTimeZoneWithOffset" : "America/Denver (-06.00)",
"region" : "Arizona",
"asn" : "AS7922",
"browserWidth" : 1920
} ],
"verifierChecks" : [ {
"lastName" : "lastName",
"createdAt" : "2022-01-01T00:00:00Z",
"mnoFallback" : true,
"verifier" : "SCAN",
"verifierResult" : "verifierResult",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"lastName" : "lastName",
"createdAt" : "2022-01-01T00:00:00Z",
"mnoFallback" : true,
"verifier" : "SCAN",
"verifierResult" : "verifierResult",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"updatedAt" : "2022-01-01T00:00:00Z"
} ],
"scores" : [ {
"score" : "score",
"reason" : "reason",
"createdAt" : "2022-01-01T00:00:00Z",
"robotRule" : true,
"verifier" : "DMV",
"ruleType" : "VERIFIER",
"rule" : "rule",
"id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
"riskyFields" : [ "riskyFields", "riskyFields" ],
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"score" : "score",
"reason" : "reason",
"createdAt" : "2022-01-01T00:00:00Z",
"robotRule" : true,
"verifier" : "DMV",
"ruleType" : "VERIFIER",
"rule" : "rule",
"id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
"riskyFields" : [ "riskyFields", "riskyFields" ],
"updatedAt" : "2022-01-01T00:00:00Z"
} ],
"reviewAccessExpiresAt" : "2022-01-01T00:00:00Z",
"linkUrlExpiresAt" : "2022-01-01T00:00:00Z",
"expiredLinkUrlAccess" : true,
"createdAt" : "2022-01-01T00:00:00Z",
"supportedVerifiers" : [ "DMV", "DMV" ],
"overallRisk" : "false",
"requestedMessages" : [ {
"phoneNumber" : "+12003004000",
"channel" : "SMS"
}, {
"phoneNumber" : "+12003004000",
"channel" : "SMS"
} ],
"portalUrl" : "https://portal.example.net/tenants/1C91D8B3-0F1F-40B7-BDB8-2E0B5395DE32/verifications/1C91D8B3-0F1F-40B7-BDB8-2E0B5395DE12",
"linkUrl" : "https://atop.example.net/identity/verifications/1C91D8B3-0F1F-40B7-BDB8-2E0B5395DE12",
"messages" : [ {
"createdAt" : "2022-01-01T00:00:00Z",
"phoneNumber" : "+12003004000",
"channel" : "SMS",
"id" : "id",
"status" : "status",
"updatedAt" : "2022-01-01T00:00:00Z"
}, {
"createdAt" : "2022-01-01T00:00:00Z",
"phoneNumber" : "+12003004000",
"channel" : "SMS",
"id" : "id",
"status" : "status",
"updatedAt" : "2022-01-01T00:00:00Z"
} ],
"callbackUrl" : "https://example.com/callback/unique/to/this/request/8b62142a99ba759d8c9153b68765513c62180891",
"id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
"expiredReviewAccess" : true,
"agentEmailAddress" : "agent@example.com",
"status" : "WAITING",
"updatedAt" : "2022-01-01T00:00:00Z"
}
application/json
Device
- DmvVerifierCheck
- DmvVerifierCheck_matches
- Document
- EmailMessage
- ErrorResponse
- MnoVerifierCheck
- MnoVerifierCheck_matches
- RequestedEmailMessage
- RequestedSmsMessage
- RequestedTrustedSmsMessage
- RiskScore
- ScanVerifierCheck
- ScannedImage
- SmsMessage
- TrustedSmsMessage
- Verification
- VerificationRequest
- VerificationRequest_requestedMessages_inner
- Verification_messages_inner
- Verification_supportedVerifiers_inner
- Verifier
- _verifications__id__document_get_200_response
- _verifications__id__messages_get_200_response_inner
- _verifications__id__verifier_checks_get_200_response_inner
- _verifications__id__verifier_checks_post_request
- Device
- UpDmvVerifierCheck
- UpDmvVerifierCheck_matches
- UpDocument
- UpErrorResponse
- UpMnoVerifierCheck_matches
- UpRiskScore
- UpScannedImage
- UpVerification
- UpVerificationRequest
- Up_verifications__id__document_get_200_response
- Up_verifications__id__verifier_checks_get_200_response_inner
- Up_verifications__id__verifier_checks_post_request
- Up