ApplicantWorkflowApiAgentResource

Get a workflow revision by id

Changed on

Returns a single workflow revision by its id. The id identifies one specific revision, not the workflow name as a whole — different revisions of the same workflow have different ids.

get/resources/api/agent/applicantWorkflows/{id}

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/{id}
  • Auth: none declared

Path parameters

idstring required

Id of the workflow revision, as returned by the list endpoint.

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

  • 633f4140e788Revision changes
    • warning

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

  • 6ea8bfe33698Revision changes
    • warning

      added the new HIGH_RISK enum value to the //// response property for the response 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

    • info

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