API docs by Redocly

Verification API (2.2.0)

Download OpenAPI specification:

API Support: support@trusona.com URL: https://trusona.com

Base URL: https://authcloud.trusona.net

API to manage verifications, messages, checkers, devices, and risk scores.

Encrypted Verifications

Create a new verification with encrypted response

Create a new verification and return the verification data encrypted with the provided encryption key.

Authorizations:
bearerAuth
Request Body schema: application/json
required
callbackUrl
string or null <uri>
documentType
required
string
Enum: "US_CA_DL" "UK_DL" "PASSPORT" "INDIA_DL" "INDIA_ID" "INDIA_PAN" "PHILIPPINES_DL" "PHILIPPINES_ID" "PHILIPPINES_MULTI_ID" "US_MILITARY_ID" "US_VETERAN_ID" "SINGAPORE_DL" "SINGAPORE_ID" "SINGAPORE_WORK_PERMIT" "SINGAPORE_EMPLOYMENT_PASS" "PAKISTAN_ID" "AUSTRALIA_DL" "MEXICO_DL" "NETHERLANDS_DL" "US_PERMANENT_RESIDENT_CARD" "GERMANY_ID" "GERMANY_DL" "GERMANY_RESIDENCE_PERMIT" "AUSTRIA_ID" "AUSTRIA_DL" "AUSTRIA_RESIDENCE_PERMIT" "NETHERLANDS_ID" "NETHERLANDS_RESIDENCE_PERMIT" "FRANCE_ID" "FRANCE_DL" "FRANCE_RESIDENCE_PERMIT" "ITALY_ID" "ITALY_DL" "ITALY_RESIDENCE_PERMIT" "SPAIN_ID" "SPAIN_DL" "SPAIN_RESIDENCE_PERMIT" "POLAND_ID" "POLAND_DL" "POLAND_RESIDENCE_PERMIT" "BELGIUM_ID" "BELGIUM_DL" "BELGIUM_RESIDENCE_PERMIT" "SWEDEN_ID" "SWEDEN_DL" "SWEDEN_RESIDENCE_PERMIT" "PORTUGAL_ID" "PORTUGAL_DL" "PORTUGAL_RESIDENCE_PERMIT" "ROMANIA_ID" "ROMANIA_DL" "ROMANIA_RESIDENCE_PERMIT" "IRELAND_DL" "IRELAND_RESIDENCE_PERMIT" "MEXICO_ID" "MEXICO_RESIDENCE_PERMIT" "GUATEMALA_ID" "GUATEMALA_DL" "COSTA_RICA_ID" "COSTA_RICA_DL" "COSTA_RICA_RESIDENCE_PERMIT" "PANAMA_ID" "PANAMA_DL" "PANAMA_RESIDENCE_PERMIT" "EL_SALVADOR_ID" "EL_SALVADOR_DL" "HONDURAS_ID" "HONDURAS_DL" "NICARAGUA_ID" "NICARAGUA_DL" "BRAZIL_ID" "BRAZIL_DL" "BRAZIL_RESIDENCE_PERMIT" "ARGENTINA_ID" "ARGENTINA_DL" "COLOMBIA_ID" "COLOMBIA_DL" "COLOMBIA_RESIDENCE_PERMIT" "CHILE_ID" "CHILE_DL" "PERU_ID" "PERU_DL" "PERU_RESIDENCE_PERMIT" "ECUADOR_ID" "ECUADOR_DL" "BOLIVIA_ID" "BOLIVIA_DL" "PARAGUAY_ID" "PARAGUAY_DL" "URUGUAY_ID" "URUGUAY_DL" "JAPAN_ID" "JAPAN_DL" "JAPAN_RESIDENCE_PERMIT" "SOUTH_KOREA_ID" "SOUTH_KOREA_DL" "SOUTH_KOREA_RESIDENCE_PERMIT" "INDONESIA_ID" "INDONESIA_DL" "MALAYSIA_ID" "MALAYSIA_DL" "MALAYSIA_RESIDENCE_PERMIT" "THAILAND_ID" "THAILAND_DL" "NEW_ZEALAND_DL" "CHINA_ID" "CHINA_DL" "HONG_KONG_ID" "HONG_KONG_DL" "TAIWAN_ID" "TAIWAN_DL" "TAIWAN_RESIDENCE_PERMIT" "VIETNAM_ID" "VIETNAM_DL" "VIETNAM_RESIDENCE_PERMIT"
object

Public key used for encrypting the verification response. Must be one of RSA, EC or OKP (crv=X25519) type in JWK format.

