Update Verification Method

put

https://{hostname}/api/datasubject/v2/requestqueues/{requestQueueRefId}/verificationmethods

Use this API to update an existing verification method for a request.

Path Params

requestQueueRefId

string

required

request queue reference id

Query Params

language

string

Language code

translate

boolean

Defaults to false

Whether to translate the content

Body Params

uuid

The unique identifier for this verification method.

verificationMethodName

string

length between 1 and 100

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

description

string

length ≤ 500

A detailed description of how the verification method was applied.

verificationStatus

string

enum

The current status of the verification process.

Allowed:

verificationComments

array of objects

A list of comments and attachments associated with this verification method. This field is only populated when includeComments is set to true in the request.

verificationComments

verificationType

string

enum

The type of verification process used.

Allowed:

createdDate

date-time

The timestamp when this verification method was created.

lastModifiedDate

date-time

The timestamp when this verification method was last modified.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200OK

429Too Many Requests. For more information, see API Rate Limits.