Powens

https://docs.powens.com/
Admin
Powens is an API platform that enables developers to integrate financial data aggregation, payment...
Tokens:82,453
Snippets:977
Trust Score:8.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Resource Path Examples

Source: https://docs.powens.com/api-reference/overview/api-design.md

Examples of endpoint paths for resource management and deep sub-resource access.

```text
/connections/*
```

```text
/accounts/*
```

```text
/auth/*
```

```text
/users/1/connections/2/accounts/23/transactions/48
```

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

### Install CocoaPods Dependencies

Source: https://docs.powens.com/documentation/sdk/powens-connect-ios.md

Command to install the dependencies defined in the Podfile.

```typescript
pod install
```

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

### Perform a paginated GET request

Source: https://docs.powens.com/api-reference

Example of a GET request using query parameters for filtering and pagination.

```http
GET /users/me/transactions?min_date=2022-12-01&income=false&limit=50
```

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

### GET /clients

Source: https://docs.powens.com/api-reference/api-setup/client-applications.md

Lists all client applications.

```APIDOC
## GET /clients

### Description
Retrieves a list of all client applications.

### Method
GET

### Endpoint
https://{domain}.biapi.pro/2.0/clients

### Response
#### Success Response (200)
- **clientappslist-object** (object) - A list of client applications.
```

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

### Connector Field Prefilling Example

Source: https://docs.powens.com/api-reference/overview/webview.md

Example of pre-selecting a field value for a specific connector using its UUID.

```text
f5c29767-1bc8-5337-9e4e-68a0fbd91c9a.website=pro
```

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

### GET /documentation/integration-guides/quick-start/add-a-first-user-and-connection.md

Source: https://docs.powens.com/documentation/integration-guides/quick-start/add-a-first-user-and-connection.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /documentation/integration-guides/quick-start/add-a-first-user-and-connection.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/quick-start/add-a-first-user-and-connection.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Query documentation via HTTP GET

Source: https://docs.powens.com/api-reference/products/banking-aggregation/account-ownerships

Perform an HTTP GET request to the documentation index to retrieve answers and excerpts based on a specific question and optional goal.

```http
GET https://docs.powens.com/api-reference/products/data-aggregation/account-ownerships.md?ask=<question>&goal=<end_goal>
```

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

### Unauthorized Response Example

Source: https://docs.powens.com/api-reference/products/wealth-aggregation/loan-amortizations.md

Example of the response body returned when authentication fails.

```javascript
{
    // Response
}
```

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

### GET /documentation/integration-guides/pay-by-bank/initiating-a-bulk-payment-with-the-webview.md

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank/initiating-a-bulk-payment-with-the-webview.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /documentation/integration-guides/pay-by-bank/initiating-a-bulk-payment-with-the-webview.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, or context related to the current page.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/pay-by-bank/initiating-a-bulk-payment-with-the-webview.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Query Documentation via HTTP GET

Source: https://docs.powens.com/documentation/integration-guides/indicators-for-credit-check.md

Perform an HTTP GET request to the documentation URL to retrieve answers to specific questions.

```http
GET https://docs.powens.com/documentation/integration-guides/indicators-for-credit-check.md?ask=<question>&goal=<endgoal>
```

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

### Deep Path Resource Example

Source: https://docs.powens.com/api-reference

An example of a nested resource path used to access specific sub-resources within the API hierarchy.

```text
/users/1/connections/2/accounts/23/transactions/48
```

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

### GET /documentation/integration-guides/pay-by-bank/initiating-a-one-time-payment-with-the-webview.md

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank/initiating-a-one-time-payment-with-the-webview.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /documentation/integration-guides/pay-by-bank/initiating-a-one-time-payment-with-the-webview.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/pay-by-bank/initiating-a-one-time-payment-with-the-webview.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /connectors/

Source: https://docs.powens.com/documentation/integration-guides/quick-start/api-overview.md

Lists all available banks and providers.

```APIDOC
## GET /connectors/

### Description
Lists all available banks and providers.

### Method
GET

### Endpoint
https://{domain}.biapi.pro/2.0/connectors/
```

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

### PaymentAppToAppUsed Object Example

Source: https://docs.powens.com/api-reference/user-connections/connectors.md

Example of the object used to define native application redirection capabilities for Android and iOS.

```json
{
  "android": false,
  "ios": null
}
```

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

### HMAC Signature Calculation Example