Array of RequestedMessage (object) or RequestedCopyMessage (object) or RequestedEmailMessage (object) or RequestedSmsMessage (object) or RequestedTrustedSmsMessage (object) [ 0 .. 2 ] items unique

Set of messages to send for this verification. Each entry uses the 'channel' discriminator field. Maximum 2.

Array of RequestedVerifier (object) or RequestedDmvVerifier (object) or RequestedLexisNexisVerifier (object) or RequestedMnoVerifier (object) unique

Set of verifiers to run against this verification. Each entry uses the 'verifier' discriminator field.

status
string or null
Value: "CREATED"
subject
null (VerificationSubject)

Optional identity information about the subject of this verification, used by the ExpectedSubjectVerifier to compare against the scanned document.

Responses

Request samples

Content type
application/json
{
  • "callbackUrl": "https://example.com/callback/unique/to/this/request/8b62142a99ba759d8c9153b68765513c62180891",
  • "documentType": "US_CA_DL",
  • "publicWebKey": {
    },
  • "requestedMessages": [
    ],
  • "requestedVerifiers": [
    ],
  • "status": "CREATED",
  • "subject": {
    }
}

Get an encrypted verification by ID

Authorizations:
bearerAuth
path Parameters
verificationId
required
string <uuid>

Responses

Get an encrypted document by verification ID

Get the verification's document and return it encrypted with the same public key provided when the verification was created.

Authorizations:
bearerAuth
path Parameters
verificationId
required
string <uuid>

Responses

Verifications

Get verifications since a specific time or verification ID

Retrieve a collection of verifications that have been created or updated since the specified time or verification ID.

The since parameter can be either:

  • A UUID of a verification (returns verifications created after that verification)
  • An ISO 8601 date-time string (e.g., "2022-01-01T00:00:00Z")
  • A date string in YYYY-MM-DD format
Authorizations:
bearerAuth
query Parameters
since
required
string non-empty
until
string
count
integer <int32>
Default: 1000
page
integer <int32>
Default: 0

Responses

Response samples

