Rail API

https://docs.rail.io/api-docs
Admin
Rail API provides developers with comprehensive API documentation and guides for integrating with...
Tokens:53,370
Snippets:153
Trust Score:7.4
Update:10 months ago
Show doc for...
Tokens:
Raw
### Retrieve Customers API Request Example

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/getCustomers

This example demonstrates a typical request to retrieve customers using the API. It includes common query parameters for pagination and filtering, as well as the required Authorization header.

```http
GET /v1/customers?page=0&page_size=20&type=INDIVIDUAL&status=ACTIVE HTTP/1.1
Host: api.rail.io
Authorization: Bearer YOUR_ACCESS_TOKEN
x-l2f-request-id: YOUR_REQUEST_ID
```

--------------------------------

### Accept Transfer Request Example (cURL)

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/confirmTransfer

Example of how to accept a transfer using a cURL command. This demonstrates the necessary HTTP method, endpoint, and required headers such as Authorization, and optional headers like x-l2f-request-id.

```shell
curl -X POST \ \
  'https://api.rail.io/v1/transfers/{transfer_id}/accept' \ \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ \
  -H 'x-l2f-request-id: YOUR_REQUEST_ID' \ \
  -H 'x-l2f-idempotency-id: YOUR_IDEMPOTENCY_ID' \ \
  -H 'x-signature: YOUR_SIGNATURE' \ \
  -H 'x-timestamp: CURRENT_UNIX_TIMESTAMP'
```

--------------------------------

### Retrieve Transactions Request Example (Python)

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/getTransactions

Example of how to make a GET request to the /v1/transactions endpoint using Python's requests library. It demonstrates setting query parameters for filtering and sorting, and includes the Authorization header for authentication.

```python
import requests

api_url = "https://api.rail.io/v1/transactions"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "x-l2f-request-id": "optional-request-id"
}
params = {
    "page": 0,
    "page_size": 20,
    "order": "DESC",
    "start_date": "2023-01-01",
    "end_date": "2023-12-31",
    "account_id": "acc_12345",
    "category_id": "cat_67890",
    "category_type": "DEPOSIT",
    "transaction_status": "POSTED"
}

response = requests.get(api_url, headers=headers, params=params)

if response.status_code == 200:
    print("Success:", response.json())
elif response.status_code == 400:
    print("Bad Request:", response.json())
elif response.status_code == 401:
    print("Unauthorized:", response.json())
elif response.status_code == 404:
    print("Not Found:", response.json())
else:
    print("Error:", response.status_code, response.text)
```

--------------------------------

### Retrieve Counterparties GET Request (Shell)

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/getCounterparties

Example of making a GET request to retrieve counterparties using cURL. This includes query parameters for pagination and filtering, as well as required headers for authorization and request identification.

```shell
curl -X GET \
  'https://api.rail.io/v1/counterparties?page=0&page_size=20&customer_id=12345' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'x-l2f-request-id: YOUR_REQUEST_ID' \
  -H 'x-l2f-idempotency-id: YOUR_IDEMPOTENCY_ID'
```

--------------------------------

### POST /v1/applications

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/createApplication

Starts a new application to onboard a person or corporation. Once created, individuals can be added and updated before submission.