Source: https://docs.powens.com/documentation/integration-guides/webhooks.md

Example of the signature calculation using the HMAC-SHA256 algorithm.

```text
BASE_64(HMAC_SHA256('POST./v1/webhook-listener.2022-06-27T11:08:52.577831Z.{"id": 1, "state": "done", ...}', secret_key))
```

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

### GET /connectors

Source: https://docs.powens.com/documentation/integration-guides/transactions/transactions-integration-guide.md

Retrieves the list of supported sources for a connector.

```APIDOC
## GET /connectors

### Description
Retrieves the list of supported sources for a connector by expanding the sources field.

### Method
GET

### Endpoint
/connectors?expand=sources

### Parameters
#### Query Parameters
- **expand** (string) - Required - Set to 'sources' to include source details.

### Response
#### Success Response (200)
- **connectors** (array) - List of connectors with their respective sources.

#### Response Example
{
  "connectors": [
    {
      "id": 1,
      "name": "Bank name",
      "sources": [
        {
          "name": "openapi",
          "priority": 1,
          "account_types": [],
          "disabled": null
        }
      ]
    }
  ]
}
```

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

### GET /documentation/integration-guides/webhooks.md

Source: https://docs.powens.com/documentation/integration-guides/webhooks.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /documentation/integration-guides/webhooks.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/webhooks.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /documentation/integration-guides/pay-by-bank/advanced/implementing-your-own-payment-validation-webview.md

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank/advanced/implementing-your-own-payment-validation-webview.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /documentation/integration-guides/pay-by-bank/advanced/implementing-your-own-payment-validation-webview.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/pay-by-bank/advanced/implementing-your-own-payment-validation-webview.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /config

Source: https://docs.powens.com/documentation/integration-guides/quick-start/api-overview.md

Lists all parameters that can be configured to adapt the API to specific needs.

```APIDOC
## GET /config

### Description
Lists all parameters that can be changed to adapt the API to your needs. Requires authentication.

### Method
GET

### Endpoint
https://{domain}.biapi.pro/2.0/config

### Parameters
#### Request Headers
- **authorization** (string) - Required - Bearer <token>
```

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

### GET /documentation/ressources.md

Source: https://docs.powens.com/documentation/ressources

Queries the documentation for specific information using natural language.

```APIDOC
## GET /documentation/ressources.md

### Description
Perform a natural language query against the documentation to retrieve answers, excerpts, and sources.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/ressources.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /documentation/integration-guides/advanced/end-to-end-encryption.md

Source: https://docs.powens.com/documentation/integration-guides/advanced/end-to-end-encryption.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /documentation/integration-guides/advanced/end-to-end-encryption.md

### Description
Queries the current documentation page to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/advanced/end-to-end-encryption.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /documentation/integration-guides/quick-start.md

Source: https://docs.powens.com/documentation/integration-guides/quick-start.md

Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /documentation/integration-guides/quick-start.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present on the current page.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/quick-start.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /account_types/{typeId}

Source: https://docs.powens.com/api-reference/products/data-aggregation/bank-account-types.md

Get a single bank account type by its unique ID.

```APIDOC
## GET /account_types/{typeId}

### Description
Get a single bank account type by ID.

### Method
GET

### Endpoint
https://{domain}.biapi.pro/2.0/account_types/{typeId}

### Parameters
#### Path Parameters
- **typeId** (Integer) - Required - ID of the bank account type.

### Response
#### Success Response (200)
- **id** (Number) - ID of the account type.
- **name** (String) - Technical code of the account type.
- **id_parent** (Number/null) - Optional, the id of the parent type.
- **is_invest** (Boolean) - Whether the type corresponds to an 'investment' account type.
- **display_name** (String) - The display name of the account type, in French.
- **display_name_p** (String) - The plural display name of the account type, in French.
```

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

### GET /documentation/integration-guides/pay-by-bank/initiating-a-recurring-payment-with-the-webview.md

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank/initiating-a-recurring-payment-with-the-webview.md

Perform a query against the documentation to retrieve answers, excerpts, or context related to a specific question.

```APIDOC
## GET /documentation/integration-guides/pay-by-bank/initiating-a-recurring-payment-with-the-webview.md

### Description
Queries the documentation dynamically to receive an answer and relevant excerpts based on a provided question.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/pay-by-bank/initiating-a-recurring-payment-with-the-webview.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### Query documentation dynamically

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank/advanced/changing-the-maximum-amounts-for-payments.md