Content type
*/*
[
  {
    "agentEmailAddress": "agent@example.com",
    "attachments": [
      {
        "attachmentType": "WORKSPACE_CALLBACKS",
        "urls": []
      }
    ],
    "billable": true,
    "billableAt": "2026-05-05T18:00:31Z",
    "closed": true,
    "createdAt": "2026-05-05T18:00:00Z",
    "devices": [
      {
        "asn": null,
        "blacklistedNetwork": false,
        "browser": "Mobile Safari 18.5",
        "browserDateTime": "Tue May 05 2026 11:00:00 GMT-0700 (Pacific Daylight Time)",
        "browserHeight": 844,
        "browserTimeZone": "America/Los_Angeles",
        "browserTimeZoneWithOffset": "America/Los Angeles (-7)",
        "browserWidth": 390,
        "city": "San Francisco",
        "country": "United States",
        "createdAt": "2026-05-05T18:00:30Z",
        "dateTime": "5/5/2026 09:53",
        "displayHeight": 844,
        "displayWidth": 390,
        "epochMilliseconds": 1778000000000,
        "fingerprint": "abc123def456ghi789jkl012mno345pqr678stu9",
        "gpsLatitude": null,
        "gpsLongitude": null,
        "id": "fb125038-2656-4b51-85ad-6a495876f107",
        "ipAddress": "192.0.2.1",
        "ipAddressTimeZone": "America/Los_Angeles",
        "isp": "Example ISP, Inc.",
        "language": "en-US",
        "latitude": 37.7749,
        "linkCode": "1920",
        "longitude": -122.4194,
        "offsetMinutes": 420,
        "operatingSystem": "iOS 18.5",
        "origin": null,
        "platform": "iPhone",
        "region": "California",
        "scanCode": "123",
        "scannedDocument": true,
        "truPassUsed": false,
        "turnstileError": null,
        "turnstileRobot": null,
        "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Mobile/15E148 Safari/604.1",
        "via": [],
        "whitelistedNetwork": false
      }
    ],
    "documentType": "US_CA_DL",
    "expiredLinkUrlAccess": true,
    "expiredReviewAccess": true,
    "id": "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "linkUrl": "https://verify.example.com/identity/verifications/BD30618F-06D3-45C5-AE52-C36751FC20B2",
    "linkUrlExpiresAt": "2026-05-05T18:15:00Z",
    "messages": [
      {
        "channel": "SMS",
        "createdAt": "2026-05-05T18:00:00Z",
        "id": "f2aafebd-8d41-4366-9ead-59e04931c3a8",
        "recipient": "+12025551234",
        "simSwapped": false,
        "status": "DELIVERED"
      }
    ],
    "overallRisk": "LOW",
    "reviewAccessExpiresAt": "2026-05-05T18:30:00Z",
    "riskScores": [
      {
        "createdAt": "2026-05-05T18:00:31Z",
        "id": "0d98bd5f-7e8d-4430-a048-14775c6e57f9",
        "reason": "VPN/Proxy - using iCloud Private Relay",
        "riskyDevices": [
          "fb125038-2656-4b51-85ad-6a495876f107"
        ],
        "riskyFields": [
          "ipAddress"
        ],
        "robotRule": true,
        "rule": "DEV4D",
        "ruleType": "DEVICE",
        "score": "NO",
        "type": "DEVICE"
      },
      {
        "createdAt": "2026-05-05T18:01:09Z",
        "id": "ad37692c-0e7b-4eeb-a191-f5ce9cd2bb45",
        "reason": "Between 1% and 20% of DMV data is incorrect",
        "riskyDevices": [],
        "riskyFields": [
          "issueDate",
          "expiryDate"
        ],
        "robotRule": false,
        "rule": "VER5A",
        "ruleType": "VERIFIER",
        "score": "LOW",
        "type": "VERIFIER",
        "verifier": "DMV"
      }
    ],
    "status": "SCANNED",
    "supportedVerifiers": [],
    "updatedAt": "2026-05-05T18:01:05Z",
    "verifierChecks": [
      {
        "createdAt": "2026-05-05T18:01:06Z",
        "documentNumberSuffix": "5678",
        "documentType": "US_CA_DL",
        "externalId": "A1.bCDE",
        "id": "7c19e69d-e4b9-4931-87a4-3a277af6fe72",
        "lastName": "SMITH",
        "matches": {
          "address1": true,
          "address2": null,
          "city": true,
          "country": true,
          "dateOfBirth": true,
          "firstName": true,
          "lastName": true,
          "phoneNumber": true,
          "phoneSim": null,
          "state": true,
          "zipCode": true
        },
        "phoneNumber": "+12025551234",
        "phoneNumberCountryCode": "1",
        "phoneNumberSuffix": "1234",
        "verifier": "MNO_V",
        "verifierResult": "SUCCESS"
      },
      {
        "createdAt": "2026-05-05T18:01:09Z",
        "documentNumberSuffix": "5678",
        "documentType": "US_CA_DL",
        "id": "960b7d8a-1c10-4f9d-a2e0-67c68fe688e7",
        "lastName": "SMITH",
        "matches": {
          "address1": true,
          "address2": null,
          "city": true,
          "dateOfBirth": true,
          "documentNumber": true,
          "documentType": true,
          "expiryDate": true,
          "eyeColor": true,
          "firstName": true,
          "height": true,
          "issueDate": true,
          "lastName": true,
          "middleInitial": true,
          "middleName": true,
          "sex": true,
          "state": true,
          "weight": true,
          "zip4": null,
          "zipCode": true
        },
        "verifier": "DMV",
        "verifierResult": "SUCCESS"
      }
    ],
    "workspaceLink": "https://portal.example.com/tenant-id/verifications/bd30618f-06d3-45c5-ae52-c36751fc20b2"
  }
]

Create a new verification

Authorizations:
bearerAuth
Request Body schema: application/json
required
callbackUrl
string or null <uri>
documentType
required
string
Enum: "US_CA_DL" "UK_DL" "PASSPORT" "INDIA_DL" "INDIA_ID" "INDIA_PAN" "PHILIPPINES_DL" "PHILIPPINES_ID" "PHILIPPINES_MULTI_ID" "US_MILITARY_ID" "US_VETERAN_ID" "SINGAPORE_DL" "SINGAPORE_ID" "SINGAPORE_WORK_PERMIT" "SINGAPORE_EMPLOYMENT_PASS" "PAKISTAN_ID" "AUSTRALIA_DL" "MEXICO_DL" "NETHERLANDS_DL" "US_PERMANENT_RESIDENT_CARD" "GERMANY_ID" "GERMANY_DL" "GERMANY_RESIDENCE_PERMIT" "AUSTRIA_ID" "AUSTRIA_DL" "AUSTRIA_RESIDENCE_PERMIT" "NETHERLANDS_ID" "NETHERLANDS_RESIDENCE_PERMIT" "FRANCE_ID" "FRANCE_DL" "FRANCE_RESIDENCE_PERMIT" "ITALY_ID" "ITALY_DL" "ITALY_RESIDENCE_PERMIT" "SPAIN_ID" "SPAIN_DL" "SPAIN_RESIDENCE_PERMIT" "POLAND_ID" "POLAND_DL" "POLAND_RESIDENCE_PERMIT" "BELGIUM_ID" "BELGIUM_DL" "BELGIUM_RESIDENCE_PERMIT" "SWEDEN_ID" "SWEDEN_DL" "SWEDEN_RESIDENCE_PERMIT" "PORTUGAL_ID" "PORTUGAL_DL" "PORTUGAL_RESIDENCE_PERMIT" "ROMANIA_ID" "ROMANIA_DL" "ROMANIA_RESIDENCE_PERMIT" "IRELAND_DL" "IRELAND_RESIDENCE_PERMIT" "MEXICO_ID" "MEXICO_RESIDENCE_PERMIT" "GUATEMALA_ID" "GUATEMALA_DL" "COSTA_RICA_ID" "COSTA_RICA_DL" "COSTA_RICA_RESIDENCE_PERMIT" "PANAMA_ID" "PANAMA_DL" "PANAMA_RESIDENCE_PERMIT" "EL_SALVADOR_ID" "EL_SALVADOR_DL" "HONDURAS_ID" "HONDURAS_DL" "NICARAGUA_ID" "NICARAGUA_DL" "BRAZIL_ID" "BRAZIL_DL" "BRAZIL_RESIDENCE_PERMIT" "ARGENTINA_ID" "ARGENTINA_DL" "COLOMBIA_ID" "COLOMBIA_DL" "COLOMBIA_RESIDENCE_PERMIT" "CHILE_ID" "CHILE_DL" "PERU_ID" "PERU_DL" "PERU_RESIDENCE_PERMIT" "ECUADOR_ID" "ECUADOR_DL" "BOLIVIA_ID" "BOLIVIA_DL" "PARAGUAY_ID" "PARAGUAY_DL" "URUGUAY_ID" "URUGUAY_DL" "JAPAN_ID" "JAPAN_DL" "JAPAN_RESIDENCE_PERMIT" "SOUTH_KOREA_ID" "SOUTH_KOREA_DL" "SOUTH_KOREA_RESIDENCE_PERMIT" "INDONESIA_ID" "INDONESIA_DL" "MALAYSIA_ID" "MALAYSIA_DL" "MALAYSIA_RESIDENCE_PERMIT" "THAILAND_ID" "THAILAND_DL" "NEW_ZEALAND_DL" "CHINA_ID" "CHINA_DL" "HONG_KONG_ID" "HONG_KONG_DL" "TAIWAN_ID" "TAIWAN_DL" "TAIWAN_RESIDENCE_PERMIT" "VIETNAM_ID" "VIETNAM_DL" "VIETNAM_RESIDENCE_PERMIT"
Array of RequestedMessage (object) or RequestedCopyMessage (object) or RequestedEmailMessage (object) or RequestedSmsMessage (object) or RequestedTrustedSmsMessage (object) [ 0 .. 2 ] items unique

Set of messages to send for this verification. Each entry uses the 'channel' discriminator field. Maximum 2.

Array of RequestedVerifier (object) or RequestedDmvVerifier (object) or RequestedLexisNexisVerifier (object) or RequestedMnoVerifier (object) unique

Set of verifiers to run against this verification. Each entry uses the 'verifier' discriminator field.

status
string or null
Value: "CREATED"
subject
null (VerificationSubject)

Optional identity information about the subject of this verification, used by the ExpectedSubjectVerifier to compare against the scanned document.

Responses

Request samples

Content type
application/json
{
  • "callbackUrl": "https://example.com/callback/unique/to/this/request/8b62142a99ba759d8c9153b68765513c62180891",
  • "documentType": "US_CA_DL",
  • "requestedMessages": [
    ],
  • "requestedVerifiers": [
    ],
  • "status": "CREATED",
  • "subject": {
    }
}

Response samples

Content type
*/*
{
  "agentEmailAddress": "agent@example.com",
  "attachments": [
    {
      "attachmentType": "WORKSPACE_CALLBACKS",
      "urls": []
    }
  ],
  "billable": true,
  "billableAt": "2026-05-05T18:00:31Z",
  "closed": true,
  "createdAt": "2026-05-05T18:00:00Z",
  "devices": [
    {
      "asn": null,
      "blacklistedNetwork": false,
      "browser": "Mobile Safari 18.5",
      "browserDateTime": "Tue May 05 2026 11:00:00 GMT-0700 (Pacific Daylight Time)",
      "browserHeight": 844,
      "browserTimeZone": "America/Los_Angeles",
      "browserTimeZoneWithOffset": "America/Los Angeles (-7)",
      "browserWidth": 390,
      "city": "San Francisco",
      "country": "United States",
      "createdAt": "2026-05-05T18:00:30Z",
      "dateTime": "5/5/2026 09:53",
      "displayHeight": 844,
      "displayWidth": 390,
      "epochMilliseconds": 1778000000000,
      "fingerprint": "abc123def456ghi789jkl012mno345pqr678stu9",
      "gpsLatitude": null,
      "gpsLongitude": null,
      "id": "fb125038-2656-4b51-85ad-6a495876f107",
      "ipAddress": "192.0.2.1",
      "ipAddressTimeZone": "America/Los_Angeles",
      "isp": "Example ISP, Inc.",
      "language": "en-US",
      "latitude": 37.7749,
      "linkCode": "1920",
      "longitude": -122.4194,
      "offsetMinutes": 420,
      "operatingSystem": "iOS 18.5",
      "origin": null,
      "platform": "iPhone",
      "region": "California",
      "scanCode": "123",
      "scannedDocument": true,
      "truPassUsed": false,
      "turnstileError": null,
      "turnstileRobot": null,
      "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Mobile/15E148 Safari/604.1",
      "via": [],
      "whitelistedNetwork": false
    }
  ],
  "documentType": "US_CA_DL",
  "expiredLinkUrlAccess": true,
  "expiredReviewAccess": true,
  "id": "bd30618f-06d3-45c5-ae52-c36751fc20b2",
  "linkUrl": "https://verify.example.com/identity/verifications/BD30618F-06D3-45C5-AE52-C36751FC20B2",
  "linkUrlExpiresAt": "2026-05-05T18:15:00Z",
  "messages": [
    {
      "channel": "SMS",
      "createdAt": "2026-05-05T18:00:00Z",
      "id": "f2aafebd-8d41-4366-9ead-59e04931c3a8",
      "recipient": "+12025551234",
      "simSwapped": false,
      "status": "DELIVERED"
    }
  ],
  "overallRisk": "LOW",
  "reviewAccessExpiresAt": "2026-05-05T18:30:00Z",
  "riskScores": [
    {
      "createdAt": "2026-05-05T18:00:31Z",
      "id": "0d98bd5f-7e8d-4430-a048-14775c6e57f9",
      "reason": "VPN/Proxy - using iCloud Private Relay",
      "riskyDevices": [
        "fb125038-2656-4b51-85ad-6a495876f107"
      ],
      "riskyFields": [
        "ipAddress"
      ],
      "robotRule": true,
      "rule": "DEV4D",
      "ruleType": "DEVICE",
      "score": "NO",
      "type": "DEVICE"
    },
    {
      "createdAt": "2026-05-05T18:01:09Z",
      "id": "ad37692c-0e7b-4eeb-a191-f5ce9cd2bb45",
      "reason": "Between 1% and 20% of DMV data is incorrect",
      "riskyDevices": [],
      "riskyFields": [
        "issueDate",
        "expiryDate"
      ],
      "robotRule": false,
      "rule": "VER5A",
      "ruleType": "VERIFIER",
      "score": "LOW",
      "type": "VERIFIER",
      "verifier": "DMV"
    }
  ],
  "status": "SCANNED",
  "supportedVerifiers": [],
  "updatedAt": "2026-05-05T18:01:05Z",
  "verifierChecks": [
    {
      "createdAt": "2026-05-05T18:01:06Z",
      "documentNumberSuffix": "5678",
      "documentType": "US_CA_DL",
      "externalId": "A1.bCDE",
      "id": "7c19e69d-e4b9-4931-87a4-3a277af6fe72",
      "lastName": "SMITH",
      "matches": {
        "address1": true,
        "address2": null,
        "city": true,
        "country": true,
        "dateOfBirth": true,
        "firstName": true,
        "lastName": true,
        "phoneNumber": true,
        "phoneSim": null,
        "state": true,
        "zipCode": true
      },
      "phoneNumber": "+12025551234",
      "phoneNumberCountryCode": "1",
      "phoneNumberSuffix": "1234",
      "verifier": "MNO_V",
      "verifierResult": "SUCCESS"
    },
    {
      "createdAt": "2026-05-05T18:01:09Z",
      "documentNumberSuffix": "5678",
      "documentType": "US_CA_DL",
      "id": "960b7d8a-1c10-4f9d-a2e0-67c68fe688e7",
      "lastName": "SMITH",
      "matches": {
        "address1": true,
        "address2": null,
        "city": true,
        "dateOfBirth": true,
        "documentNumber": true,
        "documentType": true,
        "expiryDate": true,
        "eyeColor": true,
        "firstName": true,
        "height": true,
        "issueDate": true,
        "lastName": true,
        "middleInitial": true,
        "middleName": true,
        "sex": true,
        "state": true,
        "weight": true,
        "zip4": null,
        "zipCode": true
      },
      "verifier": "DMV",
      "verifierResult": "SUCCESS"
    }
  ],
  "workspaceLink": "https://portal.example.com/tenant-id/verifications/bd30618f-06d3-45c5-ae52-c36751fc20b2"
}

