Verification API

API to manage verifications, messages, checkers, devices, and risk scores.
More information: https://trusona.com
Contact Info: support@trusona.com
Version: 2.2.0
BasePath:
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

Devices

Documents

EncryptedVerifications

Messages

RiskScores

Verifications

Devices

Up 
get /api/v1/verifications/{verificationId}/devices
Get all devices for a verification (getDevices)

Path parameters

verificationId (required)
Path Parameter — default: null format: uuid

Return type

array[VerificationDevice]

Example data

Content-Type: */*
[ {
  "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
  "platform" : "MacIntel",
  "language" : "language",
  "browserTimeZone" : "America/Los_Angeles",
  "origin" : "origin",
  "browserDateTime" : "browserDateTime",
  "userAgent" : "userAgent",
  "operatingSystem" : "operatingSystem",
  "browser" : "browser",
  "displayWidth" : 0,
  "displayHeight" : 6,
  "browserHeight" : 1,
  "browserWidth" : 5,
  "ipAddress" : "192.168.1.1",
  "ipAddressTimeZone" : "ipAddressTimeZone",
  "country" : "country",
  "region" : "region",
  "city" : "city",
  "isp" : "isp",
  "createdAt" : "2022-01-01T00:00:00.000+00:00",
  "latitude" : 5.637377,
  "longitude" : 2.302136,
  "gpsLatitude" : 7.0614014,
  "gpsLongitude" : 9.301444,
  "via" : [ "via", "via" ],
  "offsetMinutes" : 3,
  "epochMilliseconds" : 2,
  "asn" : "asn",
  "dateTime" : "dateTime",
  "browserTimeZoneWithOffset" : "browserTimeZoneWithOffset",
  "scanCode" : "scanCode",
  "linkCode" : "linkCode",
  "scannedDocument" : true,
  "blacklistedNetwork" : true,
  "whitelistedNetwork" : true,
  "truPassUsed" : true,
  "fingerprint" : "fingerprint"
}, {
  "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
  "platform" : "MacIntel",
  "language" : "language",
  "browserTimeZone" : "America/Los_Angeles",
  "origin" : "origin",
  "browserDateTime" : "browserDateTime",
  "userAgent" : "userAgent",
  "operatingSystem" : "operatingSystem",
  "browser" : "browser",
  "displayWidth" : 0,
  "displayHeight" : 6,
  "browserHeight" : 1,
  "browserWidth" : 5,
  "ipAddress" : "192.168.1.1",
  "ipAddressTimeZone" : "ipAddressTimeZone",
  "country" : "country",
  "region" : "region",
  "city" : "city",
  "isp" : "isp",
  "createdAt" : "2022-01-01T00:00:00.000+00:00",
  "latitude" : 5.637377,
  "longitude" : 2.302136,
  "gpsLatitude" : 7.0614014,
  "gpsLongitude" : 9.301444,
  "via" : [ "via", "via" ],
  "offsetMinutes" : 3,
  "epochMilliseconds" : 2,
  "asn" : "asn",
  "dateTime" : "dateTime",
  "browserTimeZoneWithOffset" : "browserTimeZoneWithOffset",
  "scanCode" : "scanCode",
  "linkCode" : "linkCode",
  "scannedDocument" : true,
  "blacklistedNetwork" : true,
  "whitelistedNetwork" : true,
  "truPassUsed" : true,
  "fingerprint" : "fingerprint"
} ]

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

Documents

Up 
get /api/v1/verifications/{verificationId}/document
Get the verification's document (getDocument)
Returns the scanned document data in two forms: 'unmasked' with full PII and 'masked' with sensitive fields partially redacted.

Path parameters

verificationId (required)
Path Parameter — default: null format: uuid

Return type

map[ScanResponse]

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 with masked and unmasked variants. The unmasked variant contains full PII; the masked variant has sensitive fields partially redacted.

404

Verification was not found or document is not yet available

410

Document has been removed (occurs when parent verification expires)
Up 
get /api/v1/verifications/{verificationId}/document/scanned_images
Get the scanned image of the document (getScannedImages)

Path parameters

verificationId (required)
Path Parameter — default: null format: uuid

Return type

array[IdentityImage]

Example data

Content-Type: */*
[ {
  "data" : "data",
  "orientation" : 0
}, {
  "data" : "data",
  "orientation" : 0
} ]

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

404

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

410

Scanned image has been removed (occurs when parent verification expires)

EncryptedVerifications

Up 
post /api/v1/encrypted/verifications
Create a new verification with encrypted response (createEncryptedVerification)
Create a new verification and return the verification data encrypted with the provided encryption key.

Consumes

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

Request body

EncryptedVerificationRequest EncryptedVerificationRequest (required)
Body Parameter —

Return type

EncryptedVerificationResponse

Example data

Content-Type: */*
{
  "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
  "overallRisk" : "NO",
  "encryptedVerification" : "eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2R0NNIn0..."
}

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 with encryption token EncryptedVerificationResponse

400

Bad request - Must be one of RSA, EC or OKP (crv=X25519) type in JWK format

401

Unauthorized

422

Unprocessable entity - validation failed
Up 
get /api/v1/encrypted/verifications/{verificationId}/document
Get an encrypted document by verification ID (getEncryptedDocument)
Get the verification's document and return it encrypted with the same public key provided when the verification was created.

Path parameters

verificationId (required)
Path Parameter — default: null format: uuid

Return type

EncryptedDocumentResponse

Example data

Content-Type: */*
{
  "verificationId" : "10c9207a-1c3d-45fd-874f-a2af9c2d33d4",
  "encryptedDocument" : "eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2R0NNIn0..."
}

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

Encrypted document retrieved successfully EncryptedDocumentResponse

401

Unauthorized

404

Verification not found or document is not yet available

410

Document has been removed (occurs when parent verification expires)
Up 
get /api/v1/encrypted/verifications/{verificationId}
Get an encrypted verification by ID (getEncryptedVerification)

Path parameters

verificationId (required)
Path Parameter — default: null format: uuid

Return type

EncryptedVerificationResponse

Example data

