### Response Status Codes and Examples

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

This section details the possible responses from the QRed API, including success and error scenarios, along with example response bodies.

```APIDOC
## Responses

This API returns responses based on standard HTTP status codes. Below are details for common success and error responses.

### Success Responses

#### 200 OK

**Description:** The request was successful.

**Response Body Example:**
```json
{
  "filters": {},
  "value": {}
}
```

#### 201 Created

**Description:** The resource was successfully created.

**Response Body Example:**
```json
{
  "id": "string",
  "url": "string"
}
```

### Error Responses

#### 400 BAD REQUEST

**Description:** The request could not be understood or was invalid.

**Response Body Example:**
```json
{
  "cause": {
    "localizedMessage": "string",
    "message": "string",
    "stackTrace": [
      {
        "className": "string",
        "fileName": "string",
        "lineNumber": 0,
        "methodName": "string",
        "nativeMethod": true
      }
    ],
    "suppressed": [
      null
    ]
  },
  "errorContainer": {
    "errorList": [
      {
        "description": "string",
        "property": "string"
      }
    ]
  },
  "localizedMessage": "string",
  "message": "string",
  "stackTrace": [
    {
      "className": "string",
      "fileName": "string",
      "lineNumber": 0,
      "methodName": "string",
      "nativeMethod": true
    }
  ],
  "suppressed": [
    {
      "localizedMessage": "string",
      "message": "string",
      "stackTrace": [
        {
          "className": "string",
          "fileName": "string",
          "lineNumber": 0,
          "methodName": "string",
          "nativeMethod": true
        }
      ],
      "suppressed": [
        null
      ]
    }
  ]
}
```

#### 401 UNAUTHORIZED

**Description:** Authentication is required and has failed or has not yet been provided.

**Response Body Example:**
```json
{
  "cause": {
    "localizedMessage": "string",
    "message": "string",
    "stackTrace": [
      {
        "className": "string",
        "fileName": "string",
        "lineNumber": 0,
        "methodName": "string",
        "nativeMethod": true
      }
    ],
    "suppressed": [
      null
    ]
  },
  "localizedMessage": "string",
  "message": "string",
  "stackTrace": [
    {
      "className": "string",
      "fileName": "string",
      "lineNumber": 0,
      "methodName": "string",
      "nativeMethod": true
    }
  ],
  "suppressed": [
    {
      "localizedMessage": "string",
      "message": "string",
      "stackTrace": [
        {
          "className": "string",
          "fileName": "string",
          "lineNumber": 0,
          "methodName": "string",
          "nativeMethod": true
        }
      ],
      "suppressed": [
        null
      ]
    }
  ]
}
```

#### 403 FORBIDDEN

**Description:** The server understood the request, but refuses to authorize it.

**Response Body Example:**
```json
{
  "cause": {
    "localizedMessage": "string",
    "message": "string",
    "stackTrace": [
      {
        "className": "string",
        "fileName": "string",
        "lineNumber": 0,
        "methodName": "string",
        "nativeMethod": true
      }
    ],
    "suppressed": [
      null
    ]
  },
  "localizedMessage": "string",
  "message": "string",
  "stackTrace": [
    {
      "className": "string",
      "fileName": "string",
      "lineNumber": 0,
      "methodName": "string",
      "nativeMethod": true
    }
  ],
  "suppressed": [
    {
      "localizedMessage": "string",
      "message": "string",
      "stackTrace": [
        {
          "className": "string",
          "fileName": "string",
          "lineNumber": 0,
          "methodName": "string",
          "nativeMethod": true
        }
      ],
      "suppressed": [
        null
      ]
    }
  ]
}
```

#### 404 NOT FOUND

**Description:** The requested resource could not be found.

**Response Body Example:**
```json
{
  "cause": {
    "localizedMessage": "string",
    "message": "string",
    "stackTrace": [
      {
        "className": "string",
        "fileName": "string",
        "lineNumber": 0,
        "methodName": "string",
        "nativeMethod": true
      }
    ],
    "suppressed": [
      null
    ]
  },
  "localizedMessage": "string",
  "message": "string",
  "stackTrace": [
    {
      "className": "string",
      "fileName": "string",
      "lineNumber": 0,
      "methodName": "string",
      "nativeMethod": true
    }
  ],
  "suppressed": [
    {
      "localizedMessage": "string",
      "message": "string",
      "stackTrace": [
        {
          "className": "string",
          "fileName": "string",
          "lineNumber": 0,
          "methodName": "string",
          "nativeMethod": true
        }
      ],
      "suppressed": [
        null
      ]
    }
  ]
}
```

#### 500 INTERNAL ERROR

**Description:** An internal server error occurred.

**Response Body Example:**
```json
{
  "cause": {
    "localizedMessage": "string",
    "message": "string",
    "stackTrace": [
      {
        "className": "string",
        "fileName": "string",
        "lineNumber": 0,
        "methodName": "string",
        "nativeMethod": true
      }
    ],
    "suppressed": [
      null
    ]
  },
  "localizedMessage": "string",
  "message": "string",
  "stackTrace": [
    {
      "className": "string",
      "fileName": "string",
      "lineNumber": 0,
      "methodName": "string",
      "nativeMethod": true
    }
  ],
  "suppressed": [
    {
      "localizedMessage": "string",
      "message": "string",
      "stackTrace": [
        {
          "className": "string",
          "fileName": "string",
          "lineNumber": 0,
          "methodName": "string",
          "nativeMethod": true
        }
      ],
      "suppressed": [
        null
      ]
    }
  ]
}
```
```

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