```APIDOC
## POST /v1/applications

### Description
Starts a new application to onboard a person or corporation. Once the application is created, proceed to add individuals and update as needed, and then submit once the status allows for it.

### Method
POST

### Endpoint
/v1/applications

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - OAuth bearer token (see authentication flows).
- **x-l2f-request-id** (string) - Optional - Unique ID per request, useful for fault resolution/diagnosis and audit.
- **x-l2f-idempotency-id** (string) - Required - Unique ID used to safely retry an operation. See idempotency section for more details.

#### Request Body
- **application_type** (string) - Required - Type of Application (INDIVIDUAL or CORPORATION).
- **account_to_open** (object) - Required - Details of the account to open for the customer.
  - **account_id** (string) - Required
  - **product_id** (string) - Required
  - **asset_type_id** (string) - Required
- **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.
- **information_attested** (boolean) - Optional - Default: false. 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.
- **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 pattern.
- **customer_details** (object) - Required - Details of the applying individual.
  - **first_name** (string) - Required
  - **middle_name** (string) - Optional
  - **last_name** (string) - Required
  - **email_address** (string) - Required
  - **mailing_address** (object) - Required
    - **unit_number** (string) - Optional
    - **address_line1** (string) - Required
    - **address_line2** (string) - Optional
    - **address_line3** (string) - Optional
    - **city** (string) - Required
    - **state** (string) - Required
    - **postal_code** (string) - Required
    - **country_code** (string) - Required
  - **telephone_number** (string) - Required
  - **tax_reference_number** (string) - Optional
  - **passport_number** (string) - Optional
  - **nationality** (string) - Optional
  - **citizenship** (array) - Optional - Array of strings.
  - **date_of_birth** (string) - Required - Format: YYYY-MM-DD
  - **ip_address** (string) - Required
  - **tax_reference_number_country** (string) - Optional
  - **us_residency_status** (string) - Optional - Enum: US_CITIZEN, US_PERMANENT_RESIDENT, US_TEMPORARY_RESIDENT, NON_RESIDENT
  - **employment_status** (string) - Optional - Enum: EMPLOYEE, SELF_EMPLOYED, UNEMPLOYED, STUDENT, RETIRED, OTHER
  - **employment_description** (string) - Optional
  - **employer_name** (string) - Optional
  - **occupation** (string) - Optional
  - **investment_profile** (object) - Optional
    - **primary_source_of_funds** (string) - Required - Enum: EMPLOYMENT, PENSION, SAVINGS, INVESTMENTS, GIFTS, INHERITANCE, FAMILY_SUPPORT, OTHER
    - **primary_source_of_funds_description** (string) - Optional
    - **total_assets** (string) - Required - Enum: UPTO_10K, 10K_TO_50K, 50K_TO_100K, 100K_TO_250K, 250K_TO_500K, 500K_TO_1M, OVER_1M
    - **usd_value_of_fiat** (string) - Required - Enum: UPTO_10K, 10K_TO_50K, 50K_TO_100K, 100K_TO_250K, 250K_TO_500K, 500K_TO_1M, OVER_1M
    - **monthly_deposits** (string) - Required - Enum: UPTO_5, 5_TO_10, 10_TO_20, 20_TO_50, OVER_50
    - **monthly_withdrawals** (string) - Required - Enum: UPTO_5, 5_TO_10, 10_TO_20, 20_TO_50, OVER_50
    - **monthly_investment_deposit** (string) - Required - Enum: UPTO_1K, 1K_TO_5K, 5K_TO_10K, 10K_TO_25K, OVER_25K
    - **monthly_investment_withdrawal** (string) - Required - Enum: UPTO_1K, 1K_TO_5K, 5K_TO_10K, 10K_TO_25K, OVER_25K
    - **usd_value_of_crypto** (string) - Required - Enum: UPTO_10K, 10K_TO_50K, 50K_TO_100K, 100K_TO_250K, 250K_TO_500K, 500K_TO_1M, OVER_1M
    - **monthly_crypto_deposits** (string) - Required - Enum: UPTO_5, 5_TO_10, 10_TO_20, 20_TO_50, OVER_50
    - **monthly_crypto_withdrawals** (string) - Required - Enum: UPTO_5, 5_TO_10, 10_TO_20, 20_TO_50, OVER_50
    - **monthly_crypto_investment_deposit** (string) - Required - Enum: UPTO_1K, 1K_TO_5K, 5K_TO_10K, 10K_TO_25K, OVER_25K
    - **monthly_crypto_investment_withdrawal** (string) - Required - Enum: UPTO_1K, 1K_TO_5K, 5K_TO_10K, 10K_TO_25K, OVER_25K
  - **kyc_profile** (object) - Optional
    - **funds_send_receive_jurisdictions** (array) - Optional - Array of strings.
    - **business_jurisdictions** (array) - Optional - Array of strings.
    - **engage_in_activities** (array) - Optional - Array of strings. Enum: NONE, TRADING, MINING, STAKING, GAMBLING, OTHER
    - **vendors_and_counterparties** (array) - Optional - Array of strings. Enum: SELF, OTHER_INDIVIDUAL, OTHER_CORPORATION

### Request Example
```json
{
  "application_type": "INDIVIDUAL",
  "account_to_open": {
    "account_id": "string",
    "product_id": "string",
    "asset_type_id": "string"
  },
  "terms_and_conditions_accepted": true,
  "information_attested": false,
  "customer_id": "string",
  "customer_details": {
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "email_address": "string",
    "mailing_address": {
      "unit_number": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_line3": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country_code": "string"
    },
    "telephone_number": "string",
    "tax_reference_number": "string",
    "passport_number": "string",
    "nationality": "string",
    "citizenship": [
      "string"
    ],
    "date_of_birth": "2019-08-24",
    "ip_address": "string",
    "tax_reference_number_country": "string",
    "us_residency_status": "US_CITIZEN",
    "employment_status": "EMPLOYEE",
    "employment_description": "string",
    "employer_name": "string",
    "occupation": "string",
    "investment_profile": {
      "primary_source_of_funds": "EMPLOYMENT",
      "primary_source_of_funds_description": "string",
      "total_assets": "UPTO_10K",
      "usd_value_of_fiat": "UPTO_10K",
      "monthly_deposits": "UPTO_5",
      "monthly_withdrawals": "UPTO_5",
      "monthly_investment_deposit": "UPTO_1K",
      "monthly_investment_withdrawal": "UPTO_1K",
      "usd_value_of_crypto": "UPTO_10K",
      "monthly_crypto_deposits": "UPTO_5",
      "monthly_crypto_withdrawals": "UPTO_5",
      "monthly_crypto_investment_deposit": "UPTO_1K",
      "monthly_crypto_investment_withdrawal": "UPTO_1K"
    },
    "kyc_profile": {
      "funds_send_receive_jurisdictions": [
        "string"
      ],
      "business_jurisdictions": [
        "string"
      ],
      "engage_in_activities": [
        "NONE"
      ],
      "vendors_and_counterparties": [
        "SELF"
      ]
    }
  }
}
```

### Response
#### Success Response (200)
- **data** (object) - Description:
  - **id** (string) - The unique identifier for the created application.

#### Response Example
```json
{
  "data": {
    "id": "string"
  }
}
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **404** Not Found
- **500** Internal Error
```

--------------------------------

### Accept Transfer Success Response Example (JSON)

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/confirmTransfer

Sample JSON response indicating a successful acceptance of a transfer. It includes the transfer ID and its updated status.

```json
{
  "data": {
    "id": "string",
    "status": "REQUESTED"
  }
}
```

--------------------------------

### GET /v1/customers - Retrieve Customers

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/getCustomers

Retrieves a list of customers based on the provided query and header parameters. Supports filtering by type and status, with pagination options.

```APIDOC
## GET /v1/customers