Content-Type: */*
{
  "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
  "overallRisk" : "NO",
  "encryptedVerification" : "eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2R0NNIn0..."
}

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 retrieved successfully EncryptedVerificationResponse

401

Unauthorized

404

Verification not found

Messages

Up 
post /api/v1/verifications/{verificationId}/messages
Add a message to a verification (createMessage)

Path parameters

verificationId (required)
Path Parameter — default: null format: uuid

Consumes

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

Request body

createMessage_request createMessage_request (required)
Body Parameter —

Return type

VerificationMessage

Example data

Content-Type: */*
{
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "status" : "status",
  "createdAt" : "2022-01-01T00:00:00.000+00:00",
  "channel" : "COPY",
  "recipient" : "recipient",
  "simSwapped" : true
}

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 VerificationMessage

400

Bad request

404

Not found

410

Messages can no longer be added to this verification

422

Sim swap was detected for a TRUSTED_SMS

429

Quota limit has been reached
Up 
get /api/v1/verifications/{verificationId}/messages/{verificationMessageId}
Get a verification's message by ID (getMessage)

Path parameters

verificationId (required)
Path Parameter — default: null format: uuid
verificationMessageId (required)
Path Parameter — default: null format: uuid

Return type

VerificationMessage

Example data

Content-Type: */*
{
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "status" : "status",
  "createdAt" : "2022-01-01T00:00:00.000+00:00",
  "channel" : "COPY",
  "recipient" : "recipient",
  "simSwapped" : true
}

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 VerificationMessage

404

Verification or message were not found
Up 
get /api/v1/verifications/{verificationId}/messages
Get all messages for a verification (getMessages)

Path parameters

verificationId (required)
Path Parameter — default: null format: uuid

Return type

array[VerificationMessage]

Example data

Content-Type: */*
[ {
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "status" : "status",
  "createdAt" : "2022-01-01T00:00:00.000+00:00",
  "channel" : "COPY",
  "recipient" : "recipient",
  "simSwapped" : true
}, {
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "status" : "status",
  "createdAt" : "2022-01-01T00:00:00.000+00:00",
  "channel" : "COPY",
  "recipient" : "recipient",
  "simSwapped" : true
} ]

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

RiskScores

Up 
get /api/v1/verifications/{verificationId}/risk_scores
Get all scores for a verification (getRiskScores)

Path parameters

verificationId (required)
Path Parameter — default: null format: uuid

Return type

array[RiskScore]

Example data

Content-Type: */*
[ {
  "ruleType" : "SCAN",
  "id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
  "score" : "NO",
  "rule" : "rule",
  "reason" : "reason",
  "type" : "SCAN",
  "riskyFields" : [ "riskyFields", "riskyFields" ],
  "verifier" : "DMV",
  "riskyDevices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "robotRule" : true,
  "createdAt" : "2022-01-01T00:00:00.000+00:00"
}, {
  "ruleType" : "SCAN",
  "id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
  "score" : "NO",
  "rule" : "rule",
  "reason" : "reason",
  "type" : "SCAN",
  "riskyFields" : [ "riskyFields", "riskyFields" ],
  "verifier" : "DMV",
  "riskyDevices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "robotRule" : true,
  "createdAt" : "2022-01-01T00:00:00.000+00:00"
} ]

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

Verifications

Up 
post /api/v1/verifications
Create a new verification (createVerification)

Consumes

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

Request body

VerificationRequest VerificationRequest (required)
Body Parameter —

Return type

VerificationResponse

Example data

Content-Type: */*
{
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "agentEmailAddress" : "agent@example.com",
  "documentType" : "US_CA_DL",
  "linkUrl" : "https://openapi-generator.tech",
  "callbackUrl" : "https://example.com/callback/unique/to/this/request/8b62142a99ba759d8c9153b68765513c62180891",
  "linkUrlExpiresAt" : "2000-01-23T04:56:07.000+00:00",
  "reviewAccessExpiresAt" : "2000-01-23T04:56:07.000+00:00",
  "createdAt" : "2000-01-23T04:56:07.000+00:00",
  "updatedAt" : "2000-01-23T04:56:07.000+00:00",
  "requestedVerifiers" : [ {
    "verifier" : "DMV"
  }, {
    "verifier" : "MNO_V",
    "phoneNumber" : "+12025551234"
  } ],
  "requestedMessages" : [ {
    "channel" : "SMS",
    "phoneNumber" : "+12025551234"
  }, {
    "channel" : "EMAIL",
    "emailAddress" : "user@example.com"
  } ],
  "status" : "WAITING",
  "closed" : true,
  "expiredReviewAccess" : true,
  "expiredLinkUrlAccess" : true,
  "overallRisk" : "NO",
  "workspaceLink" : "https://openapi-generator.tech",
  "supportedVerifiers" : [ "DMV", "DMV" ],
  "attachments" : [ {
    "attachmentType" : "SERVICENOW"
  }, {
    "attachmentType" : "SERVICENOW"
  } ],
  "verifierChecks" : [ {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "lastName" : "lastName",
    "phoneNumber" : "phoneNumber",
    "documentType" : "US_CA_DL",
    "documentNumberSuffix" : "documentNumberSuffix",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "verifier" : "DMV",
    "verifierResult" : "SUCCESS",
    "phoneNumberSuffix" : "phoneNumberSuffix",
    "phoneNumberCountryCode" : "phoneNumberCountryCode",
    "matches" : "",
    "externalId" : "externalId"
  }, {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "lastName" : "lastName",
    "phoneNumber" : "phoneNumber",
    "documentType" : "US_CA_DL",
    "documentNumberSuffix" : "documentNumberSuffix",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "verifier" : "DMV",
    "verifierResult" : "SUCCESS",
    "phoneNumberSuffix" : "phoneNumberSuffix",
    "phoneNumberCountryCode" : "phoneNumberCountryCode",
    "matches" : "",
    "externalId" : "externalId"
  } ],
  "messages" : [ {
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "status" : "status",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "channel" : "COPY",
    "recipient" : "recipient",
    "simSwapped" : true
  }, {
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "status" : "status",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "channel" : "COPY",
    "recipient" : "recipient",
    "simSwapped" : true
  } ],
  "devices" : [ {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "platform" : "MacIntel",
    "language" : "language",
    "browserTimeZone" : "America/Los_Angeles",
    "origin" : "origin",
    "browserDateTime" : "browserDateTime",
    "userAgent" : "userAgent",
    "operatingSystem" : "operatingSystem",
    "browser" : "browser",
    "displayWidth" : 0,
    "displayHeight" : 6,
    "browserHeight" : 1,
    "browserWidth" : 5,
    "ipAddress" : "192.168.1.1",
    "ipAddressTimeZone" : "ipAddressTimeZone",
    "country" : "country",
    "region" : "region",
    "city" : "city",
    "isp" : "isp",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "latitude" : 5.637377,
    "longitude" : 2.302136,
    "gpsLatitude" : 7.0614014,
    "gpsLongitude" : 9.301444,
    "via" : [ "via", "via" ],
    "offsetMinutes" : 3,
    "epochMilliseconds" : 2,
    "asn" : "asn",
    "dateTime" : "dateTime",
    "browserTimeZoneWithOffset" : "browserTimeZoneWithOffset",
    "scanCode" : "scanCode",
    "linkCode" : "linkCode",
    "scannedDocument" : true,
    "blacklistedNetwork" : true,
    "whitelistedNetwork" : true,
    "truPassUsed" : true,
    "fingerprint" : "fingerprint"
  }, {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "platform" : "MacIntel",
    "language" : "language",
    "browserTimeZone" : "America/Los_Angeles",
    "origin" : "origin",
    "browserDateTime" : "browserDateTime",
    "userAgent" : "userAgent",
    "operatingSystem" : "operatingSystem",
    "browser" : "browser",
    "displayWidth" : 0,
    "displayHeight" : 6,
    "browserHeight" : 1,
    "browserWidth" : 5,
    "ipAddress" : "192.168.1.1",
    "ipAddressTimeZone" : "ipAddressTimeZone",
    "country" : "country",
    "region" : "region",
    "city" : "city",
    "isp" : "isp",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "latitude" : 5.637377,
    "longitude" : 2.302136,
    "gpsLatitude" : 7.0614014,
    "gpsLongitude" : 9.301444,
    "via" : [ "via", "via" ],
    "offsetMinutes" : 3,
    "epochMilliseconds" : 2,
    "asn" : "asn",
    "dateTime" : "dateTime",
    "browserTimeZoneWithOffset" : "browserTimeZoneWithOffset",
    "scanCode" : "scanCode",
    "linkCode" : "linkCode",
    "scannedDocument" : true,
    "blacklistedNetwork" : true,
    "whitelistedNetwork" : true,
    "truPassUsed" : true,
    "fingerprint" : "fingerprint"
  } ],
  "riskScores" : [ {
    "ruleType" : "SCAN",
    "id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
    "score" : "NO",
    "rule" : "rule",
    "reason" : "reason",
    "type" : "SCAN",
    "riskyFields" : [ "riskyFields", "riskyFields" ],
    "verifier" : "DMV",
    "riskyDevices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "robotRule" : true,
    "createdAt" : "2022-01-01T00:00:00.000+00:00"
  }, {
    "ruleType" : "SCAN",
    "id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
    "score" : "NO",
    "rule" : "rule",
    "reason" : "reason",
    "type" : "SCAN",
    "riskyFields" : [ "riskyFields", "riskyFields" ],
    "verifier" : "DMV",
    "riskyDevices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "robotRule" : true,
    "createdAt" : "2022-01-01T00:00:00.000+00:00"
  } ],
  "billable" : true,
  "billableAt" : "2000-01-23T04:56:07.000+00:00",
  "subject" : ""
}

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 VerificationResponse