Perform a GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve context-aware information.

```http
GET https://docs.powens.com/documentation/integration-guides/pay-by-bank/advanced/changing-the-maximum-amounts-for-payments.md?ask=<question>&goal=<endgoal>
```

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

### GET /api-reference/api-setup/client-applications.md

Source: https://docs.powens.com/api-reference/llms.txt

Performs a natural language query against the documentation index to retrieve answers and relevant excerpts.

```APIDOC
## GET /api-reference/api-setup/client-applications.md

### Description
Perform an HTTP GET request on the documentation index with the `ask` parameter to retrieve a direct answer and relevant documentation excerpts.

### Method
GET

### Endpoint
https://docs.powens.com/api-reference/api-setup/client-applications.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

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

### GET /demo-integration/demonstration.md

Source: https://docs.powens.com/demo-integration/llms.txt

Performs a natural language query against the documentation index to retrieve an answer and relevant sources.

```APIDOC
## GET /demo-integration/demonstration.md

### Description
Perform an HTTP GET request on the documentation index to ask a specific question and optionally provide an end goal for context.

### Method
GET

### Endpoint
https://docs.powens.com/demo-integration/demonstration.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

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

### Configure certificate settings

Source: https://docs.powens.com/api-reference/products/data-aggregation/account-ownership-certificate.md

Example JSON configuration for a Spanish domain, setting the language, company name, and tax identification number.

```json
{
    "connection_certificate.language": "es",
    "root.client_name": "YOUR COMPANY SL",
    "root.cif": "B00000000"
}
```

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

### GET https://{domain}.biapi.pro/2.0/users/{userId}

Source: https://docs.powens.com/api-reference/user-connections/users.md

Get a single user by ID. Requires header authentication with a user token.

```APIDOC
## GET https://{domain}.biapi.pro/2.0/users/{userId}

### Description
Get a single user by ID.

### Method
GET

### Endpoint
https://{domain}.biapi.pro/2.0/users/{userId}

### Parameters
#### Path Parameters
- **userId** (Integer or "me") - Required - ID of the user.

### Response
#### Success Response (200)
- **id** (Integer) - ID of the user.
- **signin** (DateTime) - Sign-in date.
```

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

### Initialize CocoaPods

Source: https://docs.powens.com/documentation/sdk/powens-connect-ios.md

Command to initialize a new Podfile in the root of an Xcode project.

```typescript
pod init
```

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

### GET /documentation/sdk.md

Source: https://docs.powens.com/documentation/sdk

Queries the documentation dynamically by providing a question and an optional goal to receive a tailored answer.

```APIDOC
## GET /documentation/sdk.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/sdk.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

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

### Query documentation via HTTP GET

Source: https://docs.powens.com/api-reference/product/pay/payments

Use this request to ask a specific question to the documentation index. The ask parameter is required, while the goal parameter is optional for better context.

```http
GET https://docs.powens.com/api-reference/products/payments/payments.md?ask=<question>&goal=<end_goal>
```

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

### GET /documentation/integration-guides/pay-by-bank.md

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank.md

Queries the documentation dynamically by providing a specific question and an optional end goal.

```APIDOC
## GET /documentation/integration-guides/pay-by-bank.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/pay-by-bank.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate, specific, and self-contained question.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Relational Pagination Example

Source: https://docs.powens.com/api-reference/overview/api-design.md

Demonstrates a paginated request using query parameters and the corresponding response structure containing the _links object.

```http
GET /users/me/transactions?min_date=2022-12-01&income=false&limit=50
```

```json
{
  "transactions": [ ... ],
  "_links": {
    "prev": null,
    "self": {
      "href": "https://{domain}.biapi.pro/2.0/users/me/transactions?min_date=2022-12-01&income=false&limit=50"
    },
    "next": {
      "href": "https://{domain}.biapi.pro/2.0/users/me/transactions?min_date=2022-12-01&income=false&limit=50&cursor=W3sib3AiOiAibHQiLCAidmFsdWUiOiAiMjAyMC0wMy0wOCJ9LCB7Im9wIjogImd0IiwgInZhbHVlIjogOTgwNzg3fV0="
    }
  }
}
```

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

### GET https://payment-links.powens.com/api/payment-links

Source: https://docs.powens.com/api-reference/products/payments/payment-links.md

Retrieves a list of all payment links.