Get verification by ID

Authorizations:
bearerAuth
path Parameters
verificationId
required
string <uuid>

Responses

Response samples

Content type
*/*
{
  "agentEmailAddress": "agent@example.com",
  "attachments": [
    {
      "attachmentType": "WORKSPACE_CALLBACKS",
      "urls": []
    }
  ],
  "billable": true,
  "billableAt": "2026-05-05T18:00:31Z",
  "closed": true,
  "createdAt": "2026-05-05T18:00:00Z",
  "devices": [
    {
      "asn": null,
      "blacklistedNetwork": false,
      "browser": "Mobile Safari 18.5",
      "browserDateTime": "Tue May 05 2026 11:00:00 GMT-0700 (Pacific Daylight Time)",
      "browserHeight": 844,
      "browserTimeZone": "America/Los_Angeles",
      "browserTimeZoneWithOffset": "America/Los Angeles (-7)",
      "browserWidth": 390,
      "city": "San Francisco",
      "country": "United States",
      "createdAt": "2026-05-05T18:00:30Z",
      "dateTime": "5/5/2026 09:53",
      "displayHeight": 844,
      "displayWidth": 390,
      "epochMilliseconds": 1778000000000,
      "fingerprint": "abc123def456ghi789jkl012mno345pqr678stu9",
      "gpsLatitude": null,
      "gpsLongitude": null,
      "id": "fb125038-2656-4b51-85ad-6a495876f107",
      "ipAddress": "192.0.2.1",
      "ipAddressTimeZone": "America/Los_Angeles",
      "isp": "Example ISP, Inc.",
      "language": "en-US",
      "latitude": 37.7749,
      "linkCode": "1920",
      "longitude": -122.4194,
      "offsetMinutes": 420,
      "operatingSystem": "iOS 18.5",
      "origin": null,
      "platform": "iPhone",
      "region": "California",
      "scanCode": "123",
      "scannedDocument": true,
      "truPassUsed": false,
      "turnstileError": null,
      "turnstileRobot": null,
      "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Mobile/15E148 Safari/604.1",
      "via": [],
      "whitelistedNetwork": false
    }
  ],
  "documentType": "US_CA_DL",
  "expiredLinkUrlAccess": true,
  "expiredReviewAccess": true,
  "id": "bd30618f-06d3-45c5-ae52-c36751fc20b2",
  "linkUrl": "https://verify.example.com/identity/verifications/BD30618F-06D3-45C5-AE52-C36751FC20B2",
  "linkUrlExpiresAt": "2026-05-05T18:15:00Z",
  "messages": [
    {
      "channel": "SMS",
      "createdAt": "2026-05-05T18:00:00Z",
      "id": "f2aafebd-8d41-4366-9ead-59e04931c3a8",
      "recipient": "+12025551234",
      "simSwapped": false,
      "status": "DELIVERED"
    }
  ],
  "overallRisk": "LOW",
  "reviewAccessExpiresAt": "2026-05-05T18:30:00Z",
  "riskScores": [
    {
      "createdAt": "2026-05-05T18:00:31Z",
      "id": "0d98bd5f-7e8d-4430-a048-14775c6e57f9",
      "reason": "VPN/Proxy - using iCloud Private Relay",
      "riskyDevices": [
        "fb125038-2656-4b51-85ad-6a495876f107"
      ],
      "riskyFields": [
        "ipAddress"
      ],
      "robotRule": true,
      "rule": "DEV4D",
      "ruleType": "DEVICE",
      "score": "NO",
      "type": "DEVICE"
    },
    {
      "createdAt": "2026-05-05T18:01:09Z",
      "id": "ad37692c-0e7b-4eeb-a191-f5ce9cd2bb45",
      "reason": "Between 1% and 20% of DMV data is incorrect",
      "riskyDevices": [],
      "riskyFields": [
        "issueDate",
        "expiryDate"
      ],
      "robotRule": false,
      "rule": "VER5A",
      "ruleType": "VERIFIER",
      "score": "LOW",
      "type": "VERIFIER",
      "verifier": "DMV"
    }
  ],
  "status": "SCANNED",
  "supportedVerifiers": [],
  "updatedAt": "2026-05-05T18:01:05Z",
  "verifierChecks": [
    {
      "createdAt": "2026-05-05T18:01:06Z",
      "documentNumberSuffix": "5678",
      "documentType": "US_CA_DL",
      "externalId": "A1.bCDE",
      "id": "7c19e69d-e4b9-4931-87a4-3a277af6fe72",
      "lastName": "SMITH",
      "matches": {
        "address1": true,
        "address2": null,
        "city": true,
        "country": true,
        "dateOfBirth": true,
        "firstName": true,
        "lastName": true,
        "phoneNumber": true,
        "phoneSim": null,
        "state": true,
        "zipCode": true
      },
      "phoneNumber": "+12025551234",
      "phoneNumberCountryCode": "1",
      "phoneNumberSuffix": "1234",
      "verifier": "MNO_V",
      "verifierResult": "SUCCESS"
    },
    {
      "createdAt": "2026-05-05T18:01:09Z",
      "documentNumberSuffix": "5678",
      "documentType": "US_CA_DL",
      "id": "960b7d8a-1c10-4f9d-a2e0-67c68fe688e7",
      "lastName": "SMITH",
      "matches": {
        "address1": true,
        "address2": null,
        "city": true,
        "dateOfBirth": true,
        "documentNumber": true,
        "documentType": true,
        "expiryDate": true,
        "eyeColor": true,
        "firstName": true,
        "height": true,
        "issueDate": true,
        "lastName": true,
        "middleInitial": true,
        "middleName": true,
        "sex": true,
        "state": true,
        "weight": true,
        "zip4": null,
        "zipCode": true
      },
      "verifier": "DMV",
      "verifierResult": "SUCCESS"
    }
  ],
  "workspaceLink": "https://portal.example.com/tenant-id/verifications/bd30618f-06d3-45c5-ae52-c36751fc20b2"
}

Devices

Get all devices for a verification

Authorizations:
bearerAuth
path Parameters
verificationId
required
string <uuid>

Responses

Response samples

Content type
*/*
[
  {
    "asn": null,
    "blacklistedNetwork": false,
    "browser": "Mobile Safari 18.5",
    "browserDateTime": "Tue May 05 2026 11:00:00 GMT-0700 (Pacific Daylight Time)",
    "browserHeight": 844,
    "browserTimeZone": "America/Los_Angeles",
    "browserTimeZoneWithOffset": "America/Los Angeles (-7)",
    "browserWidth": 390,
    "city": "San Francisco",
    "country": "United States",
    "createdAt": "2026-05-05T18:00:30Z",
    "dateTime": "5/5/2026 09:53",
    "displayHeight": 844,
    "displayWidth": 390,
    "epochMilliseconds": 1778000000000,
    "fingerprint": "abc123def456ghi789jkl012mno345pqr678stu9",
    "gpsLatitude": null,
    "gpsLongitude": null,
    "id": "fb125038-2656-4b51-85ad-6a495876f107",
    "ipAddress": "192.0.2.1",
    "ipAddressTimeZone": "America/Los_Angeles",
    "isp": "Example ISP, Inc.",
    "language": "en-US",
    "latitude": 37.7749,
    "linkCode": "1920",
    "longitude": -122.4194,
    "offsetMinutes": 420,
    "operatingSystem": "iOS 18.5",
    "origin": null,
    "platform": "iPhone",
    "region": "California",
    "scanCode": "123",
    "scannedDocument": true,
    "truPassUsed": false,
    "turnstileError": null,
    "turnstileRobot": null,
    "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Mobile/15E148 Safari/604.1",
    "via": [],
    "whitelistedNetwork": false
  }
]

