Open Finance Brasil

https://openfinancebrasil.atlassian.net/wiki/spaces/OF/
Admin
Open Finance Brasil is a comprehensive documentation and API specification framework that...
Tokens:3,229,774
Snippets:28,459
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Calculate Final IQA with Consistency Factor for credit-cards-accounts Example

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/498500234/ndice%2Bde%2BQualidade%2Bdos%2BDados%2BIQD

Example of applying the Consistency Factor to the initial IQA for 'credit-cards-accounts' to get the final IQA.

```plaintext
IQA = 17 * 0,8 = 13,6%
```

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

### GET /responses/200/data/items/interest/instalmentRates/items/applications/items/interval

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/223772786

Retrieves the interval for instalment interest rate applications. Includes an example.

```APIDOC
## GET /responses/200/data/items/interest/instalmentRates/items/applications/items/interval

### Description
Retrieves the interval for instalment interest rate applications. Includes an example.

### Method
GET

### Endpoint
/responses/200/data/items/interest/instalmentRates/items/applications/items/interval

### Parameters
#### Query Parameters
- **x-regulatory-required** (string) - Optional - Indicates a regulatory requirement.
- **example** (string) - Optional - Provides an example value.

### Response
#### Success Response (200)
- **interval** (object) - Description of the interval object.
```

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

### Calculate Initial IQA Example

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/498500234/ndice%2Bde%2BQualidade%2Bdos%2BDados%2BIQD

Example calculation for the initial IQA using the provided IR, IC, IA, and their respective weights.

```plaintext
IQA = ((IR x Peso IR) + (IC x Peso IC)) x IA
IQA = ((33% x 0.25) + (98% x 0.75)) x 62 = 51%
```

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

### Get Scheduled Installments

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/history/1276740785

Retrieves the scheduled installments for a loan contract, used to obtain 'dueInstalments'.

```HTTP
GET /loans/contracts/{contractId}/scheduled-installments
```

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

### Listar Imagens Docker

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/history/362578967

Verifique se a imagem Docker do MQD foi criada corretamente após o processo de build.

```bash
docker image ls
```

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

### Get Scheduled Instalments for Contract

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/193757792/Informa%2Bes%2BT%2Bcnicas%2B-%2BAdiantamento%2Ba%2BDepositantes%2B-%2Bv2.1.0-rc.2

Retrieves the scheduled instalment data for a specific depositor advance contract.

```APIDOC
## GET /contracts/{contractId}/scheduled-instalments

### Description
Obtém os dados do cronograma de parcelas do contrato de adiantamento a depositantes identificado por contractId

### Method
GET

### Endpoint
/contracts/{contractId}/scheduled-instalments

#### Path Parameters
- **contractId** (string) - Required - The unique identifier of the contract.
```

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

### Compilar Imagem Docker do MQD

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/history/362578967

Compile o código e crie a imagem Docker para o container do Motor de Qualidade de Dados. O flag --no-cache garante uma build limpa.

```bash
docker build --no-cache -f infra/dockerfile/docker-minimal -t mqd-client .
```

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

### Compilar Imagem Docker do MQD

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/362578967/Manual%2Bde%2BInstala%2Bo%2B-%2BMQD

Compile e crie a imagem Docker para o container do Motor de Qualidade de Dados, utilizando um Dockerfile específico e sem cache.

```bash
docker build --no-cache -f infra/dockerfile/dockerfile-minimal -t mqd-client .
```

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

### Loans API - Get Contract Scheduled Installments

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/17373341/Informa%2Bes%2BT%2Bcnicas%2B-%2BEmpr%2Bstimos%2B-%2Bv2.0.0

Retrieves the scheduled installment details for the loan contract identified by contractId.