```APIDOC
## GET https://payment-links.powens.com/api/payment-links

### Description
Retrieves a list of all payment links.

### Method
GET

### Endpoint
https://payment-links.powens.com/api/payment-links

### Parameters
#### Headers
- **Authorization** (String) - Required - Bearer Authorization header.

### Response
#### Success Response (200)
- **paymentlink-object** (array) - A list of payment link objects.
```

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

### Initiate payment with a use case

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank/advanced/implementing-your-own-payment-validation-webview.md

Provide the chosen use case within the payment fields during initiation.

```http
POST /payments/{payment_id}
```

```json
{
    "connector_uuid": "338178e6-3d01-564f-9a7b-52ca442459bf",
    "validation_mechanism": "webauth",
    "fields": {
        "use_case_pay": "redirect"
    },
    "validated": true,
    "webview_url": "{{webview_url}}"
}
```

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

### GET /2.0/certificate/{type}

Source: https://docs.powens.com/api-reference/api-setup/configuration.md

Retrieves a specific certificate by its type.

```APIDOC
## GET /2.0/certificate/{type}

### Description
Get a certificate by type.

### Method
GET

### Endpoint
https://{domain}.biapi/pro.2.0/certificate/{type}

### Parameters
#### Path Parameters
- **type** (String) - Required - Type of the certificate.

### Response
#### Success Response (200)
- **body** (Certificate object) - The requested certificate.
```

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

### Identity Object Examples

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank/initiating-a-recurring-payment-with-the-webview.md

Required identity structures for payers and beneficiaries.

```json
{
  "kind": "individual",
  "external_ref": "MY-CUSTOMER-REFERENCE-012345678",
  "first_name": "Jean",
  "last_name": "Dupont",
  "nationality": "FR",
  "postal_address": "Appartement 25\nEntrée B Résidence Les Iris\n3 Boulevard du Levant\n95220 HERBLAY"
}
```

```json
{
  "kind": "corporate",
  "org_name": "Powens",
  "org_legal_status": "SAS",
  "org_hq_address": "84 RUE BEAUBOURG\n75003 PARIS 3\nFRANCE",
  "scheme_name": "siren",
  "identification": "749867206"
}
```

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

### Construct Webview URL

Source: https://docs.powens.com/documentation/integration-guides/quick-start/add-a-first-user-and-connection.md

Present this URL to the user to initiate the connection flow. Ensure the redirect_uri matches the white-list defined in the administration console.

```http
https://webview.powens.com/connect
  ?domain={domain}
  &client_id={clientId}
  &redirect_uri={yourCallbackUri}
  &code={temporaryCode}
```

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

### GET /payments/{paymentId}/incompatibilities

Source: https://docs.powens.com/api-reference/products/payments/payments.md

Lists incompatibilities for a payment connector.

```APIDOC
## GET /payments/{paymentId}/incompatibilities

### Description
Retrieves a list of payment connector incompatibilities for the specified payment.

### Method
GET

### Endpoint
https://{domain}.biapi.pro/2.0/payments/{paymentId}/incompatibilities

### Parameters
#### Path Parameters
- **paymentId** (string) - Required - The unique identifier of the payment.

#### Query Parameters
- **all** (Boolean) - Optional - Set to true to return incompatibilities for all connectors, including hidden ones.

### Response
#### Success Response (200)
- **paymentconnectorincompatibility-resource** (array) - List of payment connector incompatibilities.
```

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

### GET /users/me/amortizations

Source: https://docs.powens.com/documentation/integration-guides/wealth-and-loans.md

Retrieves the list of all loan amortizations for the authenticated user.

```APIDOC
## GET /users/me/amortizations

### Description
Retrieves the complete list of loan amortizations across all accounts for the authenticated user.

### Method
GET

### Endpoint
/users/me/amortizations
```

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

### GET /documentation/integration-guides/transactions/transactions-integration-guide.md

Source: https://docs.powens.com/documentation/integration-guides/transactions/transactions-integration-guide.md

Queries the documentation dynamically by providing a specific question and an optional end goal to receive a tailored response.

```APIDOC
## GET /documentation/integration-guides/transactions/transactions-integration-guide.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/transactions/transactions-integration-guide.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /users/me/marketorders

Source: https://docs.powens.com/documentation/integration-guides/wealth-and-loans.md

Retrieves the list of market orders for the authenticated user.

```APIDOC
## GET /users/me/marketorders

### Description
Retrieves the list of market orders for the authenticated user.

### Method
GET

