Verification API

API to manage verifications, messages, checkers, devices, and risk scores.
More information: https://trusona.com
Contact Info: support@trusona.com
Version: 1.0.0
BasePath:/api/v1
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Bearer Token authentication (JWT)

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up 
get /verifications/{id}/devices
Get all devices for a verification (verificationsIdDevicesGet)

Path parameters

id (required)
Path Parameter — default: null

Return type

array[Device]

Example data

Content-Type: application/json
[ {
  "displayHeight" : 1080,
  "browserTimeZone" : "America/Los_Angeles",
  "country" : "United States",
  "city" : "Phoenix",
  "browserHeight" : 1080,
  "ipAddressTimeZone" : "America/Los_Angeles",
  "isp" : "COMCAST Cable",
  "latitude" : 33.4484,
  "browserDateTime" : "Thu Oct 10 2024 10:44:55 GMT-0600 (Mountain Daylight Time)",
  "ipAddress" : "192.168.1.1",
  "language" : "en-US",
  "userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
  "operatingSystem" : "Mac OS X 10.15",
  "platform" : "MacIntel",
  "createdAt" : "2022-01-01T00:00:00Z",
  "displayWidth" : 1920,
  "browser" : "Firefox 130.0",
  "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
  "region" : "Arizona",
  "browserWidth" : 1920,
  "longitude" : -112.0741
}, {
  "displayHeight" : 1080,
  "browserTimeZone" : "America/Los_Angeles",
  "country" : "United States",
  "city" : "Phoenix",
  "browserHeight" : 1080,
  "ipAddressTimeZone" : "America/Los_Angeles",
  "isp" : "COMCAST Cable",
  "latitude" : 33.4484,
  "browserDateTime" : "Thu Oct 10 2024 10:44:55 GMT-0600 (Mountain Daylight Time)",
  "ipAddress" : "192.168.1.1",
  "language" : "en-US",
  "userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
  "operatingSystem" : "Mac OS X 10.15",
  "platform" : "MacIntel",
  "createdAt" : "2022-01-01T00:00:00Z",
  "displayWidth" : 1920,
  "browser" : "Firefox 130.0",
  "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
  "region" : "Arizona",
  "browserWidth" : 1920,
  "longitude" : -112.0741
} ]

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of devices

404

Verification not found ErrorResponse
Up 
get /verifications/{id}/document
Get the verification's document (verificationsIdDocumentGet)

Path parameters

id (required)
Path Parameter — default: null

Return type

_verifications__id__document_get_200_response

Example data

Content-Type: application/json
{
  "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" : "2000-01-23",
    "firstName" : "firstName",
    "issuingAuthority" : "issuingAuthority",
    "nationality" : "nationality",
    "middleName" : "middleName",
    "age" : "age"
  }
}

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The verification's document _verifications__id__document_get_200_response

404

Verification was not found or document is not yet available ErrorResponse

410

Document has been removed (occurs when parent verification expires) ErrorResponse
Up 
get /verifications/{id}/document/scanned_image
Get the scanned image of the document (verificationsIdDocumentScannedImageGet)

Path parameters

id (required)
Path Parameter — default: null

Return type

File

Example data

Content-Type: application/json
"UjBsR09EbGhBUUFCQUlBQUFBQUFBUC8vL3lINUJBRUFBQUFBTEFBQUFBQUJBQUVBQUFJQlJBQTc="

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The scanned document image File

404

Verification was not found or document does not have an available scanned image ErrorResponse

410

Scanned image has been removed (occurs when parent verification expires) ErrorResponse
Up 
get /verifications/{id}
Get verification by ID (verificationsIdGet)

Path parameters

id (required)
Path Parameter — default: null

Return type

Verification

Example data