```APIDOC
## GET /contracts/{contractId}/scheduled-instalments

### Description
Retrieves the scheduled installment details for the loan contract identified by contractId.

### Method
GET

### Endpoint
/contracts/{contractId}/scheduled-instalments

### Parameters
#### Path Parameters
- **contractId** (string) - Required - The unique identifier of the loan contract.
#### Query Parameters
- **Authorization** (string) - Required - Bearer token for consent.

### Permissions
- **LOANS_SCHEDULED_INSTALMENTS_READ**

### Response
#### Success Response (200)
- **scheduledInstallments** (array) - List of scheduled installments for the contract.
  - **installmentNumber** (integer) - The number of the installment.
  - **date** (string) - The due date of the installment.
  - **amount** (object) - The amount of the installment.
    - **amount** (number) - The amount of the installment.
    - **currency** (string) - The currency of the installment amount.
  - **balance** (object) - The remaining balance after this installment.
    - **amount** (number) - The remaining amount.
    - **currency** (string) - The currency of the remaining balance.

#### Response Example
{
  "data": {
    "scheduledInstallments": [
      {
        "installmentNumber": 1,
        "date": "2023-11-01",
        "amount": {
          "amount": 500.00,
          "currency": "BRL"
        },
        "balance": {
          "amount": 9500.00,
          "currency": "BRL"
        }
      },
      {
        "installmentNumber": 2,
        "date": "2023-12-01",
        "amount": {
          "amount": 500.00,
          "currency": "BRL"
        },
        "balance": {
          "amount": 9000.00,
          "currency": "BRL"
        }
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://api.banco.com.br/open-banking/loans/v2/contracts/exampleContractId/scheduled-instalments"
    }
  ]
}
```

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

### GET /responses/200/data/items/society/products/items/coverages/items/typeAdditionalInfos/items

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/372867156

Details on the alteration of the 'typeAdditionalInfos/items' example.

```APIDOC
## GET /responses/200/data/items/society/products/items/coverages/items/typeAdditionalInfos/items

### Description
This endpoint details an alteration to the example for 'typeAdditionalInfos/items', changing it to 'Informações Adicionais'.

### Method
GET

### Endpoint
/responses/200/data/items/society/products/items/coverages/items/typeAdditionalInfos/items

### Parameters
#### Query Parameters
- **fields** (string) - Optional - Specifies the fields to retrieve.

### Response
#### Success Response (200)
- **example** (string) - The example value for additional information.

#### Response Example
{
  "example": "[Informações Adicionais]"
}
```

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

### GET /responses/200/data/items/interest/instalmentRates/items/rate

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/223772786

Retrieves the interest rate for instalments.

```APIDOC
## GET /responses/200/data/items/interest/instalmentRates/items/rate

### Description
Retrieves the interest rate for instalments.

### Method
GET

### Endpoint
/responses/200/data/items/interest/instalmentRates/items/rate

### Parameters
#### Query Parameters
- **x-regulatory-required** (string) - Optional - Indicates a regulatory requirement.

### Response
#### Success Response (200)
- **rate** (object) - Description of the instalment rate.
```

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

### Calculate Initial IQA for credit-cards-accounts Example

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/498500234/ndice%2Bde%2BQualidade%2Bdos%2BDados%2BIQD

Example calculation for the initial IQA for the 'credit-cards-accounts' API family, using its IR, IC, IA, and weights.

```plaintext
IQA = ((IR x Peso IR) + (IC x Peso IC)) x IA
IQA = ((0% x 0.25) + (92% x 0.75)) x 24 = 17%
```

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

### GET /parameters/x-fapi-interaction-id

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/480576050/Changelog%2B-%2BDC%2BDados%2BCadastrais%2B-%2Bv2.1.0-rc.1%2B-%2Bv2.0.1

Details on the 'x-fapi-interaction-id' parameter for GET requests, including its description, required status, pattern, maxLength, format, and example.

```APIDOC
## GET /parameters/x-fapi-interaction-id

### Description
This section details the 'x-fapi-interaction-id' parameter used in GET requests. It has undergone several changes, including updates to its description, required status, pattern, maximum length, and format.

### Method
GET

### Endpoint
/parameters/x-fapi-interaction-id

### Parameters
#### Query Parameters
- **x-fapi-interaction-id** (string) - Required - A UUID [RFC4122] used as a correlation ID between request and response. It must be generated and sent by the client and mirrored by the server in the response header. If not received or if an invalid value is received, the server must generate an x-fapi-interaction-id and return it with an HTTP Status Code 400. The client must accept the value received from the server.

### Request Example
```json
{
  "example": "d78fc4e5-37ca-4da3-adf2-9b082bf92280"
}
```

### Response
#### Success Response (200)
- **x-fapi-interaction-id** (string) - A UUID [RFC4122] used as a correlation ID between request and response. The client must generate and send this value, and the server must mirror it in the response header. If not received or if an invalid value is received, the server must generate an x-fapi-interaction-id and return it with an HTTP Status Code 400. The client must accept the received value from the server.

#### Response Example
```json
{
  "example": "d78fc4e5-37ca-4da3-adf2-9b082bf92280"
}
```
```

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