### Description
Retrieve customers matching the provided query parameters.

### Method
GET

### Endpoint
/v1/customers

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page of records to get (default 0 = first page)
- **page_size** (integer) - Optional - Records to return per page (default = 20)
- **type** (string) - Optional - Type of Customer. Enum: "INDIVIDUAL", "CORPORATION"
- **status** (string) - Optional - Status of the customer. Enum: "ACTIVE", "CLOSED", "PENDING", "FROZEN", "EDD", "DORMANT"

#### Header Parameters
- **Authorization** (string) - Required - OAuth bearer token (see authentication flows)
- **x-l2f-request-id** (string) - Optional - Unique ID per request, useful for fault resolution/diagnosis and audit.

### Response
#### Success Response (200)
- **data.customers** (array) - List of customer objects.
  - **id** (string) - The unique identifier for the customer.
  - **customer_type** (string) - The type of the customer (e.g., "INDIVIDUAL", "CORPORATION").
  - **status** (string) - The current status of the customer.
- **links** (object) - Pagination links.
  - **self** (string) - Link to the current page.
  - **first** (string) - Link to the first page.
  - **prev** (string) - Link to the previous page.
  - **next** (string) - Link to the next page.
  - **last** (string) - Link to the last page.

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **404** - Not Found
- **500** - Internal Server Error

### Request Example
(No request body for GET requests, parameters are in query or headers)

### Response Example (200 OK)
```json
{
  "data": {
    "customers": [
      {
        "id": "string",
        "customer_type": "INDIVIDUAL",
        "status": "ACTIVE"
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  }
}
```
```

--------------------------------

### GET /v1/applications - Retrieve Applications

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/getApplications

Retrieves a list of applications based on the provided filter parameters. Supports pagination, ordering, and filtering by various application and customer attributes.

```APIDOC
## GET /v1/applications