Content-Type: application/json
{
  "documentType" : "US_CA_DL",
  "devices" : [ {
    "displayHeight" : 1080,
    "browserTimeZone" : "America/Los_Angeles",
    "country" : "United States",
    "city" : "Phoenix",
    "browserHeight" : 1080,
    "ipAddressTimeZone" : "America/Los_Angeles",
    "isp" : "COMCAST Cable",
    "latitude" : 33.4484,
    "browserDateTime" : "Thu Oct 10 2024 10:44:55 GMT-0600 (Mountain Daylight Time)",
    "ipAddress" : "192.168.1.1",
    "language" : "en-US",
    "userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
    "operatingSystem" : "Mac OS X 10.15",
    "platform" : "MacIntel",
    "createdAt" : "2022-01-01T00:00:00Z",
    "displayWidth" : 1920,
    "browser" : "Firefox 130.0",
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "region" : "Arizona",
    "browserWidth" : 1920,
    "longitude" : -112.0741
  }, {
    "displayHeight" : 1080,
    "browserTimeZone" : "America/Los_Angeles",
    "country" : "United States",
    "city" : "Phoenix",
    "browserHeight" : 1080,
    "ipAddressTimeZone" : "America/Los_Angeles",
    "isp" : "COMCAST Cable",
    "latitude" : 33.4484,
    "browserDateTime" : "Thu Oct 10 2024 10:44:55 GMT-0600 (Mountain Daylight Time)",
    "ipAddress" : "192.168.1.1",
    "language" : "en-US",
    "userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
    "operatingSystem" : "Mac OS X 10.15",
    "platform" : "MacIntel",
    "createdAt" : "2022-01-01T00:00:00Z",
    "displayWidth" : 1920,
    "browser" : "Firefox 130.0",
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "region" : "Arizona",
    "browserWidth" : 1920,
    "longitude" : -112.0741
  } ],
  "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",
  "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"
}

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Verification details Verification

404

Verification not found ErrorResponse
Up 
get /verifications/{id}/messages
Get all messages for a verification (verificationsIdMessagesGet)

Path parameters

id (required)
Path Parameter — default: null

Return type

array[_verifications__id__messages_get_200_response_inner]

Example data

Content-Type: application/json
[ {
  "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"
} ]

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of messages

404

Messages not found ErrorResponse
Up 
get /verifications/{id}/messages/{messageId}
Get a verification's message by ID (verificationsIdMessagesMessageIdGet)

Path parameters

id (required)
Path Parameter — default: null
messageId (required)
Path Parameter — default: null

Return type

_verifications__id__messages_get_200_response_inner

Example data

Content-Type: application/json
{
  "createdAt" : "2022-01-01T00:00:00Z",
  "phoneNumber" : "+12003004000",
  "channel" : "SMS",
  "id" : "id",
  "status" : "status",
  "updatedAt" : "2022-01-01T00:00:00Z"
}

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Message details _verifications__id__messages_get_200_response_inner

404

Verification or message were not found ErrorResponse
Up 
post /verifications/{id}/messages
Add a message to a verification (verificationsIdMessagesPost)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

_verifications__id__messages_get_200_response_inner _verifications__id__messages_get_200_response_inner (required)
Body Parameter —

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Message added successfully

400

Bad request ErrorResponse

404

Not found ErrorResponse

410

Messages can no longer be added to this verification ErrorResponse
Up 
get /verifications/{id}/risk_scores
Get all scores for a verification (verificationsIdRiskScoresGet)

Path parameters

id (required)
Path Parameter — default: null

Return type

array[RiskScores]

Example data

Content-Type: application/json
[ {
  "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"
} ]

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of risk scores

404

Verification not found ErrorResponse
Up 
get /verifications/{id}/verifier_checks
Get all verifier_checks for a verification (verificationsIdVerifierChecksGet)

Path parameters

id (required)
Path Parameter — default: null

Return type

array[_verifications__id__verifier_checks_get_200_response_inner]

Example data

Content-Type: application/json
[ {
  "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"
} ]

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of verifier checks

404

Not found ErrorResponse
Up 
post /verifications/{id}/verifier_checks
Add a verifier_checker to a verification (verificationsIdVerifierChecksPost)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

_verifications__id__verifier_checks_post_request _verifications__id__verifier_checks_post_request (required)
Body Parameter —

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted - check will be run when a document is available

400

Bad request ErrorResponse

410

Verification check can no longer be added to this verification ErrorResponse
Up 
get /verifications/{id}/verifier_checks/{verifierCheckId}
Get a specific verifier checker by ID (verificationsIdVerifierChecksVerifierCheckIdGet)

Path parameters

id (required)
Path Parameter — default: null
verifierCheckId (required)
Path Parameter — default: null

Return type

_verifications__id__verifier_checks_post_request

Example data

Content-Type: application/json
{
  "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"
}

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Verifier checks details _verifications__id__verifier_checks_post_request

404

