Usage Info

This method returns detailed information about a Workflow, including its type, current state, associated Subject Record, and specific workflow details based on type. Use this method to track workflow progress, display workflow information to users, or determine what additional information might be needed to complete the workflow process.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
workflow_id	string	Yes	The ID for the Workflow.

Example

{
  "workflow_id": "w_2dJFFW3HY8a3zOjqwUXhQc"
}

Response

Data

Parameter	Type	Description
workflow	object	The workflow parameter is defined in the tables below.

Workflow Parameters

Parameter	Type	Description
workflow_id	string	The ID for the Workflow.
type	string	The type of Workflow. Must be one of WORKFLOW_TYPES.
subject_record_id	string	The Subject Record to associate with the Workflow. If the value is not supplied then a new Subject Record of the appropriate type is created.
state	string	The state of the Workflow. Must be one of WORKFLOW_STATES.
details	object	One of the Workflow Details object.
started_at	string	The date-time when the Worfkow was started. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
ended_at	string	The date-time when the Workflow was ended. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
created_at	string	The date-time when the Worfkow was created. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
updated_at	string	The date-time when the Workflow was last updated. If there has been no update, the value will be the same as the created_at value. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).

Workflow Details

Workflow Type	Workflow Details
BUSINESS_APPLICATION	Business Application Details

Business Application Details Parameters

Parameter	Type	Description
applying_user	object	The object containing information about the Applying User. This information is used for identification, communication, and authentication.
pricing_model_id	string	The ID of the pricing model to use. Different pricing models allow a single account to allow different rules for determining pricing.
equipment_catalog_id	string	The ID of the equipment collection catalog to use. Equipment collections are created during account setup and is optional.
referrer_id	string	The customer provided value to identify how application was referred, such as a marketplace, website, or sales person.

Applying User Parameters

Parameter	Type	Description
email	string	The email address of the applying user.
first_name	string	The first name of the applying user.
last_name	string	The last name of the applying user.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6OI5blm21ZoSlq0PC3RqJV",
    "version": "2025-03-24"
  },
  "data": {
    "workflow": {
      "workflow_id": "w_2dJFFW3HY8a3zOjqwUXhQc",
      "type": "BUSINESS_APPLICATION",
      "subject_record_id": "sr_163Gh1ONk6BCHF9iYVDHcv",
      "state": "STARTED",
      "details": {
        "business_application_details": {
          "applying_user": {
            "email": "[email protected]"
          },
          "referrer_value": "UAYACG123"
        }
      },
      "started_at": "2025-01-18T07:29:18.472Z",
      "ended_at": "2025-01-18T07:29:18.472Z",
      "created_at": "2025-01-18T07:29:18.472Z",
      "updated_at": "2025-01-18T07:29:18.472Z"
    }
  }
}

Errors

Error Code	HTTP Code	Description
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `workflow_id`provided does not exist.