### Description
Retrieves a list of applications given the filter parameters provided.

### Method
GET

### Endpoint
/v1/applications

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page of records to get (default 0 = first page)
- **page_size** (integer) - Optional - Records to return per page (default = 20)
- **order_by** (string) - Optional - Field to order result set by (e.g. `customer_id`)
- **order** (string) - Optional - Direction of ordering (`ASC` or `DESC`)
- **status** (string) - Optional - Application status
- **application_type** (string) - Optional - Application Type
- **terms_and_conditions_accepted** (boolean) - Optional - Have Terms and Conditions been Accepted
- **information_attested** (boolean) - Optional - Information Attested
- **customer_id** (string) - Optional - Customer ID
- **customer_name** (string) - Optional - Customer Name
- **email_address** (string) - Optional - Customer Email Address

#### Header Parameters
- **Authorization** (string) - Required - OAuth bearer token (see authentication flows)
- **x-l2f-request-id** (string) - Optional - Unique ID per request, useful for fault resolution/diagnosis and audit.

### Responses
#### Success Response (200)
- **data** (object) - Contains the list of applications and pagination links.
  - **applications** (array) - List of application objects.
    - **id** (string) - Unique identifier for the application.
    - **status** (string) - Current status of the application (e.g., INCOMPLETE).
    - **application_type** (string) - Type of the application (e.g., INDIVIDUAL).
    - **account_to_open** (object) - Details about the account to be opened.
      - **account_id** (string) - Identifier for the account.
      - **product_id** (string) - Identifier for the product.
      - **asset_type_id** (string) - Identifier for the asset type.
    - **terms_and_conditions_accepted** (boolean) - Indicates if terms and conditions were accepted.
    - **information_attested** (boolean) - Indicates if information was attested.
    - **customer_id** (string) - Identifier for the customer associated with the application.
  - **links** (object) - Pagination links.
    - **self** (string) - URL for the current page.
    - **first** (string) - URL for the first page.
    - **prev** (string) - URL for the previous page.
    - **next** (string) - URL for the next page.
    - **last** (string) - URL for the last page.

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **404** - Not Found
- **500** - Internal Error

### Response Example (200)
```json
{
  "data": {
    "applications": [
      {
        "id": "string",
        "status": "INCOMPLETE",
        "application_type": "INDIVIDUAL",
        "account_to_open": {
          "account_id": "string",
          "product_id": "string",
          "asset_type_id": "string"
        },
        "terms_and_conditions_accepted": true,
        "information_attested": false,
        "customer_id": "string"
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  }
}
```
```

--------------------------------

### Retrieve Applications (GET /v1/applications)

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/getApplications

Fetches a list of applications with optional filtering and sorting parameters. Requires OAuth2 authentication. The response includes application details and pagination links.

```shell
curl -X GET "https://api.rail.io/v1/applications?page=0&page_size=20&order_by=customer_id&order=ASC&status=INCOMPLETE&application_type=INDIVIDUAL&terms_and_conditions_accepted=true&information_attested=false&customer_id=string&customer_name=string&email_address=string" \
     -H "Authorization: Bearer YOUR_OAUTH2_TOKEN" \
     -H "x-l2f-request-id: YOUR_REQUEST_ID"
```

--------------------------------

### Create Subscription Success Response (JSON)

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/createSubscription

Example JSON response upon successful creation of a subscription. It includes the subscription's 'id', 'event_type', 'callback_url', and 'signature_verification_key'.

```json
{
  "data": {
    "id": "string",
    "event_type": "ACCOUNT_EDD_L2F",
    "callback_url": "string",
    "signature_verification_key": "string"
  }
}
```

--------------------------------

### GET /v1/applications/{application_id}

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/getApplication

Retrieve full details of a specific application using its unique ID.

```APIDOC
## Retrieve Application

### Description
Retrieve full details of the application.

### Method
GET

### Endpoint
/v1/applications/{application_id}

### Parameters
#### Path Parameters
- **application_id** (string) - Required - Application ID

#### Header Parameters
- **Authorization** (string) - Required - OAuth bearer token (see authentication flows)
- **x-l2f-request-id** (string) - Optional - Unique ID per request, useful for fault resolution/diagnosis and audit.