### Endpoint
/users/me/marketorders
```

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

### POST /clients

Source: https://docs.powens.com/api-reference/api-setup/client-applications.md

Creates a new client application.

```APIDOC
## POST /clients

### Description
Creates a new client application.

### Method
POST

### Endpoint
https://{domain}.biapi.pro/2.0/clients

### Response
#### Success Response (201)
- **clientapp-object** (object) - The created client application object.
```

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

### GET /clients/{clientAppId}

Source: https://docs.powens.com/api-reference/api-setup/client-applications.md

Retrieves a single client application by its ID.

```APIDOC
## GET /clients/{clientAppId}

### Description
Get a single client application by ID.

### Method
GET

### Endpoint
https://{domain}.biapi.pro/2.0/clients/{clientAppId}

### Parameters
#### Path Parameters
- **clientAppId** (Integer) - Required - ID of the client application.

### Response
#### Success Response (200)
- **clientapp-object** (object) - The requested client application object.
```

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

### GET /documentation/integration-guides/wealth-and-loans.md

Source: https://docs.powens.com/documentation/integration-guides/wealth-and-loans.md

Queries the documentation dynamically to retrieve answers, excerpts, or sources related to a specific question and goal.

```APIDOC
## GET /documentation/integration-guides/wealth-and-loans.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, or sources related to a specific question and goal.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/wealth-and-loans.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

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

### GET /account_types

Source: https://docs.powens.com/api-reference/products/data-aggregation/bank-account-types.md

List all bank account types available in the API.

```APIDOC
## GET /account_types

### Description
List all bank account types available in the API.

### Method
GET

### Endpoint
https://{domain}.biapi.pro/2.0/account_types

### Response
#### Success Response (200)
- **accounttypes** (Array) - List of supported AccountType objects.
```

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

### Payment Validation Response

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank/advanced/implementing-your-own-payment-validation-webview.md

Example response when the payment requires an account selection.

```json
{
    "id": {{payment_id}},
    "state": "validating",
    "action": "additionalInformationNeeded",
    "fields": [
        {
            "name": "account_id",
            "type": "list",
            "label": "account choice bank message",
            "regex": null,
            "required": true,
            "default": null,
            "values": [
                {
                    "value": "main",
                    "label": "My checking account (EX6713038781895300290000074)"
                },
                {
                    "value": "snd",
                    "label": "My secondary checking account (EX5813038781895400400000074)"
                }
            ]
        }
    ],
    ...
}
```

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

### Query documentation dynamically

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank/advanced/confirming-payments-manually.md

Perform an HTTP GET request to query the documentation with a specific question.

```http
GET https://docs.powens.com/documentation/integration-guides/pay-by-bank/advanced/confirming-payments-manually.md?ask=<question>&goal=<endgoal>
```

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

### Create Payment Request

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank/validating-your-implementation-with-the-test-connector.md

Initiate a payment request with first_open_day execution type.

```http
POST /payments
```

```json
{
  "uuid": "338178e6-3d01-564f-9a7b-52ca442459bf",
  "use_case_pay": "legacy",
  "client_redirect_uri": "{redirectURL}",
  "client_state": "{optionalRedirectState}",
  "instructions": [
    {
      "label": "pdng/done - ABC001 ACME PURCHASE",
      "amount": 12.34,
      "currency": "EUR",
      "execution_date_type": "first_open_day",
      "beneficiary": {
        "scheme_name": "iban",
        "identification": "FR76XXXXXXXXXXXXXXX",
        "label": "ACME Corp.",
      },
      "beneficiary_identity": {
        "kind": "corporate",
        "org_name": "ACME Corp.",
        "org_legal_status": "SARL",
        "scheme_name": "siren",
        "identification": "012345678"
      },
    }
  ],
  "payer_identity": {
    "kind": "individual",
    "first_name": "Germaine",
    "last_name": "Michu",
    "birth_date": "1963-01-01",
    "birth_city": "Paris",
    "birth_country": "FR",
    "nationality": "French"
  },
  …
}
```

```json
{
  "id": {paymentId},
  "state": "created",
  "error_code": null,
  "error_description": null,
  …
}
```

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

### Recurring Payment Response Structure

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank/initiating-a-recurring-payment-with-the-webview.md

Example of the response received after creating a payment.

```json
{
  "id": {paymentId},
  "state": "created",
  "error_code": null,
  "error_description": null,
  …
}
```

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

