v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Consentimento

Pedido de consentimento de dados

Cria novo pedido de consentimento

post/baas/v1/open/dat/consents

Request body

brandIdstring required

Example request

{
  "data": {
    "loggedUser": {
      "document": {
        "identification": "12345678909",
        "rel": "CPF"
      }
    },
    "permissions": [
      "ACCOUNTS_READ",
      "ACCOUNTS_OVERDRAFT_LIMITS_READ",
      "ACCOUNTS_BALANCES_READ",
      "ACCOUNTS_TRANSACTIONS_READ",
      "RESOURCES_READ"
    ],
    "expirationDateTime": "2026-01-31T23:59:59Z"
  },
  "brandId": "3a40d894-f3c2-47e3-97c2-d9a04cdac63c"
}

Response

Consentimento criado com sucesso

authorizationUrlstring uri

URL de autorização para redirecionamento do usuário detentor dos dados. A URL deve ser aberta em um navegador web para que o usuário possa autenticar-se e conceder o consentimento.

[Observação] A URL de autorização é dinâmica e única para cada pedido de consentimento. Deve ser utilizada apenas uma vez e tem validade limitada (geralmente 5 minutos). Após esse período, um novo pedido de consentimento deve ser criado para obter uma nova URL.

idstring

ID único do pedido de consentimento criado

Example response

{
  "authorizationUrl": "https://api-openfinance.opb.bricks.demo.fsapps.io/orgs/bricks/auth?client_id=hash-client&request_uri=hash-request-uri",
  "id": "rQJLYX7GGP0s2VIvLL1oJhEUWjEF-QzOCnCwsTzH2xQ"
}