v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Verification Methods

Get List of Verification Methods

Use this API to retrieve a list of all verification methods for the specified request. The response will include details for each verification method along with the corresponding ID, description, and created date.

get/api/datasubject/v2/requestqueues/{requestQueueRefId}/verificationmethods

Path parameters

requestQueueRefIdstring required

The unique reference ID of the privacy request for which to retrieve verification methods.

Query parameters

includeCommentsboolean required

Set to true to include comments and attachments in the response. If false, only basic verification method information will be returned.

pageinteger

Results page you want to retrieve. Page number starts with 0 (0..N)

sizeinteger

Number of records per page. Maximum page size allowed is 500

sort'createdDate,asc' | 'createdDate,desc' | 'lastModifiedDate,asc' | 'lastModifiedDate,desc'

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.

Response

idstring uuid

The unique identifier for this verification method.

verificationMethodNamestring

The name of the verification method used to verify the data subject's identity.

descriptionstring

A detailed description of how the verification method was applied.

verificationStatus'UNVERIFIED' | 'VERIFIED' | 'REJECTED'

The current status of the verification process.

The type of verification process used.

createdDatestring date-time

The timestamp when this verification method was created.

lastModifiedDatestring date-time

The timestamp when this verification method was last modified.

Example response

[
  {
    "id": "7a275364-d6e2-4581-b95b-843237cb232a",
    "verificationMethodName": "Government ID",
    "description": "Verified government-issued photo ID matched with requester information.",
    "verificationStatus": "VERIFIED",
    "verificationComments": [
      {
        "id": "3b47744c-eebf-44bb-bf4c-680966a448dc",
        "verificationMethodId": "3b47744c-eebf-44bb-bf4c-680966a448dc",
        "comment": "Passport verified with photo matching the requester's profile picture.",
        "lastModifiedDate": "2020-01-08T11:49:48.657Z",
        "type": 1,
        "attachments": [
          {
            "fileName": "sample.txt",
            "fileId": "3b47744c-eebf-44bb-bf4c-680966a448dc",
            "statusId": 10,
            "resourcePath": "/storage/attachments/sample.txt"
          }
        ]
      }
    ],
    "verificationType": "MANUAL",
    "createdDate": "2020-01-03T12:41:13.820Z",
    "lastModifiedDate": "2020-01-03T12:41:13.820Z"
  }
]