### Responses
#### Success Response (200)
- **data** (object) - Contains the detailed application information.
  - **id** (string) - The unique identifier for the application.
  - **status** (string) - The current status of the application (e.g., INCOMPLETE).
  - **application_type** (string) - The type of application (e.g., INDIVIDUAL).
  - **account_to_open** (object) - Details about the account to be opened.
    - **account_id** (string) - The ID of the account.
    - **product_id** (string) - The ID of the product.
    - **asset_type_id** (string) - The ID of the asset type.
  - **terms_and_conditions_accepted** (boolean) - Indicates if terms and conditions were accepted.
  - **information_attested** (boolean) - Indicates if information was attested.
  - **customer_id** (string) - The ID of the customer.
  - **customer_details** (object) - Detailed customer information.
    - **first_name** (string) - Customer's first name.
    - **middle_name** (string) - Customer's middle name.
    - **last_name** (string) - Customer's last name.
    - **email_address** (string) - Customer's email address.
    - **mailing_address** (object) - Customer's mailing address.
      - **unit_number** (string) - Unit number.
      - **address_line1** (string) - First line of the address.
      - **address_line2** (string) - Second line of the address.
      - **address_line3** (string) - Third line of the address.
      - **city** (string) - City.
      - **state** (string) - State.
      - **postal_code** (string) - Postal code.
      - **country_code** (string) - Country code.
    - **telephone_number** (string) - Customer's telephone number.
    - **tax_reference_number** (string) - Customer's tax reference number.
    - **passport_number** (string) - Customer's passport number.
    - **nationality** (string) - Customer's nationality.
    - **citizenship** (array) - List of customer's citizenships.
      - (string)
    - **date_of_birth** (string) - Customer's date of birth (YYYY-MM-DD).
    - **ip_address** (string) - Customer's IP address.
    - **tax_reference_number_country** (string) - Country of tax reference number.
    - **us_residency_status** (string) - US residency status (e.g., US_CITIZEN).
    - **employment_status** (string) - Employment status (e.g., EMPLOYEE).
    - **employment_description** (string) - Description of employment.
    - **employer_name** (string) - Employer's name.
    - **occupation** (string) - Customer's occupation.
    - **investment_profile** (object) - Customer's investment profile.
      - **primary_source_of_funds** (string) - Primary source of funds (e.g., EMPLOYMENT).
      - **primary_source_of_funds_description** (string) - Description of the primary source of funds.
      - **total_assets** (string) - Total assets range (e.g., UPTO_10K).
      - **usd_value_of_fiat** (string) - USD value of fiat currency range.
      - **monthly_deposits** (string) - Monthly deposit range.
      - **monthly_withdrawals** (string) - Monthly withdrawal range.
      - **monthly_investment_deposit** (string) - Monthly investment deposit range.
      - **monthly_investment_withdrawal** (string) - Monthly investment withdrawal range.
      - **usd_value_of_crypto** (string) - USD value of crypto range.
      - **monthly_crypto_deposits** (string) - Monthly crypto deposit range.
      - **monthly_crypto_withdrawals** (string) - Monthly crypto withdrawal range.
      - **monthly_crypto_investment_deposit** (string) - Monthly crypto investment deposit range.
      - **monthly_crypto_investment_withdrawal** (string) - Monthly crypto investment withdrawal range.
    - **kyc_profile** (object) - Customer's KYC profile.
      - **funds_send_receive_jurisdictions** (array) - Jurisdictions for sending/receiving funds.
        - (string)
      - **business_jurisdictions** (array) - Business jurisdictions.
        - (string)
      - **engage_in_activities** (array) - Activities the customer engages in.
        - (string)
      - **vendors_and_counterparties** (array) - Vendors and counterparties.
        - (string)

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **404** - Not Found
- **500** - Internal Error

### Request Example
(No request body for GET request)