### Start Data Quality Engine with Docker Compose

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/history/362578967

Use this command to initiate the Data Quality Engine application. Ensure you are in the correct directory containing the docker-compose.yaml file.

```bash
docker compose -f infra/dockerfile/docker-compose.yaml up
```

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

### GET /personal/financial-relations - x-fapi-interaction-id Header

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/400752831

Details the 'x-fapi-interaction-id' header for the GET /personal/financial-relations endpoint, including its purpose, requirements, pattern, and examples.

```APIDOC
## GET /personal/financial-relations

### Description
This endpoint retrieves personal financial relations. The `x-fapi-interaction-id` header is used for correlation.

### Method
GET

### Endpoint
/personal/financial-relations

### Parameters
#### Query Parameters
- **x-fapi-interaction-id** (string) - Required - A UUID [RFC4122] used as a correlation ID between request and response. This field is generated and...

### Request Example
```json
{
  "x-fapi-interaction-id": "d78fc4e5-37ca-4da3-adf2-9b082bf92280"
}
```

### Response
#### Success Response (200)
- **x-fapi-interaction-id** (string) - A UUID [RFC4122] used as a correlation ID between request and response. This field is generated and...

#### Response Example
```json
{
  "x-fapi-interaction-id": "d78fc4e5-37ca-4da3-adf2-9b082bf92280"
}
```
```

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

### Listar Arquivos Locais

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/history/362578967

Após clonar o repositório, use este comando para validar se o clone foi realizado corretamente em sua pasta local.

```bash
ls -la
```

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

### Calculate Final IQA with Consistency Factor Example

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/498500234/ndice%2Bde%2BQualidade%2Bdos%2BDados%2BIQD

Example of applying the Consistency Factor to the initial IQA to derive the final IQA.

```plaintext
IQA = 51 * 0,9 = 45,9%
```

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

### GET /parameters/x-fapi-interaction-id

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/264176327/Changelog%2B-%2BPagamentos%2BAutom%2Bticos%2B-%2Bv1.0.0-rc.1

Details regarding the 'x-fapi-interaction-id' parameter for GET requests, including its description, example, format, length constraints, and pattern.

```APIDOC
## GET /parameters/x-fapi-interaction-id

### Description
This section details the `x-fapi-interaction-id` header parameter used in GET requests. It specifies the description, an example value, the expected format, maximum length, and any applicable pattern.

### Method
GET

### Endpoint
/parameters/x-fapi-interaction-id

### Parameters
#### Query Parameters
- **x-fapi-interaction-id** (string) - Required - Unique identifier for the interaction.

### Response
#### Success Response (200)
- **x-fapi-interaction-id** (string) - Description of the interaction ID header.

#### Error Responses
- **400 Bad Request**: Details for `x-fapi-interaction-id` header.
- **401 Unauthorized**: Details for `x-fapi-interaction-id` header.
- **403 Forbidden**: Details for `x-fapi-interaction-id` header.
- **404 Not Found**: Details for `x-fapi-interaction-id` header.
- **405 Method Not Allowed**: Details for `x-fapi-interaction-id` header.
- **406 Not Acceptable**: Details for `x-fapi-interaction-id` header.
- **500 Internal Server Error**: Details for `x-fapi-interaction-id` header.
- **504 Gateway Timeout**: Details for `x-fapi-interaction-id` header.

### Response Example (200 OK)
{
  "x-fapi-interaction-id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

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

### Loans API - Get Scheduled Installments by Contract ID

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/17372918/1.0.2.yml

Retrieves the scheduled installment details for the loan contract identified by `contractId`.

```APIDOC
## GET /contracts/{contractId}/scheduled-instalments

