# Retrieve Applications

Retrieves a list of applications given the filter parameters provided

Endpoint: GET /v1/applications
Version: 1.1.2
Security: OAuth2Flow

## Query parameters:

  - `page` (integer)
    Page of records to get (default 0 = first page)

  - `page_size` (integer)
    Records to return per page (default = 20)

  - `order_by` (string)
    Field to order result set by (e.g. customer_id)

  - `order` (string)
    Direction of ordering (ASC or DESC)

  - `status` (string)
    Application status

  - `application_type` (string)
    Application Type

  - `terms_and_conditions_accepted` (boolean)
    Have Terms and Conditions being Accepted

  - `information_attested` (boolean)
    Information Attested

  - `customer_id` (string)
    Customer ID

  - `customer_name` (string)
    Customer Name

  - `email_address` (string)
    Customer Email Address

## Header parameters:

  - `Authorization` (string)
    OAuth bearer token (see authentication flows)

  - `x-l2f-request-id` (string)
    Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.applications` (array, required)
    Application List

  - `data.applications.id` (string, required)
    Unique Identifier for the application

  - `data.applications.status` (string, required)
    Status of the application
    Enum: "INCOMPLETE", "READY_FOR_SUBMISSION", "SUBMITTED", "PROCESSING", "CHANGES_REQUESTED", "REJECTED", "APPROVED"

  - `data.applications.application_type` (string, required)
    Type of Application (Individual or CorporationApplication)
    Enum: "INDIVIDUAL", "CORPORATION"

  - `data.applications.account_to_open` (object, required)
    Details of the account to open for the customer

  - `data.applications.account_to_open.account_id` (string, required)
    The identifier you wish to use to uniquely identify this account. The account id follows the [External Identifier](https://docs.layer2financial.com/guides/externalidentifiers/) pattern.

  - `data.applications.account_to_open.product_id` (string, required)
    Select the type of account being opened. You can customise and/or create new product offerings by visiting the [Management Interface](https://management.layer2financial.com)

Pre configured products that are available for use are 
- DEPOSIT_BASIC

  - `data.applications.account_to_open.asset_type_id` (string, required)
    Select the asset type of the account being opened. Asset type selection is not open ended, it must be configured per product via the [Management Interface](https://management.layer2financial.com). 

Asset type IDs follow a simple structure as follows: {$BLOCKCHAIN}_{$NETWORK}_{$CURRENCY_CODE}  Simple asset type to test with include 
- ETHEREUM_SEPOLIA_ETH
- ETHEREUM_SEPOLIA_USDC
- SOLANA_DEVNET_SOL
- BITCOIN_TESTNET_BTC
- FIAT_TESTNET_USD
- FIAT_TESTNET_USD
- FIAT_MAINNET_USD
- FIAT_TESTNET_EUR

  - `data.applications.terms_and_conditions_accepted` (boolean, required)
    Set to true when the end customer accepts all terms and conditions for use of the platform. An application cannot be submitted until accepted.

  - `data.applications.information_attested` (boolean, required)
    Setting to true means that the Customer (or the Ultimate Beneficial Owner, CEO, or Control Person for Corporate Customers) attests that all of the information provided on the application is true, accurate, and up to date at the time of submission. Rail Subscribers as defined in the Rail Platform Agreement, may not attest on behalf of the Customer.

  - `data.applications.customer_id` (string, required)
    The identifier you wish to use to uniquely identify this customer (applies to both individual and corporate customers). The customer ID follows the [External Identifier](https://docs.rail.io/guides/externalidentifiers/) pattern.

  - `links` (object, required)
    See the [pagination](https://docs.layer2financial.com/guides/pagination/) section for additional details on the generic pagination approach.

  - `links.self` (string, required)
    endpoint to the current page of results

  - `links.first` (string, required)
    endpoint to the first page of results

  - `links.prev` (string, required)
    endpoint to the previous page of results

  - `links.next` (string, required)
    endpoint to the next page of results

  - `links.last` (string, required)
    endpoint to the last page of results

## Response 400 fields (application/json):

  - `errors` (array)
    Error List

  - `errors.code` (string)
    Layer2 Standard Error Code

  - `errors.description` (string)
    Error Description

## Response 401 fields (application/json):

  - `errors` (array)
    Error List

  - `errors.code` (string)
    Layer2 Standard Error Code

  - `errors.description` (string)
    Error Description

## Response 404 fields (application/json):

  - `errors` (array)
    Error List

  - `errors.code` (string)
    Layer2 Standard Error Code

  - `errors.description` (string)
    Error Description

## Response 500 fields (application/json):

  - `errors` (array)
    Error List

  - `errors.code` (string)
    Layer2 Standard Error Code

  - `errors.description` (string)
    Error Description