400

Bad request
Up 
get /api/v1/verifications/{verificationId}
Get verification by ID (getVerification)

Path parameters

verificationId (required)
Path Parameter — default: null format: uuid

Return type

VerificationResponse

Example data

Content-Type: */*
{
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "agentEmailAddress" : "agent@example.com",
  "documentType" : "US_CA_DL",
  "linkUrl" : "https://openapi-generator.tech",
  "callbackUrl" : "https://example.com/callback/unique/to/this/request/8b62142a99ba759d8c9153b68765513c62180891",
  "linkUrlExpiresAt" : "2000-01-23T04:56:07.000+00:00",
  "reviewAccessExpiresAt" : "2000-01-23T04:56:07.000+00:00",
  "createdAt" : "2000-01-23T04:56:07.000+00:00",
  "updatedAt" : "2000-01-23T04:56:07.000+00:00",
  "requestedVerifiers" : [ {
    "verifier" : "DMV"
  }, {
    "verifier" : "MNO_V",
    "phoneNumber" : "+12025551234"
  } ],
  "requestedMessages" : [ {
    "channel" : "SMS",
    "phoneNumber" : "+12025551234"
  }, {
    "channel" : "EMAIL",
    "emailAddress" : "user@example.com"
  } ],
  "status" : "WAITING",
  "closed" : true,
  "expiredReviewAccess" : true,
  "expiredLinkUrlAccess" : true,
  "overallRisk" : "NO",
  "workspaceLink" : "https://openapi-generator.tech",
  "supportedVerifiers" : [ "DMV", "DMV" ],
  "attachments" : [ {
    "attachmentType" : "SERVICENOW"
  }, {
    "attachmentType" : "SERVICENOW"
  } ],
  "verifierChecks" : [ {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "lastName" : "lastName",
    "phoneNumber" : "phoneNumber",
    "documentType" : "US_CA_DL",
    "documentNumberSuffix" : "documentNumberSuffix",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "verifier" : "DMV",
    "verifierResult" : "SUCCESS",
    "phoneNumberSuffix" : "phoneNumberSuffix",
    "phoneNumberCountryCode" : "phoneNumberCountryCode",
    "matches" : "",
    "externalId" : "externalId"
  }, {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "lastName" : "lastName",
    "phoneNumber" : "phoneNumber",
    "documentType" : "US_CA_DL",
    "documentNumberSuffix" : "documentNumberSuffix",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "verifier" : "DMV",
    "verifierResult" : "SUCCESS",
    "phoneNumberSuffix" : "phoneNumberSuffix",
    "phoneNumberCountryCode" : "phoneNumberCountryCode",
    "matches" : "",
    "externalId" : "externalId"
  } ],
  "messages" : [ {
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "status" : "status",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "channel" : "COPY",
    "recipient" : "recipient",
    "simSwapped" : true
  }, {
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "status" : "status",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "channel" : "COPY",
    "recipient" : "recipient",
    "simSwapped" : true
  } ],
  "devices" : [ {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "platform" : "MacIntel",
    "language" : "language",
    "browserTimeZone" : "America/Los_Angeles",
    "origin" : "origin",
    "browserDateTime" : "browserDateTime",
    "userAgent" : "userAgent",
    "operatingSystem" : "operatingSystem",
    "browser" : "browser",
    "displayWidth" : 0,
    "displayHeight" : 6,
    "browserHeight" : 1,
    "browserWidth" : 5,
    "ipAddress" : "192.168.1.1",
    "ipAddressTimeZone" : "ipAddressTimeZone",
    "country" : "country",
    "region" : "region",
    "city" : "city",
    "isp" : "isp",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "latitude" : 5.637377,
    "longitude" : 2.302136,
    "gpsLatitude" : 7.0614014,
    "gpsLongitude" : 9.301444,
    "via" : [ "via", "via" ],
    "offsetMinutes" : 3,
    "epochMilliseconds" : 2,
    "asn" : "asn",
    "dateTime" : "dateTime",
    "browserTimeZoneWithOffset" : "browserTimeZoneWithOffset",
    "scanCode" : "scanCode",
    "linkCode" : "linkCode",
    "scannedDocument" : true,
    "blacklistedNetwork" : true,
    "whitelistedNetwork" : true,
    "truPassUsed" : true,
    "fingerprint" : "fingerprint"
  }, {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "platform" : "MacIntel",
    "language" : "language",
    "browserTimeZone" : "America/Los_Angeles",
    "origin" : "origin",
    "browserDateTime" : "browserDateTime",
    "userAgent" : "userAgent",
    "operatingSystem" : "operatingSystem",
    "browser" : "browser",
    "displayWidth" : 0,
    "displayHeight" : 6,
    "browserHeight" : 1,
    "browserWidth" : 5,
    "ipAddress" : "192.168.1.1",
    "ipAddressTimeZone" : "ipAddressTimeZone",
    "country" : "country",
    "region" : "region",
    "city" : "city",
    "isp" : "isp",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "latitude" : 5.637377,
    "longitude" : 2.302136,
    "gpsLatitude" : 7.0614014,
    "gpsLongitude" : 9.301444,
    "via" : [ "via", "via" ],
    "offsetMinutes" : 3,
    "epochMilliseconds" : 2,
    "asn" : "asn",
    "dateTime" : "dateTime",
    "browserTimeZoneWithOffset" : "browserTimeZoneWithOffset",
    "scanCode" : "scanCode",
    "linkCode" : "linkCode",
    "scannedDocument" : true,
    "blacklistedNetwork" : true,
    "whitelistedNetwork" : true,
    "truPassUsed" : true,
    "fingerprint" : "fingerprint"
  } ],
  "riskScores" : [ {
    "ruleType" : "SCAN",
    "id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
    "score" : "NO",
    "rule" : "rule",
    "reason" : "reason",
    "type" : "SCAN",
    "riskyFields" : [ "riskyFields", "riskyFields" ],
    "verifier" : "DMV",
    "riskyDevices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "robotRule" : true,
    "createdAt" : "2022-01-01T00:00:00.000+00:00"
  }, {
    "ruleType" : "SCAN",
    "id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
    "score" : "NO",
    "rule" : "rule",
    "reason" : "reason",
    "type" : "SCAN",
    "riskyFields" : [ "riskyFields", "riskyFields" ],
    "verifier" : "DMV",
    "riskyDevices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "robotRule" : true,
    "createdAt" : "2022-01-01T00:00:00.000+00:00"
  } ],
  "billable" : true,
  "billableAt" : "2000-01-23T04:56:07.000+00:00",
  "subject" : ""
}

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 VerificationResponse

404

Verification not found
Up 
get /api/v1/verifications
Get verifications since a specific time or verification ID (getVerifications)

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

The since parameter can be either:

Query parameters

since (required)
Query Parameter — default: null
until (optional)
Query Parameter — default: null
count (optional)
Query Parameter — default: 1000 format: int32
page (optional)
Query Parameter — default: 0 format: int32

Return type

array[VerificationResponse]

Example data

Content-Type: */*
[ {
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "agentEmailAddress" : "agent@example.com",
  "documentType" : "US_CA_DL",
  "linkUrl" : "https://openapi-generator.tech",
  "callbackUrl" : "https://example.com/callback/unique/to/this/request/8b62142a99ba759d8c9153b68765513c62180891",
  "linkUrlExpiresAt" : "2000-01-23T04:56:07.000+00:00",
  "reviewAccessExpiresAt" : "2000-01-23T04:56:07.000+00:00",
  "createdAt" : "2000-01-23T04:56:07.000+00:00",
  "updatedAt" : "2000-01-23T04:56:07.000+00:00",
  "requestedVerifiers" : [ {
    "verifier" : "DMV"
  }, {
    "verifier" : "MNO_V",
    "phoneNumber" : "+12025551234"
  } ],
  "requestedMessages" : [ {
    "channel" : "SMS",
    "phoneNumber" : "+12025551234"
  }, {
    "channel" : "EMAIL",
    "emailAddress" : "user@example.com"
  } ],
  "status" : "WAITING",
  "closed" : true,
  "expiredReviewAccess" : true,
  "expiredLinkUrlAccess" : true,
  "overallRisk" : "NO",
  "workspaceLink" : "https://openapi-generator.tech",
  "supportedVerifiers" : [ "DMV", "DMV" ],
  "attachments" : [ {
    "attachmentType" : "SERVICENOW"
  }, {
    "attachmentType" : "SERVICENOW"
  } ],
  "verifierChecks" : [ {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "lastName" : "lastName",
    "phoneNumber" : "phoneNumber",
    "documentType" : "US_CA_DL",
    "documentNumberSuffix" : "documentNumberSuffix",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "verifier" : "DMV",
    "verifierResult" : "SUCCESS",
    "phoneNumberSuffix" : "phoneNumberSuffix",
    "phoneNumberCountryCode" : "phoneNumberCountryCode",
    "matches" : "",
    "externalId" : "externalId"
  }, {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "lastName" : "lastName",
    "phoneNumber" : "phoneNumber",
    "documentType" : "US_CA_DL",
    "documentNumberSuffix" : "documentNumberSuffix",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "verifier" : "DMV",
    "verifierResult" : "SUCCESS",
    "phoneNumberSuffix" : "phoneNumberSuffix",
    "phoneNumberCountryCode" : "phoneNumberCountryCode",
    "matches" : "",
    "externalId" : "externalId"
  } ],
  "messages" : [ {
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "status" : "status",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "channel" : "COPY",
    "recipient" : "recipient",
    "simSwapped" : true
  }, {
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "status" : "status",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "channel" : "COPY",
    "recipient" : "recipient",
    "simSwapped" : true
  } ],
  "devices" : [ {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "platform" : "MacIntel",
    "language" : "language",
    "browserTimeZone" : "America/Los_Angeles",
    "origin" : "origin",
    "browserDateTime" : "browserDateTime",
    "userAgent" : "userAgent",
    "operatingSystem" : "operatingSystem",
    "browser" : "browser",
    "displayWidth" : 0,
    "displayHeight" : 6,
    "browserHeight" : 1,
    "browserWidth" : 5,
    "ipAddress" : "192.168.1.1",
    "ipAddressTimeZone" : "ipAddressTimeZone",
    "country" : "country",
    "region" : "region",
    "city" : "city",
    "isp" : "isp",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "latitude" : 5.637377,
    "longitude" : 2.302136,
    "gpsLatitude" : 7.0614014,
    "gpsLongitude" : 9.301444,
    "via" : [ "via", "via" ],
    "offsetMinutes" : 3,
    "epochMilliseconds" : 2,
    "asn" : "asn",
    "dateTime" : "dateTime",
    "browserTimeZoneWithOffset" : "browserTimeZoneWithOffset",
    "scanCode" : "scanCode",
    "linkCode" : "linkCode",
    "scannedDocument" : true,
    "blacklistedNetwork" : true,
    "whitelistedNetwork" : true,
    "truPassUsed" : true,
    "fingerprint" : "fingerprint"
  }, {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "platform" : "MacIntel",
    "language" : "language",
    "browserTimeZone" : "America/Los_Angeles",
    "origin" : "origin",
    "browserDateTime" : "browserDateTime",
    "userAgent" : "userAgent",
    "operatingSystem" : "operatingSystem",
    "browser" : "browser",
    "displayWidth" : 0,
    "displayHeight" : 6,
    "browserHeight" : 1,
    "browserWidth" : 5,
    "ipAddress" : "192.168.1.1",
    "ipAddressTimeZone" : "ipAddressTimeZone",
    "country" : "country",
    "region" : "region",
    "city" : "city",
    "isp" : "isp",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "latitude" : 5.637377,
    "longitude" : 2.302136,
    "gpsLatitude" : 7.0614014,
    "gpsLongitude" : 9.301444,
    "via" : [ "via", "via" ],
    "offsetMinutes" : 3,
    "epochMilliseconds" : 2,
    "asn" : "asn",
    "dateTime" : "dateTime",
    "browserTimeZoneWithOffset" : "browserTimeZoneWithOffset",
    "scanCode" : "scanCode",
    "linkCode" : "linkCode",
    "scannedDocument" : true,
    "blacklistedNetwork" : true,
    "whitelistedNetwork" : true,
    "truPassUsed" : true,
    "fingerprint" : "fingerprint"
  } ],
  "riskScores" : [ {
    "ruleType" : "SCAN",
    "id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
    "score" : "NO",
    "rule" : "rule",
    "reason" : "reason",
    "type" : "SCAN",
    "riskyFields" : [ "riskyFields", "riskyFields" ],
    "verifier" : "DMV",
    "riskyDevices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "robotRule" : true,
    "createdAt" : "2022-01-01T00:00:00.000+00:00"
  }, {
    "ruleType" : "SCAN",
    "id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
    "score" : "NO",
    "rule" : "rule",
    "reason" : "reason",
    "type" : "SCAN",
    "riskyFields" : [ "riskyFields", "riskyFields" ],
    "verifier" : "DMV",
    "riskyDevices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "robotRule" : true,
    "createdAt" : "2022-01-01T00:00:00.000+00:00"
  } ],
  "billable" : true,
  "billableAt" : "2000-01-23T04:56:07.000+00:00",
  "subject" : ""
}, {
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "agentEmailAddress" : "agent@example.com",
  "documentType" : "US_CA_DL",
  "linkUrl" : "https://openapi-generator.tech",
  "callbackUrl" : "https://example.com/callback/unique/to/this/request/8b62142a99ba759d8c9153b68765513c62180891",
  "linkUrlExpiresAt" : "2000-01-23T04:56:07.000+00:00",
  "reviewAccessExpiresAt" : "2000-01-23T04:56:07.000+00:00",
  "createdAt" : "2000-01-23T04:56:07.000+00:00",
  "updatedAt" : "2000-01-23T04:56:07.000+00:00",
  "requestedVerifiers" : [ {
    "verifier" : "DMV"
  }, {
    "verifier" : "MNO_V",
    "phoneNumber" : "+12025551234"
  } ],
  "requestedMessages" : [ {
    "channel" : "SMS",
    "phoneNumber" : "+12025551234"
  }, {
    "channel" : "EMAIL",
    "emailAddress" : "user@example.com"
  } ],
  "status" : "WAITING",
  "closed" : true,
  "expiredReviewAccess" : true,
  "expiredLinkUrlAccess" : true,
  "overallRisk" : "NO",
  "workspaceLink" : "https://openapi-generator.tech",
  "supportedVerifiers" : [ "DMV", "DMV" ],
  "attachments" : [ {
    "attachmentType" : "SERVICENOW"
  }, {
    "attachmentType" : "SERVICENOW"
  } ],
  "verifierChecks" : [ {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "lastName" : "lastName",
    "phoneNumber" : "phoneNumber",
    "documentType" : "US_CA_DL",
    "documentNumberSuffix" : "documentNumberSuffix",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "verifier" : "DMV",
    "verifierResult" : "SUCCESS",
    "phoneNumberSuffix" : "phoneNumberSuffix",
    "phoneNumberCountryCode" : "phoneNumberCountryCode",
    "matches" : "",
    "externalId" : "externalId"
  }, {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "lastName" : "lastName",
    "phoneNumber" : "phoneNumber",
    "documentType" : "US_CA_DL",
    "documentNumberSuffix" : "documentNumberSuffix",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "verifier" : "DMV",
    "verifierResult" : "SUCCESS",
    "phoneNumberSuffix" : "phoneNumberSuffix",
    "phoneNumberCountryCode" : "phoneNumberCountryCode",
    "matches" : "",
    "externalId" : "externalId"
  } ],
  "messages" : [ {
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "status" : "status",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "channel" : "COPY",
    "recipient" : "recipient",
    "simSwapped" : true
  }, {
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "status" : "status",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "channel" : "COPY",
    "recipient" : "recipient",
    "simSwapped" : true
  } ],
  "devices" : [ {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "platform" : "MacIntel",
    "language" : "language",
    "browserTimeZone" : "America/Los_Angeles",
    "origin" : "origin",
    "browserDateTime" : "browserDateTime",
    "userAgent" : "userAgent",
    "operatingSystem" : "operatingSystem",
    "browser" : "browser",
    "displayWidth" : 0,
    "displayHeight" : 6,
    "browserHeight" : 1,
    "browserWidth" : 5,
    "ipAddress" : "192.168.1.1",
    "ipAddressTimeZone" : "ipAddressTimeZone",
    "country" : "country",
    "region" : "region",
    "city" : "city",
    "isp" : "isp",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "latitude" : 5.637377,
    "longitude" : 2.302136,
    "gpsLatitude" : 7.0614014,
    "gpsLongitude" : 9.301444,
    "via" : [ "via", "via" ],
    "offsetMinutes" : 3,
    "epochMilliseconds" : 2,
    "asn" : "asn",
    "dateTime" : "dateTime",
    "browserTimeZoneWithOffset" : "browserTimeZoneWithOffset",
    "scanCode" : "scanCode",
    "linkCode" : "linkCode",
    "scannedDocument" : true,
    "blacklistedNetwork" : true,
    "whitelistedNetwork" : true,
    "truPassUsed" : true,
    "fingerprint" : "fingerprint"
  }, {
    "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
    "platform" : "MacIntel",
    "language" : "language",
    "browserTimeZone" : "America/Los_Angeles",
    "origin" : "origin",
    "browserDateTime" : "browserDateTime",
    "userAgent" : "userAgent",
    "operatingSystem" : "operatingSystem",
    "browser" : "browser",
    "displayWidth" : 0,
    "displayHeight" : 6,
    "browserHeight" : 1,
    "browserWidth" : 5,
    "ipAddress" : "192.168.1.1",
    "ipAddressTimeZone" : "ipAddressTimeZone",
    "country" : "country",
    "region" : "region",
    "city" : "city",
    "isp" : "isp",
    "createdAt" : "2022-01-01T00:00:00.000+00:00",
    "latitude" : 5.637377,
    "longitude" : 2.302136,
    "gpsLatitude" : 7.0614014,
    "gpsLongitude" : 9.301444,
    "via" : [ "via", "via" ],
    "offsetMinutes" : 3,
    "epochMilliseconds" : 2,
    "asn" : "asn",
    "dateTime" : "dateTime",
    "browserTimeZoneWithOffset" : "browserTimeZoneWithOffset",
    "scanCode" : "scanCode",
    "linkCode" : "linkCode",
    "scannedDocument" : true,
    "blacklistedNetwork" : true,
    "whitelistedNetwork" : true,
    "truPassUsed" : true,
    "fingerprint" : "fingerprint"
  } ],
  "riskScores" : [ {
    "ruleType" : "SCAN",
    "id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
    "score" : "NO",
    "rule" : "rule",
    "reason" : "reason",
    "type" : "SCAN",
    "riskyFields" : [ "riskyFields", "riskyFields" ],
    "verifier" : "DMV",
    "riskyDevices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "robotRule" : true,
    "createdAt" : "2022-01-01T00:00:00.000+00:00"
  }, {
    "ruleType" : "SCAN",
    "id" : "d2392d83-8410-41a7-adcf-a792acde7fb9",
    "score" : "NO",
    "rule" : "rule",
    "reason" : "reason",
    "type" : "SCAN",
    "riskyFields" : [ "riskyFields", "riskyFields" ],
    "verifier" : "DMV",
    "riskyDevices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "robotRule" : true,
    "createdAt" : "2022-01-01T00:00:00.000+00:00"
  } ],
  "billable" : true,
  "billableAt" : "2000-01-23T04:56:07.000+00:00",
  "subject" : ""
} ]

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 verifications retrieved successfully

