---
title: "Get Fapi Transaction Data"
method: GET
path: "/api/v1/cs-forms/get-fapi-data"
---

# Get Fapi Transaction Data

`GET /api/v1/cs-forms/get-fapi-data`

Returns latest fapi transaction data that relate to a forms request id
Will Decrypt encrypted token data into 'data' if it exists

Query Params:
    connect_id_txn: ConnectID Transaction ID
    forms_request_id: Forms Request ID
    fapi_transaction_id: Fapi Transaction ID

    At least one of these MUST be provided in order to get data

## Query parameters

- `connect_id_txn` string
- `forms_request_id` string, uuid
- `fapi_interaction_id` string, uuid

## Response `200`

Successful Response

- ApiResponseJSONFapiTransactionsModel
  - `data` FapiTransactionsModel[] — List of items returned in the response following given criteria
    - `id` string, uuid, required
    - `x_fapi_interaction_id` string, uuid, required
    - `created_at` string, date-time
    - `request_id` string, uuid, nullable
    - `started_at` string, date-time, nullable
    - `completed_at` string, date-time, nullable
    - `updated_by` string, nullable
    - `txn` string, nullable
    - `identity_provider_id` string, nullable
    - `data` unknown
    - `error_data` unknown
    - `data_key_encrypted` string, binary, nullable
    - `data_encrypted` string, binary, nullable
    - `data_decrypted_` string, nullable
  - `meta` ApiResponseMeta — Standardised Api Response Meta Not always required (except for example; with paginated results) Future: Could provide base that includes org information, copy-write etc
    - `processing_time_ms` integer, nullable
    - `total_records` integer, nullable
    - `page` integer, nullable
    - `limit` integer, nullable
    - `count` integer, nullable
    - `cursor` unknown
    - `cursor_last` unknown
    - `more_data_available` boolean, nullable
  - `messages` ApiResponseMessage[], nullable — Response Messages
    - `message_type` 'debug' | 'info' | 'warning' | 'error', required
    - `message` string, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/caresquare/apis/fastapi.md) · [All operations](https://skmtc.dev/caresquare/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/caresquare/fastapi/revisions/c9df874d8d59/schema)