### Description
Retrieves the scheduled installment details for the loan contract identified by `contractId`.

### Method
GET

### Endpoint
/contracts/{contractId}/scheduled-instalments

### Parameters
#### Path Parameters
- **contractId** (string) - Required - The unique identifier of the loan contract.

#### Query Parameters
- **consentId** (string) - Required - The unique identifier for the customer's consent.

### Request Body
None

### Response
#### Success Response (200)
- **scheduledInstallments** (array) - A list of scheduled installments.
  - **instalmentNumber** (integer) - The number of the installment.
  - **dueDate** (string) - The due date of the installment (YYYY-MM-DD).
  - **status** (string) - The status of the installment (e.g., "PENDING", "PAID", "OVERDUE").
  - **originalAmount** (object) - The original amount of the installment.
    - **amount** (number) - The monetary amount.
    - **currency** (string) - The currency of the amount (ISO 4217).
  - **paidAmount** (object) - The amount paid for the installment.
    - **amount** (number) - The monetary amount.
    - **currency** (string) - The currency of the amount (ISO 4217).
  - **remainingAmount** (object) - The remaining amount for the installment.
    - **amount** (number) - The monetary amount.
    - **currency** (string) - The currency of the amount (ISO 4217).
  - **interestAmount** (object) - The interest amount for the installment.
    - **amount** (number) - The monetary amount.
    - **currency** (string) - The currency of the amount (ISO 4217).
  - **principalAmount** (object) - The principal amount for the installment.
    - **amount** (number) - The monetary amount.
    - **currency** (string) - The currency of the amount (ISO 4217).

#### Response Example
{
  "scheduledInstallments": [
    {
      "instalmentNumber": 1,
      "dueDate": "2023-02-15",
      "status": "PENDING",
      "originalAmount": {
        "amount": 500.00,
        "currency": "BRL"
      },
      "paidAmount": {
        "amount": 0.00,
        "currency": "BRL"
      },
      "remainingAmount": {
        "amount": 500.00,
        "currency": "BRL"
      },
      "interestAmount": {
        "amount": 50.00,
        "currency": "BRL"
      },
      "principalAmount": {
        "amount": 450.00,
        "currency": "BRL"
      }
    }
  ]
}

### Permissions
- **LOANS_SCHEDULED_INSTALMENTS_READ**
```

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

### Signature Certificate Configuration Example

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/245694518

This example demonstrates the configuration for a signature certificate. It specifies attributes relevant for digital signatures.

```openssl
openssl req -new -newkey rsa:2048 -sha256 -nodes -keyout signing.key -out signing.csr -subj "/C=BR/ST=Sao Paulo/L=Sao Paulo/O=Open Finance Brasil/OU=AC OAB/CN=signing.example.com" -addext "subjectAltName=DNS:signing.example.com" -addext "nsCertType=client,email" -addext "keyUsage=digitalSignature" -addext "extendedKeyUsage=timestamping,codeSigning" -addext "basicConstraints=CA:FALSE"
```

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

### Payments Initiation API Webhook URL Examples

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/1217691731/Versionamento%2B-%2BWebhook%2B-%2Bv1.3.0-rc.2

Provides specific examples of webhook URLs for the Payments Initiation API, demonstrating how to include consent and payment IDs.

```plaintext
/open-banking/webhook/[Versão do Webhook]/payments/[Versão_da_API]/consents/{consentId}
```

```plaintext
/open-banking/webhook/[Versão do Webhook]/payments/[Versão_da_API]/pix/payments/{paymentId}
```

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

### GET /responses/200/data/items/society/products/items/coverages/items/attributes/allowApartPurchase

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/history/372867156

Addition of an example value for the 'allowApartPurchase' attribute.

```APIDOC
## GET /responses/200/data/items/society/products/items/coverages/items/attributes/allowApartPurchase

### Description
This endpoint provides information on whether a coverage attribute can be purchased separately. An example value has been added.

### Method
GET

### Endpoint
/responses/200/data/items/society/products/items/coverages/items/attributes/allowApartPurchase