400

Bad request - invalid since parameter

401

Unauthorized

500

Internal server error

Models

[ Jump to Methods ]

Table of Contents

  1. EncryptedDocumentResponse -
  2. EncryptedVerificationRequest -
  3. EncryptedVerificationResponse -
  4. IdentityImage -
  5. RequestedCopyMessage -
  6. RequestedDmvVerifier -
  7. RequestedEmailMessage -
  8. RequestedLexisNexisVerifier -
  9. RequestedMessage -
  10. RequestedMnoVerifier -
  11. RequestedSmsMessage -
  12. RequestedTrustedSmsMessage -
  13. RequestedVerifier -
  14. RiskScore -
  15. ScanResponse -
  16. ServiceNowAttachment -
  17. TicketNumberAttachment -
  18. VerificationAttachment -
  19. VerificationDevice -
  20. VerificationMessage -
  21. VerificationRequest -
  22. VerificationRequest_requestedVerifiers_inner -
  23. VerificationResponse -
  24. VerificationResponse_attachments_inner -
  25. VerificationSubject -
  26. VerificationSummary -
  27. WorkspaceCallbackAttachment -
  28. createMessage_request -

EncryptedDocumentResponse - Up

verificationId (optional)
UUID The verification ID associated with this document format: uuid
encryptedDocument (optional)
String JWE document object