### Response Example (200)
```json
{
  "data": {
    "id": "string",
    "status": "INCOMPLETE",
    "application_type": "INDIVIDUAL",
    "account_to_open": {
      "account_id": "string",
      "product_id": "string",
      "asset_type_id": "string"
    },
    "terms_and_conditions_accepted": true,
    "information_attested": false,
    "customer_id": "string",
    "customer_details": {
      "first_name": "string",
      "middle_name": "string",
      "last_name": "string",
      "email_address": "string",
      "mailing_address": {
        "unit_number": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_line3": "string",
        "city": "string",
        "state": "string",
        "postal_code": "string",
        "country_code": "string"
      },
      "telephone_number": "string",
      "tax_reference_number": "string",
      "passport_number": "string",
      "nationality": "string",
      "citizenship": [
        "string"
      ],
      "date_of_birth": "2019-08-24",
      "ip_address": "string",
      "tax_reference_number_country": "string",
      "us_residency_status": "US_CITIZEN",
      "employment_status": "EMPLOYEE",
      "employment_description": "string",
      "employer_name": "string",
      "occupation": "string",
      "investment_profile": {
        "primary_source_of_funds": "EMPLOYMENT",
        "primary_source_of_funds_description": "string",
        "total_assets": "UPTO_10K",
        "usd_value_of_fiat": "UPTO_10K",
        "monthly_deposits": "UPTO_5",
        "monthly_withdrawals": "UPTO_5",
        "monthly_investment_deposit": "UPTO_1K",
        "monthly_investment_withdrawal": "UPTO_1K",
        "usd_value_of_crypto": "UPTO_10K",
        "monthly_crypto_deposits": "UPTO_5",
        "monthly_crypto_withdrawals": "UPTO_5",
        "monthly_crypto_investment_deposit": "UPTO_1K",
        "monthly_crypto_investment_withdrawal": "UPTO_1K"
      },
      "kyc_profile": {
        "funds_send_receive_jurisdictions": [
          "string"
        ],
        "business_jurisdictions": [
          "string"
        ],
        "engage_in_activities": [
          "NONE"
        ],
        "vendors_and_counterparties": [
          "SELF"
        ]
      }
    }
  }
}
```
```

--------------------------------

### Retrieve Counterparty by ID - Request Example (Shell)

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/getCounterparty

This example demonstrates how to make a GET request to retrieve a specific counterparty's details using its ID. It includes the necessary Authorization header and the counterparty ID in the URL path. The 'x-l2f-request-id' and 'x-l2f-idempotency-id' headers are optional for tracing and retries.

```shell
curl -X GET https://api.rail.io/v1/counterparties/{counterparty_id}
     -H "Authorization: Bearer YOUR_OAUTH2_TOKEN"
     -H "x-l2f-request-id: YOUR_REQUEST_ID"
     -H "x-l2f-idempotency-id: YOUR_IDEMPOTENCY_ID"
```

--------------------------------

### Example Application JSON Response (200 OK)

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/getApplication

A sample JSON payload representing a successful retrieval of application details. This structure outlines the fields returned, including nested objects for account and customer information.

```json
{
  "data": {
    "id": "string",
    "status": "INCOMPLETE",
    "application_type": "INDIVIDUAL",
    "account_to_open": {
      "account_id": "string",
      "product_id": "string",
      "asset_type_id": "string"
    },
    "terms_and_conditions_accepted": true,
    "information_attested": false,
    "customer_id": "string",
    "customer_details": {
      "first_name": "string",
      "middle_name": "string",
      "last_name": "string",
      "email_address": "string",
      "mailing_address": {
        "unit_number": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_line3": "string",
        "city": "string",
        "state": "string",
        "postal_code": "string",
        "country_code": "string"
      },
      "telephone_number": "string",
      "tax_reference_number": "string",
      "passport_number": "string",
      "nationality": "string",
      "citizenship": [
        "string"
      ],
      "date_of_birth": "2019-08-24",
      "ip_address": "string",
      "tax_reference_number_country": "string",
      "us_residency_status": "US_CITIZEN",
      "employment_status": "EMPLOYEE",
      "employment_description": "string",
      "employer_name": "string",
      "occupation": "string",
      "investment_profile": {
        "primary_source_of_funds": "EMPLOYMENT",
        "primary_source_of_funds_description": "string",
        "total_assets": "UPTO_10K",
        "usd_value_of_fiat": "UPTO_10K",
        "monthly_deposits": "UPTO_5",
        "monthly_withdrawals": "UPTO_5",
        "monthly_investment_deposit": "UPTO_1K",
        "monthly_investment_withdrawal": "UPTO_1K",
        "usd_value_of_crypto": "UPTO_10K",
        "monthly_crypto_deposits": "UPTO_5",
        "monthly_crypto_withdrawals": "UPTO_5",
        "monthly_crypto_investment_deposit": "UPTO_1K",
        "monthly_crypto_investment_withdrawal": "UPTO_1K"
      },
      "kyc_profile": {
        "funds_send_receive_jurisdictions": [
          "string"
        ],
        "business_jurisdictions": [
          "string"
        ],
        "engage_in_activities": [
          "NONE"
        ],
        "vendors_and_counterparties": [
          "SELF"
        ]
      }
    }
  }
}
```

--------------------------------

### POST /v1/counterparties/{counterparty_id}/link/details

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/getLinkingDetails

Retrieve linking instructions for embedding in a UI to launch account linking from providers such as MX or Plaid. This endpoint facilitates the initiation of the account linking process.

```APIDOC
## POST /v1/counterparties/{counterparty_id}/link/details

