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 (handleIndex3)

Path parameters

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

Query parameters

securityContext (required)
Query Parameter — default: null

Return type

array[VerificationDevice]

Example data

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

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 (handleDocument)

Path parameters

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

Query parameters

securityContext (required)
Query Parameter — default: null

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

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 (handleScannedImages)

Path parameters

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

Query parameters

securityContext (required)
Query Parameter — default: null

Return type

array[IdentityImage]

Example data

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

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 
get /api/v1/encrypted/verifications/{verificationId}
Get an encrypted verification by ID (handleGet2)

Path parameters

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

Query parameters

securityContext (required)
Query Parameter — default: null

Return type

EncryptedVerificationResponse

Example data

Content-Type: application/json
{
  "overallRisk" : "NONE",
  "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2",
  "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
Up 
post /api/v1/encrypted/verifications
Create a new verification with encrypted response (handlePost2)
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 —

Query parameters

securityContext (required)
Query Parameter — default: null

Return type

EncryptedVerificationResponse

Example data

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

Example data

Content-Type: application/json
{
  "error" : "error"
}

Example data

Content-Type: application/json
{
  "error" : "error"
}

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 ErrorResponse

401

Unauthorized

422

Unprocessable entity - validation failed ErrorResponse

Messages

Up 
get /api/v1/verifications/{verificationId}/messages/{verificationMessageId}
Get a verification's message by ID (handleGet1)

Path parameters

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

Query parameters

securityContext (required)
Query Parameter — default: null

Return type

VerificationMessage

Example data

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

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 (handleIndex1)

Path parameters

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

Query parameters

securityContext (required)
Query Parameter — default: null

Return type

array[VerificationMessage]

Example data

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

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
Up 
post /api/v1/verifications/{verificationId}/messages
Add a message to a verification (handlePost1)

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

handlePost_1_request handlePost_1_request (required)
Body Parameter —

Query parameters

securityContext (required)
Query Parameter — default: null

Return type

VerificationMessage

Example data

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

Example data

Content-Type: application/json
{
  "error" : "error"
}

Example data

Content-Type: application/json
{
  "error" : "error"
}

Example data

Content-Type: application/json
{
  "error" : "error"
}

Example data

Content-Type: application/json
{
  "error" : "error"
}

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 ErrorResponse

404

Not found

410

Messages can no longer be added to this verification ErrorResponse

422

Sim swap was detected for a TRUSTED_SMS ErrorResponse

429

Quota limit has been reached ErrorResponse

RiskScores

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

Path parameters

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

Query parameters

securityContext (required)
Query Parameter — default: null

Return type

array[RiskScore]

Example data

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

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 
get /api/v1/verifications/{verificationId}
Get verification by ID (handleGet)

Path parameters

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

Query parameters

securityContext (required)
Query Parameter — default: null

Return type

VerificationResponse

Example data

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

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 (handleIndex)

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

securityContext (required)
Query Parameter — default: null
since (required)
Query Parameter — default: null
until (optional)
Query Parameter — default: null

Return type

array[VerificationResponse]

Example data

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

Example data

Content-Type: application/json
{
  "error" : "error"
}

Example data

Content-Type: application/json
{
  "error" : "error"
}

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 ErrorResponse

401

Unauthorized

500

Internal server error ErrorResponse
Up 
post /api/v1/verifications
Create a new verification (handlePost)

Consumes

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

Request body

VerificationRequest VerificationRequest (required)
Body Parameter —

Query parameters

securityContext (required)
Query Parameter — default: null

Return type

VerificationResponse

Example data

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

Example data

Content-Type: application/json
{
  "error" : "error"
}

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 ErrorResponse

Models

[ Jump to Methods ]

Table of Contents

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

CredentialIdentityMetadata - Up

identifier (optional)
String
created (optional)
Date format: date-time
lastUsed (optional)
Date format: date-time

EncryptedVerificationRequest - Up

id (optional)
UUID format: uuid
agentEmailAddress (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
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]
requestedMessages (optional)
set[handlePost_1_request]
status (optional)
String
Enum:
CREATED
WAITING
SCANNED
EXPIRED
VERIFIED_PASSKEY
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.
closed (optional)
Boolean
expiredReviewAccess (optional)
Boolean
expiredLinkUrlAccess (optional)
Boolean

EncryptedVerificationResponse - Up

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

ErrorResponse - Up

error (optional)
String

IdentityImage - Up

data (optional)
String
orientation (optional)
Integer format: int32

RequestedCopyMessage - Up

channel
String
Enum:
COPY
SMS
EMAIL
TRUSTED_SMS

RequestedDmvVerifier - Up

verifier
String
Enum:
DMV
NONE
MNO_V
SCAN
LEXIS
PASSKEY

RequestedEmailMessage - Up

channel
String
Enum:
COPY
SMS
EMAIL
TRUSTED_SMS
emailAddress (optional)
String

RequestedLexisNexisVerifier - Up

verifier
String
Enum:
DMV
NONE
MNO_V
SCAN
LEXIS
PASSKEY

RequestedMessage - Up

channel
String
Enum:
COPY
SMS
EMAIL
TRUSTED_SMS

RequestedMnoVerifier - Up

verifier
String
Enum:
DMV
NONE
MNO_V
SCAN
LEXIS
PASSKEY
phoneNumber (optional)
String

RequestedSmsMessage - Up

channel
String
Enum:
COPY
SMS
EMAIL
TRUSTED_SMS
phoneNumber (optional)
String

RequestedTrustedSmsMessage - Up

channel
String
Enum:
COPY
SMS
EMAIL
TRUSTED_SMS
phoneNumber (optional)
String

RequestedVerifier - Up

verifier
String
Enum:
DMV
NONE
MNO_V
SCAN
LEXIS
PASSKEY

RiskScore - Up

ruleType (optional)
String
Enum:
SCAN
DEVICE
VERIFIER
id (optional)
UUID format: uuid
score (optional)
String
Enum:
NONE
NO
LOW
MEDIUM
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
riskyDevices (optional)
array[UUID] format: uuid
robotRule (optional)
Boolean
createdAt (optional)
Date format: date-time

ScanResponse - Up

documentNumber (optional)
String
dateOfBirth (optional)
String
firstName (optional)
String
age (optional)
String
lastName (optional)
String
middleName (optional)
String
middleInitial (optional)
String
issueDate (optional)
String
expiryDate (optional)
String
documentType (optional)
String
sex (optional)
String
eyeColor (optional)
String
height (optional)
String
weight (optional)
String
address1 (optional)
String
address2 (optional)
String
city (optional)
String
state (optional)
String
zipCode (optional)
String
zip4 (optional)
String
nationality (optional)
String
iso3CountryCode (optional)
String
iso2CountryCode (optional)
String
isoCountryName (optional)
String
issuingAuthority (optional)
String
placeOfBirth (optional)
String
verifiedMrz (optional)
Boolean
fullAddress (optional)
String
suffix (optional)
String
documentCategory (optional)
String
documentJurisdiction (optional)
String
phoneNumber (optional)
String
version (optional)
String
Enum:
Unknown
V0
V1
V2

ServiceNowAttachment - Up

attachmentType
String
Enum:
SERVICENOW
WORKSPACE_CALLBACKS
GENERIC_TICKET
ticketNumber
String

TicketNumberAttachment - Up

attachmentType
String
Enum:
SERVICENOW
WORKSPACE_CALLBACKS
GENERIC_TICKET
ticketNumber
String

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
whitelistedNetwork (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
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]
requestedMessages (optional)
set[handlePost_1_request]
status (optional)
String
Enum:
CREATED
WAITING
SCANNED
EXPIRED
VERIFIED_PASSKEY
closed (optional)
Boolean
expiredReviewAccess (optional)
Boolean
expiredLinkUrlAccess (optional)
Boolean

VerificationRequest_requestedVerifiers_inner - Up

verifier
String
Enum:
DMV
NONE
MNO_V
SCAN
LEXIS
PASSKEY
phoneNumber (optional)
String

VerificationResponse - Up

id (optional)
UUID format: uuid
agentEmailAddress (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
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]
requestedMessages (optional)
set[handlePost_1_request]
status (optional)
String
Enum:
CREATED
WAITING
SCANNED
EXPIRED
VERIFIED_PASSKEY
closed (optional)
Boolean
expiredReviewAccess (optional)
Boolean
expiredLinkUrlAccess (optional)
Boolean
overallRisk (optional)
String
Enum:
NONE
NO
LOW
MEDIUM
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]
behaviors (optional)
map[String, Boolean]
credentialMetadata (optional)
CredentialIdentityMetadata

VerificationResponse_attachments_inner - Up

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

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
NONE
MNO_V
SCAN
LEXIS
PASSKEY
verifierResult (optional)
String
Enum:
SUCCESS
FAILURE
FATAL
UNSUPPORTED_JURISDICTION
phoneNumberSuffix (optional)
String
phoneNumberCountryCode (optional)
String
aiResponse (optional)
map[String, Object]
matches (optional)
Object
externalId (optional)
String

WorkspaceCallbackAttachment - Up

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

handlePost_1_request - Up

channel
String
Enum:
COPY
SMS
EMAIL
TRUSTED_SMS
emailAddress (optional)
String
phoneNumber (optional)
String