Skip to main content

Request Update

Use this endpoint to generate a link that allows the end user to update information related to their verification, such as:

  • Uploading a POA document
  • Performing a Risk Assessment
  • Answering a Questionnaire
limitation

If you have already requested updated information, this option will remain unavailable until the verification is re-approved.

Attempting to generate a second update request while one is pending will result in an error.

To check if a Request Update is already in progress, look for the status indicator on the verification dashboard.

Request update example

Request additional information from client

Authorizations:
apiKeyPair
path Parameters
scanRef
required
string
Request Body schema: application/json
lifetime
integer [ 0 .. 2592000 ]
Default: 86400
questionnaire
string non-empty
riskAssessmentProfile
string <uuid>
additionalStepUploadRequired
boolean

Responses

Request samples

Content type
application/json
{
  • "lifetime": 86400,
  • "questionnaire": "string",
  • "riskAssessmentProfile": "f1134af8-9174-4c88-9bd1-75f26a322e89",
  • "additionalStepUploadRequired": true
}

Response samples

Content type
application/json
{}