### Description
Retrieve the linking instructions for embedding in a UI to launch account linking from providers such as MX or Plaid. This endpoint facilitates the initiation of the account linking process.

### Method
POST

### Endpoint
/v1/counterparties/{counterparty_id}/link/details

### Parameters
#### Path Parameters
- **counterparty_id** (string) - Required - Counterparty ID

#### Header Parameters
- **Authorization** (string) - Required - OAuth bearer token (see authentication flows)
- **x-l2f-request-id** (string) - Optional - Unique ID per request, useful for fault resolution/diagnosis and audit.
- **x-l2f-idempotency-id** (string) - Optional - Unique ID used to safely retry an operation. See idempotency section for more details.

#### Request Body
- **linking_provider** (string) - Required - The provider for which linking instructions are required. Example: MX
- **is_mobile_webview** (boolean) - Required - Renders the widget in a mobile WebView. Executes URL updates in place of the JavaScript event postMessages.
- **ui_message_webview_url_scheme** (string) - Required - Used as a redirect destination at the end of OAuth.

### Request Example
```json
{
  "linking_provider": "MX",
  "is_mobile_webview": true,
  "ui_message_webview_url_scheme": "string"
}
```

### Response
#### Success Response (200)
- **linking_provider** (string) - Description of the linking provider.
- **is_mobile_webview** (boolean) - Indicates if the widget is rendered in a mobile WebView.
- **ui_message_webview_url_scheme** (string) - The URL scheme used for redirecting at the end of OAuth.
- **mx_widget_url** (string) - The URL for the MX widget.

#### Response Example
```json
{
  "linking_provider": "MX",
  "is_mobile_webview": true,
  "ui_message_webview_url_scheme": "string",
  "mx_widget_url": "string"
}
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **404** Not Found
- **500** Internal Error
```

--------------------------------

### GET /v1/withdrawals/{withdrawal_id}/receipt

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/getWithdrawalReceipt

Retrieves a receipt for a previously completed withdrawal.

```APIDOC
## GET /v1/withdrawals/{withdrawal_id}/receipt

### Description
Retrieves a receipt for a previously completed withdrawal.

### Method
GET

### Endpoint
/v1/withdrawals/{withdrawal_id}/receipt

### Parameters
#### Path Parameters
- **withdrawal_id** (string) - Required - Withdrawal ID

#### Header Parameters
- **Authorization** (string) - Required - Bearer token for authentication
- **x-l2f-request-id** (string) - Optional - Unique ID per request, useful for fault resolution/diagnosis and audit.

### Responses
#### Success Response (200)
- **receipt_data** (object) - The withdrawal receipt details.

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **404** Not Found
- **500** Internal Error

### Response Example (200)
```json
{
  "receipt_data": {
    "transaction_id": "txn_12345",
    "amount": "100.50",
    "currency": "USD",
    "status": "completed",
    "timestamp": "2023-10-27T10:00:00Z"
  }
}
```

### Response Example (Error)
```json
{
  "errors": [
    {
      "code": "string",
      "description": "string"
    }
  ]
}
```

--------------------------------

### POST /v1/applications/{application_id}/accesscode

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/createApplicationOneTimeCode

Generates an access code for use with the rail Customer Onboarding SDK. This endpoint requires authentication via OAuth2.

```APIDOC
## POST /v1/applications/{application_id}/accesscode