Documents

Get the verification's document

Returns the scanned document data in two forms: 'unmasked' with full PII and 'masked' with sensitive fields partially redacted.

Authorizations:
bearerAuth
path Parameters
verificationId
required
string <uuid>

Responses

Response samples

Content type
*/*
{
  "MASKED": {
    "address1": "123*******",
    "address2": null,
    "age": "**********",
    "city": "LOS*******",
    "dateOfBirth": "03/*******",
    "documentCategory": null,
    "documentJurisdiction": null,
    "documentNumber": "D12*******",
    "documentType": "Driver License",
    "expiryDate": "03/*******",
    "eyeColor": "**********",
    "firstName": "JANE",
    "fullAddress": "123*******",
    "height": "**********",
    "iso2CountryCode": "U*********",
    "iso3CountryCode": "U*********",
    "isoCountryName": "United States of America",
    "issueDate": "06/*******",
    "issuingAuthority": null,
    "lastName": "SMITH",
    "middleInitial": "M",
    "middleName": "MARIE",
    "nationality": "UNI*******",
    "phoneNumber": null,
    "placeOfBirth": null,
    "sex": "**********",
    "state": "C*********",
    "suffix": null,
    "verifiedMrz": null,
    "version": "V1",
    "weight": "**********",
    "zip4": null,
    "zipCode": "900*******"
  },
  "UNMASKED": {
    "address1": "123 MAIN ST",
    "address2": null,
    "age": "36",
    "city": "LOS ANGELES",
    "dateOfBirth": "03/15/1990",
    "documentCategory": null,
    "documentJurisdiction": null,
    "documentNumber": "D12345678",
    "documentType": "Driver License",
    "expiryDate": "03/15/2028",
    "eyeColor": "Brown",
    "firstName": "JANE",
    "fullAddress": "123 MAIN ST, LOS ANGELES, CA, 90001",
    "height": "64",
    "iso2CountryCode": "US",
    "iso3CountryCode": "USA",
    "isoCountryName": "United States of America",
    "issueDate": "06/01/2020",
    "issuingAuthority": null,
    "lastName": "SMITH",
    "middleInitial": "M",
    "middleName": "MARIE",
    "nationality": "UNITED STATES OF AMERICA",
    "phoneNumber": null,
    "placeOfBirth": null,
    "sex": "Female",
    "state": "CA",
    "suffix": null,
    "verifiedMrz": null,
    "version": "V1",
    "weight": "130",
    "zip4": null,
    "zipCode": "90001"
  }
}

Get the scanned image of the document

Authorizations:
bearerAuth
path Parameters
verificationId
required
string <uuid>

Responses

Messages

Get all messages for a verification

Authorizations:
bearerAuth
path Parameters
verificationId
required
string <uuid>

Responses

Response samples

Content type
*/*
[
  {
    "channel": "SMS",
    "createdAt": "2026-05-05T18:00:00Z",
    "id": "f2aafebd-8d41-4366-9ead-59e04931c3a8",
    "recipient": "+12025551234",
    "simSwapped": false,
    "status": "DELIVERED"
  }
]

