Skip to main content

Consents

EnableNow offers the ability to retrieve information about a consent or a series of consents from a user or external user. We also have a new endpoint that allows our customer to get all consents based on these parameters but also on a starting date and on top of all of this you can still pick a specific page or change the number or returned records. This new operation is part of our Consent API (v2) and will be described below.

info

We recommend using the Consent API (v2).
You can still find information about the Consent API (v1) endpoint below in this page which will be deprecated in the short term.

API Reference: Get Paginated Consents
Using the access token requested in the authentication chapter, retrieve the consent details using endpoint below.

https://api.staging.enablenow.nl/cfa/v2/consents

You can call this endpoint without any of the following parameters. We always return the records sorted by dateRequested with most recent first. We will return page 1 (up to 50 records) of all consents found for your clientId. If you want some more control, use at most one of the first three request parameters combined with one or more of the last three parameters:

Parameter
Required
Description
ConsentId
No
The Consent ID (retrieved as parameter from the consent redirect URI).
UserId
No
The EnableNow generated UserId (more info: User-based access).
ExternalUserId
No
The External UserId (more info: User-based access).
FromDate
No
The start date to filter the results (e.g. 2025-10-01).
Page
No
The page number of the results to fetch (defaults to 1, e.g. 3, 10).
PageSize
No
The number of results per page (defaults to 50, max. 100).

A few examples...

Request all consents from Page 3...
https://api.staging.enablenow.nl/cfa/v2/consents?Page=3

Request all consents with ConsentId...
https://api.staging.enablenow.nl/cfa/v2/consents?ConsentId=a67a84b1-a4bf-4f89-1bd0-08ab4c5297b1

Request all consents from UserId...
https://api.staging.enablenow.nl/cfa/v2/consents?UserId=0239180d-6cd7-464f-68ac-08c5d9de0412

Request all consents from ExternalUserId starting at FromDate...
https://api.staging.enablenow.nl/cfa/v2/consents?ExternalUserId=ext:id:08ddc5d9decc&FromDate=2025-08-09

Request all consent starting at FromDate...
https://api.staging.enablenow.nl/cfa/v2/consents?FromDate=2025-10-01

The response is described below.

{
    "_pagination": {
        "page": 1,
        "size": 50,
        "totalCount": 175,
        "totalPages": 4
    },
    "data": [
        {
            "id": "9fbcdb2a-2b4b-46c5-e1aa-08de333be2d4",
            "status": "INITIALIZED",
            "providerKey": "ENSANDBOX",
            "dateStatusUpdated": "2025-12-04T13:49:43.0339766",
            "dateRequested": "2025-12-04T13:49:43.0339765",
            "dateExpire": null,
            "dateTransactionsUpdated": null,
            "errors": []
        },
        [...]
        {
            "id": "de907ce3-bd35-4984-7b5b-08de3291b237",
            "status": "UPDATED",
            "providerKey": "ENSANDBOX",
            "dateStatusUpdated": "2025-12-03T17:30:57.6424931",
            "dateRequested": "2025-12-03T17:30:47.4581424",
            "dateExpire": "2026-06-01T17:30:51.0316599",
            "dateTransactionsUpdated": "2025-12-03T17:30:57.6424932",
            "errors": []
        }
    ]
}

The _pagination model contains metadata information about the pagination state.

Property
Type
Availability
Description
page
integer
Required
The page number of the results.
size
integer
Required
The number of results per page.
totalCount
integer
Required
The total number of results.
totalPages
integer
Required
The total number of pages.

Inside the data collection, the consent object consists of the following properties:

Property
Type
Availability
Description
id
UUID
Required
The unique EnableNow ID for this consent.
status
string
Required
The current status of the consent (e.g., UPDATED).
dateStatus
Updated
datetime
Required
The DateTime when the status of the consent was last updated in UTC time.
dateRequested
datetime
Required
The DateTime when the consent was originally requested in UTC time.
dateExpire
datetime
Optional
The DateTime when the consent will expire in UTC time.
dateTransactions
Updated
datetime
Optional
The DateTime when transactions related to the consent were last updated in UTC time.
providerKey
string
Required
The key representing the provider associated with the consent (e.g., ABNANL2A).
errors
array
Optional
An array containing any errors related to the consent. Empty if no errors exist.

Inside the error array you can find error objects with the following properties:

Property
Type
Availability
Description
date
string
Required
DateTime of the error in UTC time.
type
string
Required
code
string
Required
message
string
Required
The provided error message.

API Reference: Get Consent By Id
Using the access token requested in the authentication chapter, retrieve the consent details using endpoint:

https://api.staging.enablenow.nl/cfa/v2/consents/a33a84b1-a4bf-1234-1bd0-08dd4c5007b1

You can call this endpoint if you are sure that you only need information about one consent without any kind of pagination.
There is only one parameter.

Parameter
Required
Description
ConsentId
Yes
The Consent ID (retrieved as parameter from the consent redirect URI).

The response is described below. There is a data collection as well but always with just one record. Please refer to the response model above for further details on each property. There is no _pagination model.

{
    "data": {
        "id": "a33a84b1-a4bf-1234-1bd0-08dd4c5007b1",
        "status": "UPDATED",
        "providerKey": "ENSANDBOX",
        "dateStatusUpdated": "2025-02-13T17:20:02.2107697",
        "dateRequested": "2025-02-13T17:19:37.0350968",
        "dateExpire": "2025-08-12T17:19:54.3984717",
        "dateTransactionsUpdated": "2025-02-13T17:20:02.2107697",
        "errors": []
    }
}

Before anything else remember that this endpoint and the Consent API (v1) in general will be deprecated in the short term. We recommend using the Consent API (v2). In any case, by using the access token requested in the authentication chapter, you retrieve the consent details using endpoint:

https://api.staging.enablenow.nl/cfa/consents

Use at most one of the following request parameters:

Parameter
Required
Description
ConsentId
No
The Consent ID (retrieved as parameter from the consent redirect URI).
UserId
No
The EnableNow generated UserId (more info: User-based access).
ExternalUserId
No
The External UserId (more info: User-based access).

The response is an array of objects of consent.

Response model​

[
    {
        "id": "392a6e3b-bd67-419e-98ea-a7f707ca8f4c",
        "status": "UPDATED",
        "dateStatusUpdated": "2023-08-18T13:14:58.7566045",
        "dateRequested": "2023-08-18T13:14:29.9290302",
        "dateExpire": "2023-11-16T13:14:56.4364593",
        "dateTransactionsUpdated": "2023-08-18T13:15:01.4291241",
        "providerKey": "ABNANL2A",
        "errors": []
    }
]

The consent object consists of the following properties:

Property
Type
Availability
Description
id
UUID
Required
The unique EnableNow ID for this consent.
status
string
Required
The current status of the consent (e.g., UPDATED).
dateStatus
Updated
datetime
Required
The DateTime when the status of the consent was last updated in UTC time.
dateRequested
datetime
Required
The DateTime when the consent was originally requested in UTC time.
dateExpire
datetime
Optional
The DateTime when the consent will expire in UTC time.
dateTransactions
Updated
datetime
Optional
The DateTime when transactions related to the consent were last updated in UTC time.
providerKey
string
Required
The key representing the provider associated with the consent (e.g., ABNANL2A).
errors
array
Optional
An array containing any errors related to the consent. Empty if no errors exist.

Inside the error array you can find error objects with the following properties:

Property
Type
Availability
Description
date
string
Required
DateTime of the error in UTC time.
type
string
Required
code
string
Required
message
string
Required
The provided error message.