EncryptedVerificationRequest - Up

id (optional)
UUID format: uuid
agentEmailAddress (optional)
String Email address of the agent or service account that created the verification. Server-derived from the authenticated principal; values supplied by clients are ignored.
documentType
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
linkUrl (optional)
URI format: uri
callbackUrl (optional)
URI format: uri
linkUrlExpiresAt (optional)
Date format: date-time
reviewAccessExpiresAt (optional)
Date format: date-time
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time
requestedVerifiers (optional)
set[VerificationRequest_requestedVerifiers_inner] Set of verifiers to run against this verification. Each entry uses the 'verifier' discriminator field.
subject (optional)
VerificationSubject Optional identity information about the subject of this verification, used by the ExpectedSubjectVerifier to compare against the scanned document.
requestedMessages (optional)
set[createMessage_request] Set of messages to send for this verification. Each entry uses the 'channel' discriminator field. Maximum 2.
status (optional)
String
Enum:
WAITING
SCANNED
EXPIRED
closed (optional)
Boolean
expiredReviewAccess (optional)
Boolean
expiredLinkUrlAccess (optional)
Boolean
publicWebKey (optional)
map[String, Object] Public key used for encrypting the verification response. Must be one of RSA, EC or OKP (crv=X25519) type in JWK format.

EncryptedVerificationResponse - Up

