Create Workflow

POSThttps://bank.dattaremit.com/api/workflows

Requires a bank-scoped key.

Creates a workflow.

## State

State	Description
storing	The Platform is storing the workflow details in our private store
completed	The Platform has created the workflow
failed	The workflow was not completed successfully

## Plaid

Param	Description
redirect_uri	All URIs must be registered with Cybrid. For local testing use `http://localhost:4200/bank-account-connect`

Required scope: workflows:execute

Body Params

required

typeplaidrequired

The workflow type.

kindlink_token_create | link_token_update

The Plaid workflow kind. Required when type is plaid.

customer_guidstring

The customer identifier associated with the workflow. Optional when type is plaid and kind is link_token_create.

external_bank_account_guidstring

The external bank account identifier associated with the workflow. Required when type is plaid and kind is link_token_update.

languageen | fr | es | nl | de

The language to initialize Plaid link. Required when type is plaid.

link_customization_namestring

The customization name for Plaid link. For English, use "default". For Spanish, use "spanish_customization". Required when type is plaid.

redirect_uristring

The redirect URI for Plaid link. Optional when type is plaid.

android_package_namestring

The Android package name for Plaid link. Optional when type is plaid.

Responses

201

Workflow created

400

Bad Request

401

Unauthorized - Authentication failed

403

Invalid scope

422

Unprocessable Content

Request

curl https://api.dattaremit.com/api/workflows \
  -X POST \
  -H "Authorization: Bearer sk_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "plaid",
  "kind": "link_token_create",
  "customer_guid": "string",
  "external_bank_account_guid": "string",
  "language": "en",
  "link_customization_name": "string",
  "redirect_uri": "string",
  "android_package_name": "string"
}'

Response

Workflow created

{
  "guid": "string",
  "bank_guid": "string",
  "customer_guid": "string",
  "type": "string",
  "state": "string",
  "failure_code": "string",
  "created_at": "2026-07-20T16:27:51.438Z",
  "updated_at": "2026-07-20T16:27:51.438Z"
}