### Launch Webview Flows

Source: https://docs.powens.com/documentation/sdk/powens-connect-ios.md

Asynchronously generate flow URLs and present the Webview controller for Connect, Manage, or Reconnect operations.

```swift
Task {
    do {
        // Building the Connect flow URL and generating a temporary auth code when provided with an access token
        let handle = try await Powens.shared.launcher.connectFlow(accessToken: token, state: nil, options: options)
        // Building the Manage flow URL and generating a temporary auth code
        let handle = try await Powens.shared.launcher.manageFlow(accessToken: token, connectionId: nil, state: nil, options: options)
        // Building the Reconnect flow URL and generating a temporary auth code
        let handle = try await Powens.shared.launcher.reconnectFlow(accessToken: token, connectionId: connectionId, resetCredentials: resetCredentials, state: nil)
                
        // Presenting the Webview controller from the current view controller
        handle.presentOn(sourceViewController: self)                
    } catch {
        NSLog(error.localizedDescription)
    }
}
```

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

### Subscription JSON Response Structure

Source: https://docs.powens.com/documentation/integration-guides/proof-and-certificates-retrieval.md

Example JSON response for a subscription object.

```json
{
  "subscriptions": [
    {
      "id": 12345,
      "label": "Contrat EZ4225",
      "number": "EZ42250022314",
      "subscriber": "Mr John Doe",
      …
    },
    …
  ]
}
```

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

### Webhook event payload

Source: https://docs.powens.com/api-reference/products/data-aggregation/account-ownership-certificate.md

Example of the JSON payload for the CONNECTION_CERTIFICATE_AVAILABLE webhook event.

```json
{  "id_connection": 123,  "method": "GET",  "url": "/users/456/connections/123/certificate"}
```

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

### GET /documentation/integration-guides/sca-and-connection-states.md

Source: https://docs.powens.com/documentation/integration-guides/sca-and-connection-states.md

Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a provided question.

```APIDOC
## GET /documentation/integration-guides/sca-and-connection-states.md

### Description
Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/sca-and-connection-states.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

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

### GET /documentation/integration-guides/advanced/custom-connection-implementation.md

Source: https://docs.powens.com/documentation/integration-guides/advanced/custom-connection-implementation.md

Queries the documentation for information related to the current page using natural language.

```APIDOC
## GET /documentation/integration-guides/advanced/custom-connection-implementation.md

### Description
Performs a dynamic query against the documentation to retrieve answers and relevant excerpts based on a specific question.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/advanced/custom-connection-implementation.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

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

### GET /payments

Source: https://docs.powens.com/api-reference/products/payments/payments.md

Retrieves a list of payments with various filtering and pagination options.

```APIDOC
## GET /payments

### Description
Retrieves a list of payments. Supports filtering by date, connector, state, and other payment attributes, as well as pagination.

### Method
GET

### Endpoint
/payments

### Parameters
#### Query Parameters
- **show_sensitive** (Boolean) - Optional - Set to true to return sensitive fields from identities. Defaults to false.
- **limit** (Integer) - Optional - Limit the number of results.
- **offset** (Integer) - Optional - First result offset.
- **reverse** (Boolean) - Optional - Reverse the results order (by date).
- **filter** (String) - Optional - Specify the date field to use when using min_date and max_date filters. Value can be register_date or validate_date.
- **min_date** (Date) - Optional - Minimal date (inclusive).
- **max_date** (Date) - Optional - Maximal date (exclusive).
- **connector_uuid** (String) - Optional - Filter by connector UUID. null can be used to filter payments without an associated connector.
- **id_connector** (Integer) - Optional - Filter by connector ID. null can be provided to filter payments without an associated connector.
- **id_connector_source** (Integer) - Optional - Filter by connector source ID.
- **state** (String) - Optional - Filter by state.
- **error_code** (String) - Optional - Filter by error_code.
- **bank_payment_id** (String) - Optional - Filter by bank payment ID.
- **website** (String) - Optional - Filter by website field value.
- **payer_identification** (String) - Optional - Filter by payer.identification.
- **beneficiary_identification** (String) - Optional - Filter by beneficiary.identification.
- **reference_id** (String) - Optional - Filter by instruction reference ID.
- **execution_date_type** (String) - Optional - Filter by execution_date.
- **order_by** (String) - Optional - Order the payments by the specified field. Value can be id, register_date, validate_date, state, connectors, amount, instruction_count, execution_date_type.
- **country** (String) - Optional - Filter by country. Several countries can be provided, separated by commas.

### Response
#### Success Response (200)
- **paymentlistresponse-object** (Object) - A list of payment objects.
```

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

