Skip to main content
GET
/
operations
/
{operation_id}
Check on an async operation
curl --request GET \
  --url https://api-sandbox.ledgersyncappv2.com/v3/operations/{operation_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "op_01HXYZ8A6N7K2W9PQ4T5Z3V6E0",
  "type": "account.refresh",
  "created_at": "2023-11-07T05:31:56Z",
  "result": {
    "kind": "connection",
    "connection": {
      "id": "con_FINICITY_41294",
      "client_id": "cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0",
      "created_at": "2023-11-07T05:31:56Z",
      "institution": {
        "id": "<string>",
        "name": "Chase",
        "logo_url": "<string>"
      },
      "last_refreshed_at": "2023-11-07T05:31:56Z",
      "last_error": {
        "code": "unknown_api_key",
        "message": "The API key you presented doesn't match any active key.",
        "type": "auth_error",
        "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
        "category": "AUTH_ERROR",
        "is_user_actionable": true,
        "source_diagnostic_code": "FIN-103",
        "param": "client.email",
        "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
        "errors": [
          {
            "param": "client.email",
            "message": "must be a valid email address",
            "code": "invalid_email"
          }
        ]
      },
      "expected_capabilities": {
        "transactions": {},
        "balance": {},
        "available_balance": {},
        "statements": {},
        "check_images": {}
      },
      "realized_capabilities": {
        "transactions": {
          "last_success_at": "2023-11-07T05:31:56Z",
          "next_refresh_after": "2023-11-07T05:31:56Z",
          "last_error": {
            "code": "unknown_api_key",
            "message": "The API key you presented doesn't match any active key.",
            "type": "auth_error",
            "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
            "category": "AUTH_ERROR",
            "is_user_actionable": true,
            "source_diagnostic_code": "FIN-103",
            "param": "client.email",
            "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
            "errors": [
              {
                "param": "client.email",
                "message": "must be a valid email address",
                "code": "invalid_email"
              }
            ]
          }
        },
        "balance": {
          "last_success_at": "2023-11-07T05:31:56Z",
          "next_refresh_after": "2023-11-07T05:31:56Z",
          "last_error": {
            "code": "unknown_api_key",
            "message": "The API key you presented doesn't match any active key.",
            "type": "auth_error",
            "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
            "category": "AUTH_ERROR",
            "is_user_actionable": true,
            "source_diagnostic_code": "FIN-103",
            "param": "client.email",
            "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
            "errors": [
              {
                "param": "client.email",
                "message": "must be a valid email address",
                "code": "invalid_email"
              }
            ]
          }
        },
        "available_balance": {
          "last_success_at": "2023-11-07T05:31:56Z",
          "next_refresh_after": "2023-11-07T05:31:56Z",
          "last_error": {
            "code": "unknown_api_key",
            "message": "The API key you presented doesn't match any active key.",
            "type": "auth_error",
            "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
            "category": "AUTH_ERROR",
            "is_user_actionable": true,
            "source_diagnostic_code": "FIN-103",
            "param": "client.email",
            "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
            "errors": [
              {
                "param": "client.email",
                "message": "must be a valid email address",
                "code": "invalid_email"
              }
            ]
          }
        },
        "statements": {
          "last_success_at": "2023-11-07T05:31:56Z",
          "next_refresh_after": "2023-11-07T05:31:56Z",
          "last_error": {
            "code": "unknown_api_key",
            "message": "The API key you presented doesn't match any active key.",
            "type": "auth_error",
            "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
            "category": "AUTH_ERROR",
            "is_user_actionable": true,
            "source_diagnostic_code": "FIN-103",
            "param": "client.email",
            "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
            "errors": [
              {
                "param": "client.email",
                "message": "must be a valid email address",
                "code": "invalid_email"
              }
            ]
          }
        },
        "check_images": {
          "last_success_at": "2023-11-07T05:31:56Z",
          "next_refresh_after": "2023-11-07T05:31:56Z",
          "last_error": {
            "code": "unknown_api_key",
            "message": "The API key you presented doesn't match any active key.",
            "type": "auth_error",
            "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
            "category": "AUTH_ERROR",
            "is_user_actionable": true,
            "source_diagnostic_code": "FIN-103",
            "param": "client.email",
            "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
            "errors": [
              {
                "param": "client.email",
                "message": "must be a valid email address",
                "code": "invalid_email"
              }
            ]
          }
        }
      },
      "_debug": {
        "source_used": "<string>"
      },
      "updated_at": "2023-11-07T05:31:56Z"
    }
  },
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  },
  "completed_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Pass your secret key in the Authorization header as a Bearer token: Authorization: Bearer sk_test_... (sandbox) or Bearer sk_live_... (production).

Keys are created in the developer portal and the plaintext secret is shown exactly once at creation. Treat them like passwords — never embed them in mobile apps or front-end code.

Path Parameters

​
operation_id
string
required

Response

The Operation, with result or error once it's done.

Tracks an async operation's progress.

​
id
string
required
Example:

"op_01HXYZ8A6N7K2W9PQ4T5Z3V6E0"

​
type
enum<string>
required
Available options:
connection.initiate,
connection.complete,
account.refresh,
statement.extract,
transaction.sync
Example:

"account.refresh"

​
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed
​
created_at
string<date-time>
required
​
result
object

Resource produced by the operation, present only when status=succeeded. The kind field discriminates the variant for SDK code generation.

​
error
object

Populated when status=failed. Same shape as error.* in an HTTP error response — branch on code.

​
completed_at
string<date-time> | null