id (optional)
UUID format: uuid
overallRisk (optional)
String
Enum:
NO
LOW
HIGH
encryptedVerification (optional)
String JWE Verification object

IdentityImage - Up

data (optional)
String Base64-encoded image data of the scanned document.
orientation (optional)
Integer Rotation angle in degrees to display the image correctly. format: int32

RequestedCopyMessage - Up

channel
String
Enum:
COPY
SMS
EMAIL
TRUSTED_SMS

RequestedDmvVerifier - Up

Request a DMV (AAMVA) verification.
verifier
String
Enum:
DMV
MNO_V
SCAN

RequestedEmailMessage - Up

Send an email message to the provided email address.
channel
String
Enum:
COPY
SMS
EMAIL
TRUSTED_SMS
emailAddress (optional)
String Email address to send the message to.

RequestedLexisNexisVerifier - Up

Request a LexisNexis verification.
verifier
String
Enum:
DMV
MNO_V
SCAN

RequestedMessage - Up

channel
String
Enum:
COPY
SMS
EMAIL
TRUSTED_SMS

RequestedMnoVerifier - Up

Request an MNO (mobile network operator) verification.
verifier
String
Enum:
DMV
MNO_V
SCAN
phoneNumber (optional)
String Phone number with country code for MNO verification. Must be a USA (+1), Canada (+1), or UK (+44) number.