Verification or verifier check not found ErrorResponse
Up 
post /verifications
Create a new verification (verificationsPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

VerificationRequest VerificationRequest (required)
Body Parameter —

Return type

Verification

Example data

Content-Type: application/json
{
  "documentType" : "US_CA_DL",
  "devices" : [ {
    "displayHeight" : 1080,
    "browserTimeZone" : "America/Los_Angeles",
    "country" : "United States",
    "city" : "Phoenix",
    "browserHeight" : 1080,
    "ipAddressTimeZone" : "America/Los_Angeles",
    "isp" : "COMCAST Cable",
    "latitude" : 33.4484,
    "browserDateTime" : "Thu Oct 10 2024 10:44:55 GMT-0600 (Mountain Daylight Time)",
    "ipAddress" : "192.168.1.1",
    "language" : "en-US",
    "userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
    "operatingSystem" : "Mac OS X 10.15",
    "platform" : "MacIntel",
    "createdAt" : "2022-01-01T00:00:00Z",
    "displayWidth" : 1920,
    "browser" : "Firefox 130.0",
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "region" : "Arizona",
    "browserWidth" : 1920,
    "longitude" : -112.0741
  }, {
    "displayHeight" : 1080,
    "browserTimeZone" : "America/Los_Angeles",
    "country" : "United States",
    "city" : "Phoenix",
    "browserHeight" : 1080,
    "ipAddressTimeZone" : "America/Los_Angeles",
    "isp" : "COMCAST Cable",
    "latitude" : 33.4484,
    "browserDateTime" : "Thu Oct 10 2024 10:44:55 GMT-0600 (Mountain Daylight Time)",
    "ipAddress" : "192.168.1.1",
    "language" : "en-US",
    "userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0",
    "operatingSystem" : "Mac OS X 10.15",
    "platform" : "MacIntel",
    "createdAt" : "2022-01-01T00:00:00Z",
    "displayWidth" : 1920,
    "browser" : "Firefox 130.0",
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "region" : "Arizona",
    "browserWidth" : 1920,
    "longitude" : -112.0741
  } ],
  "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",
  "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"
}

Example data

Content-Type: application/json
{
  "code" : 0,
  "details" : "{}",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Verification created successfully Verification

400

Bad request ErrorResponse

Models

[ Jump to Methods ]

Table of Contents

  1. Device -
  2. DmvVerifierCheck -
  3. DmvVerifierCheck_matches -
  4. Document -
  5. EmailMessage -
  6. ErrorResponse -
  7. MnoVerifierCheck -
  8. MnoVerifierCheck_matches -
  9. RequestedEmailMessage -
  10. RequestedSmsMessage -
  11. RiskScores -
  12. ScanVerifierCheck -
  13. SmsMessage -
  14. Verification -
  15. VerificationRequest -
  16. VerificationRequest_requestedMessages_inner -
  17. _verifications__id__document_get_200_response -
  18. _verifications__id__messages_get_200_response_inner -
  19. _verifications__id__verifier_checks_get_200_response_inner -
  20. _verifications__id__verifier_checks_post_request -

Device - Up

id (optional)
UUID format: uuid
platform (optional)
String
language (optional)
String
browserTimeZone (optional)
String
browserDateTime (optional)
String
userAgent (optional)
String
operatingSystem (optional)
String
browser (optional)
String
displayWidth (optional)
Integer
displayHeight (optional)
Integer
browserWidth (optional)
Integer
browserHeight (optional)
Integer
ipAddress (optional)
String format: ipv4
ipAddressTimeZone (optional)
String
country (optional)
String
region (optional)
String
city (optional)
String
isp (optional)
String
latitude (optional)
BigDecimal
longitude (optional)
BigDecimal
createdAt (optional)
Date format: date-time

DmvVerifierCheck - Up

id (optional)
UUID format: uuid
lastName (optional)
String
documentType (optional)
String
documentNumberSuffix (optional)
String
verifier
String
Enum:
DMV
verifierResult (optional)
String
Enum:
SUCCESS
FAILURE
FATAL
mnoFallback (optional)
Boolean
matches (optional)
DmvVerifierCheck_matches
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time

DmvVerifierCheck_matches - Up

documentNumber (optional)
Boolean
documentType (optional)
Boolean
issueDate (optional)
Boolean
expiryDate (optional)
Boolean
firstName (optional)
Boolean
middleName (optional)
Boolean
middleInitial (optional)
Boolean
lastName (optional)
Boolean
address1 (optional)
Boolean
address2 (optional)
Boolean
city (optional)
Boolean
state (optional)
Boolean
zipCode (optional)
Boolean
zip4 (optional)
Boolean
dateOfBirth (optional)
Boolean
eyeColor (optional)
Boolean
sex (optional)
Boolean
height (optional)
Boolean
weight (optional)
Boolean

Document - Up

id (optional)
UUID format: uuid
documentType (optional)
String
documentNumber (optional)
String
documentNumberSuffix (optional)
String
issueDate (optional)
String
expiryDate (optional)
String
firstName (optional)
String
middleName (optional)
String
middleInitial (optional)
String
lastName (optional)
String
address1 (optional)
String
address2 (optional)
String
city (optional)
String
state (optional)
String
zipCode (optional)
String
zip4 (optional)
String
dateOfBirth (optional)
date format: date
eyeColor (optional)
String
sex (optional)
String
height (optional)
String
weight (optional)
String
age (optional)
String
nationality (optional)
String
issuingAuthority (optional)
String
placeOfBirth (optional)
String
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time

EmailMessage - Up

id (optional)
String
emailAddress
String format: email
channel
String
Enum:
EMAIL
status (optional)
String
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time

ErrorResponse - Up

code (optional)
Integer
message (optional)
String
details (optional)
Object

MnoVerifierCheck - Up

id (optional)
UUID format: uuid
phoneNumber
String
lastName (optional)
String
verifier
String
Enum:
MNO_V
verifierResult (optional)
String
mnoFallback (optional)
Boolean
matches (optional)
MnoVerifierCheck_matches
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time

MnoVerifierCheck_matches - Up

firstName (optional)
Boolean
middleName (optional)
Boolean
middleInitial (optional)
Boolean
lastName (optional)
Boolean
address1 (optional)
Boolean
address2 (optional)
Boolean
city (optional)
Boolean
state (optional)
Boolean
zipCode (optional)
Boolean
zip4 (optional)
Boolean
dateOfBirth (optional)
Boolean

RequestedEmailMessage - Up

emailAddress
String format: email
channel
String
Enum:
EMAIL

RequestedSmsMessage - Up

phoneNumber
String
channel
String
Enum:
SMS

RiskScores - Up

id (optional)
UUID format: uuid
score (optional)
String
rule (optional)
String
reason (optional)
String
ruleType (optional)
String
Enum:
VERIFIER
DEVICE
SCAN
riskyFields (optional)
array[String]
verifier (optional)
String
Enum:
DMV
MNO_V
robotRule (optional)
Boolean
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time

ScanVerifierCheck - Up

id (optional)
UUID format: uuid
lastName (optional)
String
verifier (optional)
String
Enum:
SCAN
verifierResult (optional)
String
mnoFallback (optional)
Boolean
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time

SmsMessage - Up

id (optional)
String
phoneNumber
String
channel
String
Enum:
SMS
status (optional)
String
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time

Verification - Up

id (optional)
UUID format: uuid
agentEmailAddress (optional)
String format: email
documentType (optional)
String
Enum:
US_CA_DL
UK_DL
PASSPORT
linkUrl (optional)
URI format: uri
callbackUrl (optional)
URI format: uri
linkUrlExpiresAt (optional)
Date format: date-time
reviewAccessExpiresAt (optional)
Date format: date-time
portalUrl (optional)
URI format: uri
expiredLinkUrlAccess (optional)
Boolean
expiredReviewAccess (optional)
Boolean
overallRisk (optional)
String
Enum:
false
LOW
MEDIUM
HIGH
status (optional)
String
Enum:
WAITING
SCANNED
EXPIRED
requestedMessages (optional)
array[VerificationRequest_requestedMessages_inner]
devices (optional)
array[Device]
verifierChecks (optional)
array[_verifications__id__verifier_checks_get_200_response_inner]
scores (optional)
array[RiskScores]
messages (optional)
array[_verifications__id__messages_get_200_response_inner]
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time

VerificationRequest - Up

agentEmailAddress
String format: email
documentType
String
Enum:
US_CA_DL
UK_DL
PASSPORT
callbackUrl (optional)
URI format: uri
requestedMessages (optional)
array[VerificationRequest_requestedMessages_inner]

VerificationRequest_requestedMessages_inner - Up

phoneNumber
String
channel
String
Enum:
EMAIL
emailAddress
String format: email

_verifications__id__document_get_200_response - Up

document (optional)
Document

_verifications__id__messages_get_200_response_inner - Up

id (optional)
String
phoneNumber
String
channel
String
Enum:
EMAIL
status (optional)
String
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time
emailAddress
String format: email

_verifications__id__verifier_checks_get_200_response_inner - Up

id (optional)
UUID format: uuid
lastName (optional)
String
verifier
String
Enum:
MNO_V
verifierResult (optional)
String
mnoFallback (optional)
Boolean
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time
documentType (optional)
String
documentNumberSuffix (optional)
String
matches (optional)
MnoVerifierCheck_matches
phoneNumber
String

_verifications__id__verifier_checks_post_request - Up

id (optional)
UUID format: uuid
lastName (optional)
String
documentType (optional)
String
documentNumberSuffix (optional)
String
verifier
String
Enum:
MNO_V
verifierResult (optional)
String
mnoFallback (optional)
Boolean
matches (optional)
MnoVerifierCheck_matches
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time
phoneNumber
String