### GET /2.0/payments

Source: https://docs.powens.com/api-reference/products/payments/payments.md

Retrieves a list of payments. By default, payments are ordered by register_date.

```APIDOC
## GET /2.0/payments

### Description
Retrieves a list of payments. By default, payments are ordered by register_date.

### Method
GET

### Endpoint
https://{domain}.biapi.pro/2.0/payments

### Authentication
Requires header authentication with a service token with the relevant `payments:*` scope.
```

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

### GET /users/me/investments

Source: https://docs.powens.com/documentation/integration-guides/wealth-and-loans.md

Retrieves investment resources associated with the user, accounts, or connections.

```APIDOC
## GET /users/me/investments

### Description
Retrieves a list of financial assets (investments) for the user. Variations exist to filter by account or connection.

### Method
GET

### Endpoint
/users/me/investments
/users/me/accounts/{accountId}/investments
/users/me/connections/{connectionId}/investments
```

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

### GET /terms

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank/advanced/implementing-your-own-payment-validation-webview.md

Retrieves the content of the terms of service to be displayed to the end user.

```APIDOC
## GET /terms

### Description
Retrieves the content of the terms of service to be displayed to the end user for acceptance.

### Method
GET

### Endpoint
/terms
```

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

### GET /webauth-url

Source: https://docs.powens.com/documentation/integration-guides/sca-and-connection-states.md

Obtains a URL for web-based authentication when a connection is in the webauthRequired state.

```APIDOC
## GET /webauth-url

### Description
Retrieves a recovery URL for connections requiring web-based authentication.

### Method
GET

### Endpoint
https://{domain}.biapi.pro/2.0/webauth-url

### Parameters
#### Query Parameters
- **client_id** (string) - Required - Your application client ID.
- **id_connection** (string) - Required - The unique identifier of the connection.
- **redirect_uri** (string) - Required - The URI to redirect to after authentication.
```

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

### GET /documentation/integration-guides/proof-and-certificates-retrieval.md

Source: https://docs.powens.com/documentation/integration-guides/proof-and-certificates-retrieval.md

Queries the documentation for information related to the current page by providing a question and an optional goal.

```APIDOC
## GET /documentation/integration-guides/proof-and-certificates-retrieval.md

### Description
Queries the documentation dynamically to retrieve answers and relevant excerpts based on a natural language question.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/proof-and-certificates-retrieval.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /users/{userId}/connections

Source: https://docs.powens.com/api-reference/user-connections/connections.md

Retrieves a list of connections for the specified user.

```APIDOC
## GET https://{domain}.biapi.pro/2.0/users/{userId}/connections

### Description
Retrieves a list of connections for the specified user.

### Method
GET

### Endpoint
https://{domain}.biapi.pro/2.0/users/{userId}/connections

### Parameters
#### Path Parameters
- **userId** (Integer or "me") - Required - ID of the related user.

### Response
#### Success Response (200)
- **list-connections** - A list of connections for the user.
```

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

### GET /documentation/integration-guides/pay-by-bank/advanced.md

Source: https://docs.powens.com/documentation/integration-guides/pay-by-bank/advanced.md

Perform a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /documentation/integration-guides/pay-by-bank/advanced.md

### Description
Queries the documentation dynamically to receive a direct answer, relevant excerpts, and sources based on the provided question.

### Method
GET

### Endpoint
https://docs.powens.com/documentation/integration-guides/pay-by-bank/advanced.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation agent.
- **goal** (string) - Optional - The broader end goal to help tailor the agent's response.
```

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

### GET /2.0/connectors/{connectorUuid}/sources

Source: https://docs.powens.com/api-reference/user-connections/connectors.md

List the available sources for a specific connector.

```APIDOC
## GET /2.0/connectors/{connectorUuid}/sources

### Description
Retrieve a list of connector sources for a given connector UUID.

### Method
GET

### Endpoint
https://{domain}.biapi.pro/2.0/connectors/{connectorUuid}/sources

### Parameters
#### Path Parameters
- **connectorUuid** (String) - Required - UUID of the related connector.

#### Query Parameters
- **country_codes** (String) - Optional - Filter on countries using comma-separated ISO 3166-1 alpha-2 codes.
```
Tokens:
Raw