### Response
#### Success Response (200)
- **allowApartPurchase** (boolean) - Indicates if the coverage can be purchased separately. Example: true.
```

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

### GET /responses/200/data/items/interest/instalmentRates/items/maximumRate

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/223772786

Retrieves the maximum interest rate for instalments.

```APIDOC
## GET /responses/200/data/items/interest/instalmentRates/items/maximumRate

### Description
Retrieves the maximum interest rate for instalments.

### Method
GET

### Endpoint
/responses/200/data/items/interest/instalmentRates/items/maximumRate

### Parameters
#### Query Parameters
- **x-regulatory-required** (string) - Optional - Indicates a regulatory requirement.

### Response
#### Success Response (200)
- **maximumRate** (object) - Description of the maximum rate.
```

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

### POST /enrollments

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/511803642/Changelog%2B-%2BSV%2BV%2Bnculo%2Bde%2Bdispositivo%2B-%2B2.0.0-beta.1%2B-%2Bv1.3.1

Initiates the enrollment process for a device.

```APIDOC
## POST /enrollments

### Description
Initiates the enrollment process for a device.

### Method
POST

### Endpoint
/enrollments

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

#### Response Example
```json
{
  "enrollmentId": "some-unique-enrollment-id"
}
```
```

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

### GET /responses/200/data/items/interest/instalmentRates/items/minimumRate

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/223772786

Retrieves the minimum interest rate for instalments.

```APIDOC
## GET /responses/200/data/items/interest/instalmentRates/items/minimumRate

### Description
Retrieves the minimum interest rate for instalments.

### Method
GET

### Endpoint
/responses/200/data/items/interest/instalmentRates/items/minimumRate

### Parameters
#### Query Parameters
- **x-regulatory-required** (string) - Optional - Indicates a regulatory requirement.

### Response
#### Success Response (200)
- **minimumRate** (object) - Description of the minimum rate.
```

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

### FVP Configuration JSON Example

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/958693401/Execu%2Bo%2Bdo%2BPlano%2Bde%2Btestes%2Bde%2BPix%2BAutom%2Btico%2Bna%2BFVP

This JSON object defines the structure for FVP test plan configurations. It includes settings for server discovery, resource details, and directory services.

```json
{
"alias": "74e929d9-33b6-4d85-8ba7-c146c867a817",
"description": "mock",
"server": {
"discoveryUrl": "https://auth.mockbank.poc.raidiam.io/.well-known/openid-configuration",
"authorisationServerId": "xxxxx-xxxx-xxxx-xxxx-xxxxx"
},
"resource": {
"brazilOrganizationId": "xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "John Doe",
"brazilCpf": "00000000000",
"loggedUserIdentification": "00000000000",
"paymentAmount": "0.00",
"creditorAccountIspb": "00000000",
"creditorAccountIssuer": "0000",
"creditorAccountNumber": "0000000000",
"creditorAccountAccountType": "CACC",
"creditorName": "John Doe",
"creditorCpfCnpj": "00000000000",
"creditorProxy": "00000000000",
"debtorAccountIspb": "00000000",
"debtorAccountNumber": "0000000",
"debtorAccountIssuer": "0000",
"debtorAccountType": "TRAN"
"contractDebtorName": "Example",
"contractDebtorIdentification": "00000000000"
},
"directory": {
"participants": "https://data.example.directory/participants",
"keystore": "https://keystore.example.directory/",
"apibase": "https://api.example.directory/",
"directoryRootsUri": "https://data.example.directory/roots_directory.jwks",
"discoveryUrl": "https://auth.example.directory/.well-known/openid-configuration"
}
}
```

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

### Invoice Financings API - Get Scheduled Installments by Contract ID

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/17375694/Informa%2Bes%2BT%2Bcnicas%2B-%2BDireitos%2BCredit%2Brios%2BDescontados%2B-%2Bv1.0.4

Retrieves the scheduled installment data for a specific invoice financing contract.

```APIDOC
## GET /contracts/{contractId}/scheduled-instalments

### Description
Obtém os dados do cronograma de parcelas do contrato de antecipação de recebíveis identificado por contractId.