RequestedSmsMessage - Up

Send an SMS message to the provided phone number.
channel
String
Enum:
COPY
SMS
EMAIL
TRUSTED_SMS
phoneNumber (optional)
String Phone number to send the SMS to.

RequestedTrustedSmsMessage - Up

Send a trusted SMS with SIM swap detection to the provided phone number.
channel
String
Enum:
COPY
SMS
EMAIL
TRUSTED_SMS
phoneNumber (optional)
String Phone number to send the trusted SMS to.

RequestedVerifier - Up

verifier
String
Enum:
DMV
MNO_V
SCAN

RiskScore - Up

ruleType (optional)
String
Enum:
SCAN
DEVICE
VERIFIER
id (optional)
UUID format: uuid
score (optional)
String
Enum:
NO
LOW
HIGH
rule (optional)
String
reason (optional)
String
type (optional)
String
Enum:
SCAN
DEVICE
VERIFIER
riskyFields (optional)
array[String]
verifier (optional)
String
Enum:
DMV
NONE
MNO_V
SCAN
LEXIS
PASSKEY
ESV
riskyDevices (optional)
array[UUID] format: uuid
robotRule (optional)
Boolean
createdAt (optional)
Date format: date-time

ScanResponse - Up

Parsed data from a scanned identity document.
documentNumber (optional)
String Driver license or ID card number.
dateOfBirth (optional)
String Date of birth in MM/DD/YYYY format.
firstName (optional)
String First name as it appears on the document.
age (optional)
String Calculated age at time of scan.
lastName (optional)
String Last name as it appears on the document.
middleName (optional)
String Middle name as it appears on the document.
middleInitial (optional)
String Middle initial derived from the document.
issueDate (optional)
String Document issue date in MM/DD/YYYY format.
expiryDate (optional)
String Document expiration date in MM/DD/YYYY format.
documentType (optional)
String Human-readable type of the scanned document.
sex (optional)
String Sex as it appears on the document.
eyeColor (optional)
String Eye color as it appears on the document.
height (optional)
String Height in inches.
weight (optional)
String Weight in pounds.
address1 (optional)
String Street address line 1.
address2 (optional)
String Street address line 2.
city (optional)
String City name.
state (optional)
String Two-letter state code.
zipCode (optional)
String 5-digit ZIP code.
zip4 (optional)
String ZIP+4 extension.
nationality (optional)
String Nationality from the document.
iso3CountryCode (optional)
String ISO 3166-1 alpha-3 country code.
iso2CountryCode (optional)
String ISO 3166-1 alpha-2 country code.
isoCountryName (optional)
String Full country name.
issuingAuthority (optional)
String Authority that issued the document.
placeOfBirth (optional)
String Place of birth from the document.
verifiedMrz (optional)
Boolean Whether the machine-readable zone (MRZ) was verified.
fullAddress (optional)
String Concatenated full address derived from address1, address2, city, state, and zipCode.
suffix (optional)
String Name suffix from the document (e.g. Jr, Sr).
documentCategory (optional)
String Document category code (e.g. DL, PERMIT, ID).
documentJurisdiction (optional)
String Two-letter state code of the issuing jurisdiction.
phoneNumber (optional)
String Phone number from the document, if available.
version (optional)
String Document scan version.
Enum:
Unknown
V0
V1
V2

ServiceNowAttachment - Up

A ServiceNow ticket attachment.
attachmentType
String
Enum:
SERVICENOW
WORKSPACE_CALLBACKS
GENERIC_TICKET
ticketNumber
String ServiceNow ticket number.

TicketNumberAttachment - Up

A generic ticket number attachment.
attachmentType
String
Enum:
SERVICENOW
WORKSPACE_CALLBACKS
GENERIC_TICKET
ticketNumber
String Ticket number from an external ticketing system.

VerificationAttachment - Up

attachmentType
String
Enum:
SERVICENOW
WORKSPACE_CALLBACKS
GENERIC_TICKET

VerificationDevice - Up