### Description
Generate an access code for use with the rail Customer Onboarding SDK.

### Method
POST

### Endpoint
/v1/applications/{application_id}/accesscode

### Parameters
#### Path Parameters
- **application_id** (string) - Required - The ID of the application for which to generate an access code.

#### Header Parameters
- **Authorization** (string) - Required - OAuth bearer token (see authentication flows).
- **x-l2f-request-id** (string) - Optional - Unique ID per request, useful for fault resolution/diagnosis and audit.
- **x-l2f-idempotency-id** (string) - Required - Unique ID used to safely retry an operation. See idempotency section for more details.

### Responses
#### Success Response (200)
- **data** (object) - Contains the generated access code details.
  - **id** (string) - The ID of the access code.
  - **access_code** (string) - The generated access code.
  - **expiry** (string) - The expiration timestamp of the access code in ISO 8601 format.

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **404** Not Found
- **500** Internal Error

### Response Example (200)
```json
{
  "data": {
    "id": "string",
    "access_code": "string",
    "expiry": "2019-08-24T14:15:22Z"
  }
}
```
```

--------------------------------

### Download Document API Request (GET /v1/documents/{document_id}/download)

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/downloadDocument

This snippet demonstrates how to make a GET request to download a document. It requires the document ID as a path parameter and an OAuth2 bearer token in the Authorization header. An optional `x-l2f-request-id` can be included for request tracing. The response will be a JSON object containing error details if the request fails, or the document content upon success.

```HTTP
GET /v1/documents/{document_id}/download HTTP/1.1
Host: api.rail.io
Authorization: Bearer <YOUR_ACCESS_TOKEN>
x-l2f-request-id: <UNIQUE_REQUEST_ID>


```

--------------------------------

### Retrieve Accounts API Request Example (JSON)

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/getAccounts

This JSON snippet represents a sample response for retrieving accounts. It includes account details such as ID, status, balances, and product type, along with pagination links.

```json
{
  "data": {
    "accounts": [
      {
        "id": "string",
        "status": "OPEN",
        "asset_type_id": "string",
        "product_type": "CLIENT",
        "product_id": "string",
        "customer_id": "string",
        "current_balance": 0,
        "available_balance": 0
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  }
}
```

--------------------------------

### GET /v1/transactions/{id}

Source: https://docs.rail.io/api-docs/openapi/layer2/operation/getTransaction

Retrieves the details of a single transaction using its unique ID.

```APIDOC
## GET /v1/transactions/{id}

### Description
Retrieves details of a single transaction.

### Method
GET

### Endpoint
/v1/transactions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Transaction ID

#### Header Parameters
- **Authorization** (string) - Required - OAuth bearer token (see authentication flows)
- **x-l2f-request-id** (string) - Optional - Unique ID per request, useful for fault resolution/diagnosis and audit.

### Response
#### Success Response (200)
- **data** (object) - Contains the transaction details.
  - **id** (string)
  - **value** (number)
  - **transaction_date** (string, format: date-time)
  - **transaction_posted_date** (string, format: date-time)
  - **transaction_status** (string)
  - **transaction_type** (string)
  - **category_type** (string)
  - **category_id** (string)
  - **description** (string)
  - **originator** (object)
    - **originator_type** (string)
    - **rail_reference** (string)
    - **rail_originator_memo** (string)
  - **rail_information** (object)
    - **rail** (string)
    - **reference** (string)
    - **memo** (string)

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **404** - Not Found
- **500** - Internal Error

### Response Example (200)
```json
{
  "data": {
    "id": "string",
    "value": 0,
    "transaction_date": "2019-08-24T14:15:22Z",
    "transaction_posted_date": "2019-08-24T14:15:22Z",
    "transaction_status": "AUTHORIZED",
    "transaction_type": "TRANSFER_IN",
    "category_type": "ADJUSTMENT",
    "category_id": "string",
    "description": "string",
    "originator": {
      "originator_type": "FIAT_US",
      "rail_reference": "string",
      "rail_originator_memo": "string"
    },
    "rail_information": {
      "rail": "string",
      "reference": "string",
      "memo": "string"
    }
  }
}
```
```
Tokens:
Raw