This is a preview version of the API intended for early testing and integration. Preview versions are not stable and may include breaking changes before general availability.

Create consent

POSThttps://api.insurely.com/consents

Create a new PSD2_AIS (Account Information Service) consent for the authenticated external user.

Request

Header Parameters

Insurely-Versionstring

Specifies the API version to use. Must match the version of the endpoint you are targeting.

Possible Enum values are 2026-04-01.

Request Body

companystring

Company identifier.

loginMethodstring

The login method to use for authentication. Required when SWEDISH_BANKID parameter is provided.

parametersArray<object>

Consent creation parameters.

One of these types:

Properties below are from the Psd2AisConsentParameter subtype. View the full schema for full details.

Structured PSD2 consent definition for Account Information Service scopes.

accountIdsArray<string>

Explicit account identifiers granted for PSD2_AIS (Account Information Service) access. If accountIds are not set, the consent will apply to all PSU accounts available at the ASPSP.

balancesboolean

Whether balances can be read.

psuIpAddressstring

PSU (Payment Service User) IP address (IPv4 or IPv6 format)

psuLocalestring

Locale string (format: xx-yy, e.g., 'sv-SE', 'en-GB', 'no-NO'), recommended for proper localization of consent flows and user communications.

transactionsboolean

Whether transactions can be fetched.

validUntilstring[date]

Requested expiration date for the consent (format: YYYY-MM-DD). The ASPSP may enforce a shorter expiration period than requested.

Responses

Consent successfully created.

Body

companystring

Company identifier.

consentIdstring

Unique identifier for the consent.

expiresAtstring[date-time]

Expiration timestamp for the consent.

scope

Requested consent scopes.

One of these types:

Properties below are from the Psd2AisConsentScope subtype. View the full schema for full details.

PSD2 AIS consent scope with account access details

accountIdsArray<string>

Bank account identifiers this consent grants access to. When absent, the consent covers all accounts available at the bank.

balancesboolean

Whether this consent grants permission to read account balances.

transactionsboolean

Whether this consent grants permission to fetch account transactions.

typestring

Scope type discriminator.

Possible Enum values are PSD2_AIS.

statusstring

Current status of the consent.

Possible Enum values are INITIATED, AWAITING_AUTHORIZATION, AUTHORIZED, REVOKED, EXPIRED or FAILED.

cURL

curl https://api.insurely.com/consents \
  -H "Authorization: Bearer <jwt-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "company": "se-nordea",
  "parameters": [
    {
      "accountIds": [
        "SE1234567890"
      ],
      "balances": true,
      "psuIpAddress": "192.168.1.1",
      "psuLocale": "sv-SE",
      "transactions": true,
      "type": "PSD2_AIS_CONSENT",
      "validUntil": "2026-12-31"
    }
  ]
}' \
  -X POST

RESPONSE 201

{
  "company": "se-nordea",
  "consentId": "550e8400-e29b-41d4-a716-446655440000",
  "expiresAt": "2026-12-31T23:59:59Z",
  "scope": {
    "accountIds": [
      "SE1234567890"
    ],
    "balances": true,
    "transactions": true,
    "type": "PSD2_AIS"
  },
  "status": "INITIATED"
}