### Retrieve Pre-Offer Application Bid Offer (GET /application/pre-offer/{id})

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

This snippet demonstrates how to make a GET request to retrieve the bid offer for a pre-offer application. It requires an Authorization header with a JWT token and the application ID in the path. The response will contain the bid offer details.

```http
GET /application/pre-offer/ap_0eac0726-f864-4b37-9915-c91b003fdec1 HTTP/1.1
Host: api.qred.com
Authorization: Bearer <YOUR_AUTH0_JWT_TOKEN>
Content-Type: application/json
```

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

### GET /applications

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Retrieves a list of all applications associated with the partner ID provided in the authentication token. Supports pagination for managing large datasets.

```APIDOC
## GET /applications

### Description
Retrieves all applications by partner ID. This endpoint uses the partner ID present in the authentication token to filter applications.

### Method
GET

### Endpoint
/applications

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - Auth0Jwt token to access secured endpoints. Example: Bearer token

#### Query Parameters
- **page** (string) - Optional - The page number for pagination. Example: 1
- **perPage** (string) - Optional - The number of items per page. Example: 1

### Request Example
```json
{
  "Authorization": "Bearer your_token"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the application.
- **url** (string) - The URL associated with the application.

#### Response Example (200)
```json
{
  "id": "string",
  "url": "string"
}
```

#### Error Responses
- **400 Bad Request**: Returned when the request is malformed or invalid.
- **403 Forbidden**: Returned when the authenticated user does not have permission to access the resource.
- **404 Not Found**: Returned when the requested resource does not exist.
- **500 Internal Server Error**: Returned when an unexpected error occurs on the server.

#### Response Example (400)
```json
{
  "cause": {
    "localizedMessage": "string",
    "message": "string",
    "stackTrace": [
      {
        "className": "string",
        "fileName": "string",
        "lineNumber": 0,
        "methodName": "string",
        "nativeMethod": true
      }
    ],
    "suppressed": [
      null
    ]
  },
  "errorContainer": {
    "errorList": [
      {
        "description": "string",
        "property": "string"
      }
    ]
  },
  "localizedMessage": "string",
  "message": "string",
  "stackTrace": [
    {
      "className": "string",
      "fileName": "string",
      "lineNumber": 0,
      "methodName": "string",
      "nativeMethod": true
    }
  ],
  "suppressed": [
    {
      "localizedMessage": "string",
      "message": "string",
      "stackTrace": [
        {
          "className": "string",
          "fileName": "string",
          "lineNumber": 0,
          "methodName": "string",
          "nativeMethod": true
        }
      ],
      "suppressed": [
        null
      ]
    }
  ]
}
```
```

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

### Get Pre-Offer Application Status

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Retrieves information about the bid for a pre-offer application, including its status (`PENDING` or `PRE_OFFER`).

```APIDOC
## GET /application/pre-offer/{id}

### Description
Retrieves information about the bid for a pre-offer application, including its status.

### Method
GET

### Endpoint
/application/pre-offer/{id}

### Parameters
#### Path Parameters
- **id** (String) - Required - The ID of the pre-offer application.

### Response
#### Success Response (200)
- **status** (String) - The status of the pre-offer application (`PENDING` or `PRE_OFFER`).
- **amount** (Number) - The bid amount (if status is `PRE_OFFER`).
- **bidValidityEndDate** (String) - The end date of the bid validity (if status is `PRE_OFFER`).
- **bidValidityPeriod** (String) - The validity period of the bid (if status is `PRE_OFFER`).
- **bidValidityStartDate** (String) - The start date of the bid validity (if status is `PRE_OFFER`).
- **monthlyFee** (Number) - The monthly fee (if status is `PRE_OFFER`).
- **monthlyFeePercent** (Number) - The monthly fee percentage (if status is `PRE_OFFER`).
- **monthlyToPay** (Number) - The monthly amount to pay (if status is `PRE_OFFER`).
- **term** (Number) - The loan term in months (if status is `PRE_OFFER`).
- **totalFee** (Number) - The total fee (if status is `PRE_OFFER`).
- **totalToPay** (Number) - The total amount to pay (if status is `PRE_OFFER`).

#### Response Example (PENDING)
```json
{
  "status": "PENDING"
}
```

#### Response Example (PRE_OFFER)
```json
{
  "amount": 0,
  "bidValidityEndDate": "string",
  "bidValidityPeriod": "string",
  "bidValidityStartDate": "string",
  "monthlyFee": 0,
  "monthlyFeePercent": 0,
  "monthlyToPay": 0,
  "status": "PRE_OFFER",
  "term": 0,
  "totalFee": 0,
  "totalToPay": 0
}
```
```

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

### Get Pre-Offer Application Status (Pre-Offer)

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Retrieves the status of a pre-offer application. When the status is PRE_OFFER, it indicates the customer is waiting to accept the bid. The response includes bid details. This is done via a GET call to /application/pre-offer/{id}.

```JSON
{
  "amount": 0,
  "bidValidityEndDate": "string",
  "bidValidityPeriod": "string",
  "bidValidityStartDate": "string",
  "monthlyFee": 0,
  "monthlyFeePercent": 0,
  "monthlyToPay": 0,
  "status": "PRE_OFFER",
  "term": 0,
  "totalFee": 0,
  "totalToPay": 0
}
```

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

### Get Application Status

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Retrieves the status of a single loan application via a GET request to /applicaton/{id}. Possible statuses include REGISTERED, WAITING, EXPIRED, CANCELLED, REJECTED, and APPROVED.

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

### Get Pre-Offer Application Status (Pending)

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Retrieves the status of a pre-offer application. For a PENDING status, the response indicates that underwriters need to accept the pre-offer. This is done via a GET call to /application/pre-offer/{id}.

```JSON
{
  "status": "PENDING"
}
```

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

### Qred API: 200 OK Response Example

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

This snippet shows the expected JSON structure for a successful response (200 OK) from the Qred API. It includes details about the loan amount, fees, status, and validity periods.

```json
{
  "amount": 0,
  "bidValidityEndDate": "string",
  "bidValidityPeriod": "string",
  "bidValidityStartDate": "string",
  "monthlyFee": 0,
  "monthlyFeePercent": 0,
  "monthlyToPay": 0,
  "status": "Approved",
  "term": 0,
  "totalFee": 0,
  "totalToPay": 0
}
```

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

### Get Application Status

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Retrieves the status of a single loan application.

```APIDOC
## GET /application/{id}

### Description
Retrieves the status of a single loan application.

### Method
GET

### Endpoint
/application/{id}

### Parameters
#### Path Parameters
- **id** (String) - Required - The ID of the application.

### Response
#### Success Response (200)
- **status** (String) - The status of the loan application. Possible values: `REGISTERED`, `WAITING`, `EXPIRED`, `CANCELLED`, `REJECTED`, `APPROVED`.
```

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

### GET /application/pre-offer/{id}

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Retrieves the bid offer details for a specific pre-offer application using its unique identifier.

```APIDOC
## GET /application/pre-offer/{id}

### Description
Retrieves the bid offer for the pre-offer application.

### Method
GET

### Endpoint
/application/pre-offer/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Connect Application UUID

#### Header Parameters
- **Authorization** (string) - Required - Auth0Jwt token to access secured endpoints. Example: Bearer token

### Response
#### Success Response (200)
*Example*
```json
{
  "example": "response body"
}
```
```

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

### Qred API GET /applications Endpoint

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Retrieves a list of all applications associated with a partner ID. This endpoint requires an Authorization header with a Bearer token and supports optional query parameters for pagination (page and perPage).

```http
GET /applications?page=1&perPage=10
Authorization: Bearer <your_token>
```

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

### Get All Applications by Partner ID

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Retrieves all applications associated with a specific partner ID, which is obtained from the access token.

```APIDOC
## GET /applications

### Description
Retrieves all applications for a single partner. The partner ID is retrieved from the access token.

### Method
GET

### Endpoint
/applications
```

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

### GET /application/{id}

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Retrieves the status of a specific application using its unique identifier.

```APIDOC
## GET /application/{id}

### Description
Get an application status by ID

### Method
GET

### Endpoint
/application/{id}

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - Auth0 Jwt token to access secured endpoints. *Example*: Bearer token

#### Path Parameters
- **id** (string) - Required - Connect Application UUID. *Example*: ap_0eac0726-f864-4b37-9915-c91b003fdec1

### Response
#### Success Response (200)
- **status** (string) - The current status of the application.
- **applicationId** (string) - The unique identifier of the application.

#### Response Example
```json
{
  "status": "approved",
  "applicationId": "ap_0eac0726-f864-4b37-9915-c91b003fdec1"
}
```
```

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

### API Success Response (200 OK) Example

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

This snippet shows the expected JSON structure for a successful API request, indicated by a 200 OK status code. It typically includes a 'status' field.

```json
{
  "status": "Approved"
}
```

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

### Create Loan Application

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Creates a loan application, either through the pre-offer process or directly.

```APIDOC
## POST /application

### Description
Creates a loan application. This can be done through the pre-offer process or directly.

### Method
POST

### Endpoint
/application

### Response
#### Success Response (200)
- **id** (String) - The ID of the created loan application.
- **url** (String) - The URL to the created loan application.
```

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

### POST /application/pre-offer

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Creates a pre-offer application by submitting detailed applicant and organization information.

```APIDOC
## POST /application/pre-offer

### Description
Creates a pre-offer application by submitting detailed applicant and organization information.

### Method
POST

### Endpoint
/application/pre-offer

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **postRequest** (object) - Required - Post request body for creating a pre-offer application.
  - **amount** (number) - Required - The loan amount requested.
  - **applicant** (object) - Required - Information about the applicant.
    - **additionalName** (string) - Optional - Additional name details for the applicant.
    - **allow_person_report_fetch** (boolean) - Required - Indicates if person report fetching is allowed.
    - **dateOfBirth** (string) - Required - The applicant's date of birth (YYYY-MM-DD).
    - **email** (string) - Required - The applicant's email address.
    - **familyName** (string) - Required - The applicant's family name.
    - **givenName** (string) - Required - The applicant's given name.
    - **nationalIdentificationNumber** (string) - Required - The applicant's national identification number.
    - **phone** (string) - Required - The applicant's phone number.
    - **placeOfBirth** (string) - Required - The applicant's place of birth.
    - **politicallyExposedPerson** (boolean) - Required - Indicates if the applicant is a politically exposed person.
  - **files** (array) - Optional - An array of files to be submitted with the application.
    - **base64Content** (string) - Required - The base64 encoded content of the file.
    - **encodingFormat** (array) - Required - The encoding format of the file.
    - **filename** (string) - Required - The name of the file.
  - **organization** (object) - Optional - Information about the organization.
    - **currentMonthlyTurnover** (string) - Required - The organization's current monthly turnover.
    - **email** (string) - Required - The organization's email address.
    - **iban** (string) - Required - The organization's IBAN.
    - **nationalOrganizationNumber** (string) - Required - The organization's national organization number.
    - **numberOfEmployees** (string) - Required - The number of employees in the organization.
    - **owners** (array) - Optional - An array of organization owners.
      - **additionalName** (string) - Optional - Additional name details for the owner.
      - **dateOfBirth** (string) - Required - The owner's date of birth (YYYY-MM-DD).
      - **familyName** (string) - Required - The owner's family name.
      - **givenName** (string) - Required - The owner's given name.
      - **nationalIdentificationNumber** (string) - Required - The owner's national identification number.
      - **ownerShipPercent** (number) - Required - The owner's ownership percentage.
      - **placeOfBirth** (string) - Required - The owner's place of birth.
    - **phone** (string) - Required - The organization's phone number.
    - **url** (string) - Required - The organization's website URL.
  - **politicallyExposedPersons** (array) - Optional - An array of politically exposed persons associated with the application.
    - **additionalName** (string) - Optional - Additional name details for the PEP.
    - **dateOfBirth** (string) - Required - The PEP's date of birth (YYYY-MM-DD).
    - **description** (string) - Required - A description of the PEP's relation.
    - **familyName** (string) - Required - The PEP's family name.
    - **givenName** (string) - Required - The PEP's given name.
    - **nationalIdentificationNumber** (string) - Required - The PEP's national identification number.
    - **placeOfBirth** (string) - Required - The PEP's place of birth.
  - **promoCode** (string) - Optional - A promotional code to be applied.
  - **purposeOfLoan** (string) - Required - The purpose of the loan.
  - **term** (number) - Required - The loan term in months.

### Request Example
```json
{
  "amount": 50000,
  "applicant": {
    "additionalName": "",
    "allow_person_report_fetch": true,
    "dateOfBirth": "1990-05-15",
    "email": "applicant@example.com",
    "familyName": "Doe",
    "givenName": "John",
    "nationalIdentificationNumber": "123456789",
    "phone": "+1234567890",
    "placeOfBirth": "New York",
    "politicallyExposedPerson": false
  },
  "organization": {
    "currentMonthlyTurnover": "100000",
    "email": "info@company.com",
    "iban": "GB33BUKB20201555555555",
    "nationalOrganizationNumber": "987654321",
    "numberOfEmployees": "10",
    "owners": [
      {
        "additionalName": "",
        "dateOfBirth": "1985-10-20",
        "familyName": "Smith",
        "givenName": "Jane",
        "nationalIdentificationNumber": "987654321",
        "ownerShipPercent": 50,
        "placeOfBirth": "Los Angeles"
      }
    ],
    "phone": "+19876543210",
    "url": "http://www.company.com"
  },
  "politicallyExposedPersons": [],
  "promoCode": "SUMMER2024",
  "purposeOfLoan": "Working capital",
  "term": 12
}
```

### Response
#### Success Response (200)
- **applicationId** (string) - The unique identifier for the created pre-offer application.
- **status** (string) - The current status of the application (e.g., "PENDING_REVIEW").

#### Response Example
```json
{
  "applicationId": "app_12345abcde",
  "status": "PENDING_REVIEW"
}
```

#### Error Response (4xx or 5xx)
- **error** (object) - An object containing error details.
  - **code** (string) - An error code.
  - **message** (string) - A human-readable error message.
```

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

### POST /api/applications

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Endpoint for creating a new loan application. Requires authentication and a detailed request body.

```APIDOC
## POST /api/applications

### Description
Endpoint for creating a new loan application. Requires authentication and a detailed request body.

### Method
POST

### Endpoint
/api/applications

### Parameters
#### Path Parameters

#### Query Parameters

#### Request Body
- **Authorization** (string) - Required - Auth0Jwt token to access secured endpoints. Example: Bearer token
- **postRequest** (object) - Required - Post request body for creating application

### Request Example
```json
{
  "Authorization": "Bearer YOUR_AUTH_TOKEN",
  "postRequest": {
    "amount": 10000,
    "applicant": {
      "additionalName": "Sr.",
      "allow_person_report_fetch": true,
      "dateOfBirth": "1990-01-01",
      "email": "john.doe@example.com",
      "familyName": "Doe",
      "givenName": "John",
      "nationalIdentificationNumber": "123456789",
      "phone": "+1234567890",
      "placeOfBirth": "New York",
      "politicallyExposedPerson": false
    },
    "files": [
      {
        "base64Content": "JVBERi0xLjc=",
        "encodingFormat": [
          "PDF"
        ],
        "filename": "financial_statement.pdf"
      }
    ],
    "organization": {
      "currentMonthlyTurnover": "100000",
      "email": "contact@company.com",
      "iban": "NL91ABNA0412674301",
      "nationalOrganizationNumber": "ORG12345",
      "numberOfEmployees": "50",
      "owners": [
        {
          "additionalName": "Jr.",
          "dateOfBirth": "1995-05-05",
          "familyName": "Smith",
          "givenName": "Jane",
          "nationalIdentificationNumber": "987654321",
          "ownerShipPercent": 50,
          "placeOfBirth": "Los Angeles"
        }
      ],
      "phone": "+19876543210",
      "url": "http://company.com"
    },
    "politicallyExposedPersons": [],
    "promoCode": "SUMMER2024",
    "purposeOfLoan": "Working Capital",
    "term": 12
  }
}
```

### Response
#### Success Response (200)
- **applicationId** (string) - The unique identifier for the newly created application.

#### Response Example
```json
{
  "applicationId": "app_12345abcde"
}
```

### Error Handling
- **400 Bad Request**: Invalid input data.
- **401 Unauthorized**: Missing or invalid authentication token.
- **500 Internal Server Error**: Unexpected server error.
```

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

### Create Pre-Offer Application

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Creates a pre-offer application to request a bid from the customer. Returns the pre-offer application ID and URL upon success.

```APIDOC
## POST /application/pre-offer

### Description
Creates a pre-offer application to request a bid from the customer.

### Method
POST

### Endpoint
/application/pre-offer

### Request Body
* **additionalName** (String) - Optional
* **dateOfBirth** (String) - Optional
* **description** (String) - Optional
* **familyName** (String) - Optional
* **givenName** (String) - Optional
* **nationalIdentificationNumber** (String) - Optional. SE: `(19|20)[0-9]{10}`, FI: `[0-9]{6}[-A][0-9]{3}[0-9A-Y]`
* **placeOfBirth** (String) - Optional

### Response
#### Success Response (200)
- **id** (String) - The ID of the created pre-offer application.
- **url** (String) - The URL to the created pre-offer application.

#### Response Example
```json
{
  "id": "pre_offer_application_id",
  "url": "pre_offer_application_url"
}
```
```

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

### Create Pre-Offer Application

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Creates a pre-offer application to request a bid. A POST request to /application/pre-offer is used. The response includes the pre-offer application ID and its URL.

```JSON
{
  "id": "pre_offer_application_id",
  "url": "pre_offer_application_url"
}
```

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

### Pre-offer/Loan Application API

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Submit a pre-offer or loan application with detailed information about the applicant, organization, and loan request.

```APIDOC
## POST /applications

### Description
Submit a new pre-offer or loan application. This endpoint requires comprehensive details about the applicant and the organization seeking the loan.

### Method
POST

### Endpoint
`/applications`

### Parameters
#### Request Body
- **amount** (number) - Required - The requested loan amount. Must be greater than 0.
- **applicant** (object) - Required - Information about the applicant.
  - **additionalName** (string) - Optional - Applicant's additional name.
  - **allow_person_report_fetch** (boolean) - Optional - Whether to allow fetching person reports.
  - **dateOfBirth** (string) - Optional - Applicant's date of birth (YYYY-MM-DD).
  - **email** (string) - Required - Applicant's email address. Must be a valid email format.
  - **familyName** (string) - Optional - Applicant's last name.
  - **givenName** (string) - Optional - Applicant's first name.
  - **nationalIdentificationNumber** (string) - Required - Applicant's national identification number (SE: `(19|20)[0-9]{10}`, FI: `[0-9]{6}[-A][0-9]{3}[0-9A-Y]`).
  - **phone** (string) - Optional - Applicant's phone number (SE: >= 9 digits, FI: >= 6 digits).
  - **placeOfBirth** (string) - Optional - Applicant's place of birth.
  - **politicallyExposedPerson** (boolean) - Optional - Indicates if the applicant is a politically exposed person.
- **files** (array) - Optional - An array of files to be uploaded.
  - **base64Content** (string) - Required - Base64 encoded content of the file.
  - **encodingFormat** (array) - Required - The encoding format of the file.
  - **filename** (string) - Required - The name of the file.
- **organization** (object) - Required - Information about the organization.
  - **currentMonthlyTurnover** (string) - Optional - Organization's current monthly turnover. Max 50 characters.
  - **email** (string) - Required - Organization's email address. Must be a valid email format.
  - **iban** (string) - Optional - Organization's IBAN.
  - **nationalOrganizationNumber** (string) - Required - Organization's national organization number (SE: `[0-9]{10}`, FI: `[0-9]{7}-[0-9]`).
  - **numberOfEmployees** (string) - Optional - The number of employees in the organization.
  - **owners** (array) - Optional - An array of organization owners.
    - **additionalName** (string) - Optional - Owner's additional name.
    - **dateOfBirth** (string) - Optional - Owner's date of birth (YYYY-MM-DD).
    - **familyName** (string) - Optional - Owner's last name.
    - **givenName** (string) - Optional - Owner's first name.
    - **nationalIdentificationNumber** (string) - Optional - Owner's national identification number (SE: `(19|20)[0-9]{10}`, FI: `[0-9]{6}[-A][0-9]{3}[0-9A-Y]`).
    - **ownerShipPercent** (number) - Optional - Owner's ownership percentage.
    - **placeOfBirth** (string) - Optional - Owner's place of birth.
  - **phone** (string) - Optional - Organization's phone number (SE: >= 9 digits, FI: >= 6 digits).
  - **url** (string) - Optional - Organization's website URL.
- **politicallyExposedPersons** (array) - Optional - An array of politically exposed persons related to the application.
  - **additionalName** (string) - Optional - PEP's additional name.
  - **dateOfBirth** (string) - Optional - PEP's date of birth (YYYY-MM-DD).
  - **description** (string) - Optional - Description of the PEP relationship.
  - **familyName** (string) - Optional - PEP's last name.
  - **givenName** (string) - Optional - PEP's first name.
  - **nationalIdentificationNumber** (string) - Optional - PEP's national identification number.
  - **placeOfBirth** (string) - Optional - PEP's place of birth.
- **promoCode** (string) - Optional - A promotional code to apply.
- **purposeOfLoan** (string) - Optional - The purpose of the loan. Max 2000 characters.
- **term** (number) - Optional - The loan term in months.

### Request Example (Required Parameters Only)
```json
{
  "amount": 10000,
  "applicant": {
    "nationalIdentificationNumber": "SE199001011234",
    "email": "applicant@example.com"
  },
  "organization": {
    "nationalOrganizationNumber": "SE1234567890",
    "email": "organization@example.com"
  }
}
```

### Response
#### Success Response (200)
- **applicationId** (string) - The ID of the submitted application.
- **status** (string) - The current status of the application (e.g., `PENDING`, `APPROVED`, `REJECTED`).

#### Response Example
```json
{
  "applicationId": "app_12345abcde",
  "status": "PENDING"
}
```
```

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

### Accept Pre-Offer Bid

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Accepts a bid for a pre-offer application, creating a loan application. Returns the loan application ID and URL upon success.

```APIDOC
## POST /application/pre-offer/{id}/accept

### Description
Accepts a bid for a pre-offer application, creating a loan application. Returns the loan application ID and URL upon success.

### Method
POST

### Endpoint
/application/pre-offer/{id}/accept

### Parameters
#### Path Parameters
- **id** (String) - Required - The ID of the pre-offer application.

### Response
#### Success Response (200)
- **id** (String) - The ID of the created loan application.
- **url** (String) - The URL to the created loan application.

#### Response Example
```json
{
  "id": "loan_application_id",
  "url": "loan_application_url"
}
```
```

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

### Accept Pre-Offer Bid

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Accepts a pre-offer bid, which creates a loan application. A POST request to /application/pre-offer/{id}/accept is used. The response returns the loan application ID and its URL.

```JSON
{
  "id": "loan_application_id",
  "url": "loan_application_url"
}
```

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

### Pre-offer/Loan Application Full Request Body

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

This JSON object defines the complete request body for a pre-offer or loan application. It includes detailed information about the applicant, organization, loan terms, and associated files.

```json
{
  "amount": 0,
  "applicant": {
    "additionalName": "string",
    "allow_person_report_fetch": true,
    "dateOfBirth": "string",
    "email": "string",
    "familyName": "string",
    "givenName": "string",
    "nationalIdentificationNumber": "string",
    "phone": "string",
    "placeOfBirth": "string",
    "politicallyExposedPerson": true
  },
  "files": [
    {
      "base64Content": "string",
      "encodingFormat": [
        "string"
      ],
      "filename": "string"
    }
  ],
  "organization": {
    "currentMonthlyTurnover": "string",
    "email": "string",
    "iban": "string",
    "nationalOrganizationNumber": "string",
    "numberOfEmployees": "string",
    "owners": [
      {
        "additionalName": "string",
        "dateOfBirth": "string",
        "familyName": "string",
        "givenName": "string",
        "nationalIdentificationNumber": "string",
        "ownerShipPercent": 0,
        "placeOfBirth": "string"
      }
    ],
    "phone": "string",
    "url": "string"
  },
  "politicallyExposedPersons": [
    {
      "additionalName": "string",
      "dateOfBirth": "string",
      "description": "string",
      "familyName": "string",
      "givenName": "string",
      "nationalIdentificationNumber": "string",
      "placeOfBirth": "string"
    }
  ],
  "promoCode": "string",
  "purposeOfLoan": "string",
  "term": 0
}
```

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

### Accept Pre-Offer Bid

Source: https://github.com/soriaas/qred-api-documentation/blob/main/api-reference.md

Accepts a pre-offer bid for a given application ID. Requires authorization with a JWT token.

```APIDOC
## POST /application/pre-offer/{id}/accept

### Description
Accepts a pre-offer bid for a specific application.

### Method
POST

### Endpoint
/application/pre-offer/{id}/accept

### Parameters
#### Path Parameters
- **id** (string) - Required - Connect Application UUID

#### Header Parameters
- **Authorization** (string) - Required - Auth0Jwt token to access secured endpoints. Example: Bearer token

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **message** (string) - Success message indicating the pre-offer was accepted.

#### Response Example
```json
{
  "message": "Pre-offer accepted successfully."
}
```
```