id (optional)
UUID format: uuid
platform (optional)
String Required field
language (optional)
String
browserTimeZone (optional)
String IANA timezone ID (e.g., America/New_York, Europe/London)
origin (optional)
String
browserDateTime (optional)
String
userAgent (optional)
String
operatingSystem (optional)
String
browser (optional)
String
displayWidth (optional)
Integer format: int32
displayHeight (optional)
Integer format: int32
browserHeight (optional)
Integer format: int32
browserWidth (optional)
Integer format: int32
ipAddress (optional)
String
ipAddressTimeZone (optional)
String
country (optional)
String
region (optional)
String
city (optional)
String
isp (optional)
String
createdAt (optional)
Date format: date-time
latitude (optional)
Float format: float
longitude (optional)
Float format: float
gpsLatitude (optional)
Float format: float
gpsLongitude (optional)
Float format: float
via (optional)
array[String]
offsetMinutes
Integer format: int32
epochMilliseconds
Long format: int64
asn (optional)
String
dateTime (optional)
String
browserTimeZoneWithOffset (optional)
String
scanCode (optional)
String
linkCode (optional)
String
scannedDocument (optional)
Boolean
blacklistedNetwork (optional)
Boolean
whitelistedNetwork (optional)
Boolean
truPassUsed (optional)
Boolean
fingerprint (optional)
String

VerificationMessage - Up

id (optional)
UUID format: uuid
status (optional)
String
createdAt (optional)
Date format: date-time
channel (optional)
String
Enum:
COPY
SMS
EMAIL
TRUSTED_SMS
recipient (optional)
String
simSwapped (optional)
Boolean

VerificationRequest - Up

id (optional)
UUID format: uuid
agentEmailAddress (optional)
String Email address of the agent or service account that created the verification. Server-derived from the authenticated principal; values supplied by clients are ignored.
documentType
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
linkUrl (optional)
URI format: uri
callbackUrl (optional)
URI format: uri
linkUrlExpiresAt (optional)
Date format: date-time
reviewAccessExpiresAt (optional)
Date format: date-time
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time
requestedVerifiers (optional)
set[VerificationRequest_requestedVerifiers_inner] Set of verifiers to run against this verification. Each entry uses the 'verifier' discriminator field.
subject (optional)
VerificationSubject Optional identity information about the subject of this verification, used by the ExpectedSubjectVerifier to compare against the scanned document.
requestedMessages (optional)
set[createMessage_request] Set of messages to send for this verification. Each entry uses the 'channel' discriminator field. Maximum 2.
status (optional)
String
Enum:
WAITING
SCANNED
EXPIRED
closed (optional)
Boolean
expiredReviewAccess (optional)
Boolean
expiredLinkUrlAccess (optional)
Boolean

VerificationRequest_requestedVerifiers_inner - Up

verifier
String
Enum:
DMV
MNO_V
SCAN
phoneNumber (optional)
String Phone number with country code for MNO verification. Must be a USA (+1), Canada (+1), or UK (+44) number.

VerificationResponse - Up

id (optional)
UUID format: uuid
agentEmailAddress (optional)
String Email address of the agent or service account that created the verification. Server-derived from the authenticated principal; values supplied by clients are ignored.
documentType
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
linkUrl (optional)
URI format: uri
callbackUrl (optional)
URI format: uri
linkUrlExpiresAt (optional)
Date format: date-time
reviewAccessExpiresAt (optional)
Date format: date-time
createdAt (optional)
Date format: date-time
updatedAt (optional)
Date format: date-time
requestedVerifiers (optional)
set[VerificationRequest_requestedVerifiers_inner] Set of verifiers to run against this verification. Each entry uses the 'verifier' discriminator field.
requestedMessages (optional)
set[createMessage_request] Set of messages to send for this verification. Each entry uses the 'channel' discriminator field. Maximum 2.
status (optional)
String
Enum:
WAITING
SCANNED
EXPIRED
closed (optional)
Boolean
expiredReviewAccess (optional)
Boolean
expiredLinkUrlAccess (optional)
Boolean
overallRisk (optional)
String
Enum:
NO
LOW
HIGH
workspaceLink (optional)
URI format: uri
supportedVerifiers (optional)
set[String]
Enum:
attachments (optional)
array[VerificationResponse_attachments_inner]
verifierChecks (optional)
array[VerificationSummary]
messages (optional)
array[VerificationMessage]
devices (optional)
array[VerificationDevice]
riskScores (optional)
array[RiskScore]
billable (optional)
Boolean
billableAt (optional)
Date format: date-time
subject (optional)
VerificationSubject Optional identity information about the subject of this verification, used by the ExpectedSubjectVerifier to compare against the scanned document.

VerificationResponse_attachments_inner - Up

attachmentType
String
Enum:
SERVICENOW
WORKSPACE_CALLBACKS
GENERIC_TICKET
ticketNumber
String Ticket number from an external ticketing system.
urls
set[URI] format: uri

VerificationSubject - Up

Subject identity information supplied by the API consumer for matching against the scanned document.
firstName (optional)
String Expected first name.
lastName (optional)
String Expected last name.
dateOfBirth (optional)
String Expected date of birth in MM/DD/YYYY format.
city (optional)
String Expected city.
state (optional)
String Expected state, province or region.
country (optional)
String Expected country as ISO 3166-1 alpha-2.

VerificationSummary - Up

id (optional)
UUID format: uuid
lastName (optional)
String
phoneNumber (optional)
String
documentType
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
documentNumberSuffix (optional)
String
createdAt (optional)
Date format: date-time
verifier (optional)
String
Enum:
DMV
MNO_V
SCAN
verifierResult (optional)
String
Enum:
SUCCESS
FAILURE
FATAL
phoneNumberSuffix (optional)
String
phoneNumberCountryCode (optional)
String
matches (optional)
map[String, oas_any_type_not_mapped] Verifier match results. The shape depends on the verifier type: DMV matches include fields like firstName, lastName, dateOfBirth, documentNumber, etc. MNO matches include fields like firstName, lastName, dateOfBirth, phoneNumber, address1, etc. Each field is a boolean indicating whether the value matched the verifier's records. A null value means the field was not available or was not evaluated.
externalId (optional)
String

WorkspaceCallbackAttachment - Up

attachmentType
String
Enum:
SERVICENOW
WORKSPACE_CALLBACKS
GENERIC_TICKET
urls
set[URI] format: uri

createMessage_request - Up

channel
String
Enum:
COPY
SMS
EMAIL
TRUSTED_SMS
emailAddress (optional)
String Email address to send the message to.
phoneNumber (optional)
String Phone number to send the trusted SMS to.