---
title: "Get a Workflow Session"
method: GET
path: "/workflow_sessions/{workflowSessionId}"
tags: ["Workflow Session"]
---

# Get a Workflow Session

`GET /workflow_sessions/{workflowSessionId}`

Retrieves a given Workflow Session.

## Path parameters

- `workflowSessionId` string, uuid, required — The unique identifier for a resource.

## Response `200`

OK

- WorkflowSession
  - `id` string, uuid, required — Unique identifier of the Workflow Session.
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `name` string, required — Name given to the Workflow Session. Used to easily find it in the application.
  - `workflow_template_id` string, uuid, required — Unique identifier of the Workflow Template from which this Workflow Session was created.
  - `workspace_id` string, uuid, required — Unique identifier of the Workspace in which this Workflow Session is scoped.
  - `status` 'awaiting' | 'ongoing' | 'blocked' | 'done', required — Status of the Workflow Session.
  - `action_groups` WorkflowSessionActionGroupsInner[], required — List of the Action Groups contained in the Workflow Session.
    - `type` 'signature_request' | 'identity_verification' | 'proof_of_address_verification' | 'company_verification' | 'watchlist_verification' | 'bank_account_verification' | 'document_analysis', required — Type of the Action Group.
    - `status` 'awaiting' | 'ongoing' | 'blocked' | 'done', required — Status of the Action Group.
    - `actions` WorkflowSessionActionGroupsInnerActionsInner[], required — Actions represent the resources associated with this Workflow Session, such as a Signature Request, Identity Document Verification, or other types of verifications. Actions of the same type are gathered in the same Action Group.
      - `resource` WorkflowSessionActionResource, required — The resource associated with this Action.
        - `id` string, uuid, required — Unique identifier of the Action. Corresponds to the ID of the resources associated with this Workflow Session (Signature Request, Identity Document Verification, etc.).
        - `created_at` string, date-time, required — Creation date of the Action Resource.
        - `type` 'signature_request' | 'identity_document_verification' | 'identity_video_verification' | 'proof_of_address_verification' | 'company_verification' | 'watchlist_verification' | 'bank_account_verification' | 'bank_account_connection_verification' | 'bank_account_lookup_verification' | 'social_security_document_analysis' | 'company_certificate_document_analysis' | 'business_registration_certificate_document_analysis' | 'driver_licence_document_analysis' | 'rne_certificate_document_analysis' | 'temporary_vehicle_registration_document_analysis' | 'vehicle_registration_document_analysis' | 'auto_insurance_claims_history_document_analysis' | 'payslip_document_analysis' | 'invoice_document_analysis' | 'id_document_document_analysis', required — Type of the Action.
        - `status` string, required — Status of the Action. Corresponds to the status of the resources associated with this Workflow Session (Signature Request, Identity Document Verification, etc.).
        - `previous_attempt_id` string, uuid, nullable, required — ID of the previous attempt if this Action is a retry.
      - `resolution` WorkflowSessionActionGroupsInnerActionsInnerResolution, nullable, required — The resource associated with this Action.
        - `reason` string, nullable, required — The reason why the Action is marked as resolved.
        - `resolved_at` string, date-time, required
      - `previous_attempts` WorkflowSessionActionGroupsInnerActionsInnerPreviousAttemptsInner[], required — List of previous attempts for this action. Each one contains a resource with its associated details.
        - `resource` WorkflowSessionActionResource, required — The resource associated with this Action.
          - `id` string, uuid, required — Unique identifier of the Action. Corresponds to the ID of the resources associated with this Workflow Session (Signature Request, Identity Document Verification, etc.).
          - `created_at` string, date-time, required — Creation date of the Action Resource.
          - `type` 'signature_request' | 'identity_document_verification' | 'identity_video_verification' | 'proof_of_address_verification' | 'company_verification' | 'watchlist_verification' | 'bank_account_verification' | 'bank_account_connection_verification' | 'bank_account_lookup_verification' | 'social_security_document_analysis' | 'company_certificate_document_analysis' | 'business_registration_certificate_document_analysis' | 'driver_licence_document_analysis' | 'rne_certificate_document_analysis' | 'temporary_vehicle_registration_document_analysis' | 'vehicle_registration_document_analysis' | 'auto_insurance_claims_history_document_analysis' | 'payslip_document_analysis' | 'invoice_document_analysis' | 'id_document_document_analysis', required — Type of the Action.
          - `status` string, required — Status of the Action. Corresponds to the status of the resources associated with this Workflow Session (Signature Request, Identity Document Verification, etc.).
          - `previous_attempt_id` string, uuid, nullable, required — ID of the previous attempt if this Action is a retry.

## Other responses

- `400` — Bad request
- `401` — Access unauthorized
- `403` — Access forbidden
- `404` — Resource not found
- `405` — This method is not allowed
- `429` — Too Many Requests, please try again later.
- `500` — Internal Server Error

---

[API](https://skmtc.net/yousign/apis/public-api-v3.md) · [All operations](https://skmtc.net/yousign/apis/public-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yousign/public-api-v3/revisions/8d258c0b45d6/schema)