Add a message to a verification

Authorizations:
bearerAuth
path Parameters
verificationId
required
string <uuid>
Request Body schema: application/json
required
One of
channel
required
string

Responses

Request samples

Content type
application/json
Example
{
  • "channel": "COPY"
}

Response samples

Content type
*/*
{
  "channel": "SMS",
  "createdAt": "2026-05-05T18:00:00Z",
  "id": "f2aafebd-8d41-4366-9ead-59e04931c3a8",
  "recipient": "+12025551234",
  "simSwapped": false,
  "status": "DELIVERED"
}

Get a verification's message by ID

Authorizations:
bearerAuth
path Parameters
verificationId
required
string <uuid>
verificationMessageId
required
string <uuid>

Responses

Risk Scores

Get all scores for a verification

Authorizations:
bearerAuth
path Parameters
verificationId
required
string <uuid>

Responses

Response samples

Content type
*/*
[
  {
    "createdAt": "2026-05-05T18:00:31Z",
    "id": "0d98bd5f-7e8d-4430-a048-14775c6e57f9",
    "reason": "VPN/Proxy - using iCloud Private Relay",
    "riskyDevices": [
      "fb125038-2656-4b51-85ad-6a495876f107"
    ],
    "riskyFields": [
      "ipAddress"
    ],
    "robotRule": true,
    "rule": "DEV4D",
    "ruleType": "DEVICE",
    "score": "NO",
    "type": "DEVICE"
  },
  {
    "createdAt": "2026-05-05T18:01:09Z",
    "id": "ad37692c-0e7b-4eeb-a191-f5ce9cd2bb45",
    "reason": "Between 1% and 20% of DMV data is incorrect",
    "riskyDevices": [],
    "riskyFields": [
      "issueDate",
      "expiryDate"
    ],
    "robotRule": false,
    "rule": "VER5A",
    "ruleType": "VERIFIER",
    "score": "LOW",
    "type": "VERIFIER",
    "verifier": "DMV"
  }
]