ApplicantWorkflowApiAgentResource

Validate a workflow without saving

Changed on

Checks a workflow definition and returns it with the notices list populated, without storing anything. Use it to preview the warnings and errors a definition would produce before you save or publish it. This is a read-only, dry-run operation.

post/resources/api/agent/applicantWorkflows/-/validate

Request

  • Base URL: https://api.sumsub.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.sumsub.com/resources/api/agent/applicantWorkflows/-/validate
  • Auth: none declared

Request body

name'default' | 'test' | 'actions' required

Workflow name shared by every revision of the same workflow.

Response

default response

clientIdstring

Identifier of the client that owns this workflow.

idstring
namestring

Workflow name shared by every revision of the same workflow.

revisioninteger

Revision number within the workflow; increases with each new revision.

revisionStatusstring

Current status of this revision.

titlestring

Display title of the workflow.

Changes

    • warning

      added the new SUSPICIOUS_DOCUMENT enum value to the //// response property for the response status

    • info

      added the new SUSPICIOUS_DOCUMENT enum value to the request property ////

    • warning

      added the new HIGH_RISK enum value to the //// response property for the response status

    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////

    • info

      added the new optional request property //////

    • info

      added the new optional request property /////

    • info

      added the new HIGH_RISK enum value to the request property ////

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property // to the response with the status