---
title: "Get datafile details"
method: GET
path: "/v1/applications/{applicationId}/datafiles/{dataFileId}"
tags: ["Datafiles"]
---

# Get datafile details

`GET /v1/applications/{applicationId}/datafiles/{dataFileId}`

## Request

- Base URL: `https://api.apply.akahu.nz`
- URL: `https://api.apply.akahu.nz/v1/applications/{applicationId}/datafiles/{dataFileId}`
- Auth: HTTP bearer

## Path parameters

- `applicationId` string, required
- `dataFileId` string, required

## Response `200`

Success

- Datafile: **Datafiles** are a structured way to bring financial data into an Application for analysis. A datafile represents a single file containing a financial information, that follows a supported schema. When a datafile is uploaded to an Application, Akahu Apply will process the information from the file and convert it to a standardised format. Datafiles can be added to an application only via this API. Note: Datafiles and their associated data expire 1 year after creation.
  - `_id` string, required
  - `_application` string, required: The application that this datafile belongs to.
  - `name` string, required: The filename of this datafile.
  - `content_type` 'application/json', required: The content type of the datafile.
  - `schema` string, required: The name of the schema for this datafile.
  - `status` 'pending' | 'processing' | 'completed' | 'failed', required: The status of a datafile: - `pending` The datafile record exists, but the file has not yet been fully uploaded. - `processing` Akahu Apply is extracting and enriching the data from this datafile. - `completed` This datafile has been successfully processed. - `failed` This datafile has not been successfully processed. See the `failure_reason` for more detail.
  - `failure_reason` object: If this datafile has failed to be processed, this field provides additional detail about what went wrong.
    - `code` 'internal_error' | 'invalid_input' | 'timeout' | 'malware_scan_failed' | 'malware_detected', required
    - `message` string
  - `created_at` string, date-time, required: The date that this datafile was created.
  - `updated_at` string, date-time, required: The date that this datafile was last updated at.
  - `expires_at` string, date-time: Expiry for the datafile, after which the record will be deleted. Expiry varies as the datafile progresses through its lifecycle: - While the datafile has a status of `pending`, expiry is short lived, ensuring that the record is cleaned up quickly if a file is never uploaded. - After the datafile upload has been received, a 1 year expiry is set, after which the datafile and all associated data will be permanently deleted.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/akahu/apis/akahu-apply-api.md) - [All operations](https://skmtc.dev/akahu/apis/akahu-apply-api/llms.txt) - [OpenAPI document](https://skmtc.dev/akahu/apis/akahu-apply-api/revisions/3f18eb1ead75?raw)