Workflows Service Methods

This section highlights the different methods that can be used to retrieve workflow resources through the DeepIDV API.

Table of Contents

• Workflows by Organization ID
• Sessions Sent Under Workflow
• Error Status Reference

Workflows by Organization Id

Get's all created workflows under an organization. Returned in DESCENDING order by created at date

Request

GET /workflow

Parameters

Headers

Type	Params	Values	Description
HEADER	x-api-key*	string	The users API Key

Response

Success (200)

{
  "workflows": [
    {
      "id": "<workflow_id>",
      "name": "<workflow_name>",
      "createdAt": "<created_at>"
    }
  ]
}

Response Fields

Field	Type	Description
workflow_id	string	The unique id for a workflow
workflow_name	string	The name of the workflow
created_at	string	The date stamp of when the workflow was created

Sessions Sent Under Workflow

Get's all sessions sent under a workflow. Returned in DESCENDING order by created at date

Request

GET /workflow/{workflow_id}

Parameters

Headers

Type	Params	Values	Description
HEADER	x-api-key*	string	The users API Key

Response

Success (200)

{
  "workflows": [
    {
      "id": "<workflow_id>",
      "name": "<workflow_name>",
      "createdAt": "<created_at>"
    }
  ]
}

Response Fields

Field	Type	Description
workflow_id	string	The unique id for a workflow
workflow_name	string	The name of the workflow
created_at	string	The date stamp of when the workflow was created

Error Status Reference

The DeepIDV API uses standard HTTP status codes to indicate the success or failure of requests. The following table describes the possible error responses you may encounter:

Status Code	Error Message	Description
400	{"error": "Invalid Input."}	The request parameters are invalid or missing required fields
401	{"error": "Invalid API key."}	The provided API key is invalid or expired
402	{"error": "Insufficient funds or subscription."}	Unauthorized - Payment required
403	{"error": "API key is missing."}	No API key was provided in the request
429	{"error": "Rate limit exceeded."}	Too many requests have been made in a short period
500	{"error": "Something went wrong."}	An unexpected error occurred on the server

Best Practices for Error Handling

• Always validate required fields before sending requests
• Implement retry logic with exponential backoff for rate limit errors (429)
• Store error logs for debugging and monitoring purposes
• Display user-friendly error messages in your application