### Method
GET

### Endpoint
/contracts/{contractId}/scheduled-instalments

### Parameters
#### Path Parameters
- **contractId** (string) - Required - The unique identifier of the contract.

#### Query Parameters
- **Authorization** (string) - Required - Token for consent verification.

### Permissions
- **INVOICE_FINANCINGS_SCHEDULED_INSTALMENTS_READ**

### Response
#### Success Response (200)
- **scheduledInstallments** (array) - List of scheduled installment objects.
  - **instalmentNumber** (integer) - The number of the installment.
  - **dueDate** (string) - The due date for the installment.
  - **dueAmount** (object) - The amount due for the installment.
    - **amount** (number) - The monetary value.
    - **currency** (string) - The currency of the amount (e.g., BRL).
  - **paidAmount** (object) - The amount already paid for the installment.
    - **amount** (number) - The monetary value.
    - **currency** (string) - The currency of the amount (e.g., BRL).
  - **remainingAmount** (object) - The remaining amount for the installment.
    - **amount** (number) - The monetary value.
    - **currency** (string) - The currency of the amount (e.g., BRL).

### Response Example
{
  "scheduledInstallments": [
    {
      "instalmentNumber": 1,
      "dueDate": "2024-01-15",
      "dueAmount": {
        "amount": 1000.00,
        "currency": "BRL"
      },
      "paidAmount": {
        "amount": 500.00,
        "currency": "BRL"
      },
      "remainingAmount": {
        "amount": 500.00,
        "currency": "BRL"
      }
    }
  ]
}
```

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

### Example Response with Meta Object

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/17377470/Pagina%2Bo

An example of an API response including the 'data', 'links', and 'meta' objects.

```APIDOC
## Example Response

```json
{
  "data": {
    "...": "..."
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/channels/v1/branches?page=10&page-size=25",
    "first": "https://api.banco.com.br/open-banking/channels/v1/branches?page=1&page-size=25",
    "prev": "https://api.banco.com.br/open-banking/channels/v1/branches?page=9&page-size=25"
  },
  "meta": {
    "totalRecords": 250,
    "totalPages": 10
  }
}
```
```

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

### POST /enrollments

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/591103022/Changelog%2B-%2BSV%2BV%2Bnculo%2Bde%2Bdispositivo%2B-%2Bv2.0.0-rc.1%2B-%2Bv1.3.1

Creates a new device enrollment.

```APIDOC
## POST /enrollments

### Description
Creates a new device enrollment.

### Method
POST

### Endpoint
/enrollments

### Parameters
#### Request Body
- **enrollmentName** (string) - Required - The name of the enrollment.

### Request Example
{
  "enrollmentName": "My Device"
}

### Response
#### Success Response (200)
- **enrollmentId** (string) - The ID of the newly created enrollment.

#### Response Example
{
  "enrollmentId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

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

### Configuração do Docker Compose para MQD

Source: https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/362578967

Configure as variáveis de ambiente no arquivo docker-compose.yaml para o serviço mqd-client e proxy. Modifique os valores conforme a necessidade do seu ambiente.

```yaml
version: '3' services:
  mqd-client:
    image: mqd-client:latest
    ports:
      - "8080:8080"
    environment:
      - API_PORT=:8080
      - SERVER_ORG_ID=09b20d09-bf30-4497-938e-b0ead8ce9629
      #- REPORT_EXECUTION_WINDOW=30
       #- REPORT_EXECUTION_NUMBER= 200000
      - ENVIRONMENT=DEV
      - LOGGING_LEVEL=WARNING
      - APPLICATION_MODE=TRANSMITTER
      - PROXY_URL=http://127.0.0.1:8082
    network_mode: "host"
    depends_on:
      - proxy
    restart: always
    deploy:
      resources:
        limits:
          cpus: '1'
          memory: 1024M
        reservations:
          cpus: '0.25'
          memory: 128M
  proxy:
    image: nginx
    ports:
      - "8082:80"
    volumes:
     - ./proxy/default.sandbox.conf:/etc/nginx/conf.d/default.conf:ro
      - ./certificates:/etc/ssl  
```
Tokens:
Raw