Skip to main content
API docs by Redocly

Consents API (v1)

Download OpenAPI specification:Download

URL: https://api.enablenow.nl

Consent

Create a consent using direct providers flow

This creates a consent and will return the consent ID and provider consent URL. This endpoint is only authorized and used for customers that use the direct provider flow.

Authorizations:
bearer
Request Body schema: application/json
required

The create consent parameters

providerKey
string

The selected provider key

countryCode
string

The two letter ISO country code (defaults to 'NL')

userId
string or null

The User ID for which to retrieve transactions

userIdGuid
string <guid>
externalUserId
string or null

The External User ID for which to retrieve transactions

redirectUrl
string

The redirect URL to redirect the user to after consent is given

syncMode
string or null

SyncMode of this consent

Responses

Request samples

Content type
application/json
{
  • "providerKey": "string",
  • "countryCode": "string",
  • "userId": "string",
  • "userIdGuid": "string",
  • "externalUserId": "string",
  • "redirectUrl": "string",
  • "syncMode": "string"
}

Response samples

Content type
application/json
{
  • "consentId": "string",
  • "consentUrl": "string"
}

Retrieve consents

Authorizations:
bearer
query Parameters
ConsentId
string or null <guid>

The consent ID for which to retrieve consents

UserId
string or null <guid>

The User ID for which to retrieve consents

ExternalUserId
string or null

The External User ID for which to retrieve consents

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete consent

This will completely remove and delete the consent's accounts, transactions and all associated data on our platform. Deleting a consent is a permanent and irreversible action, mainly used for GDPR and compliance purposes.

Authorizations:
bearer
path Parameters
id
required
string <guid>

Id of the consent to delete

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "traceId": "string",
  • "detail": "string",
  • "errors": {
    }
}

Retrieve a consent by ID

Authorizations:
bearer
path Parameters
Id
required
string <guid>

The Consent ID for which to get information about

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "dateStatusUpdated": "2019-08-24T14:15:22Z",
  • "dateRequested": "2019-08-24T14:15:22Z",
  • "dateExpire": "2019-08-24T14:15:22Z",
  • "dateTransactionsUpdated": "2019-08-24T14:15:22Z",
  • "providerKey": "string",
  • "errors": [
    ]
}

Refresh a consent

This will request a consent refresh which will also refresh the associated accounts and transactions. This is an asynchronous call and the transactions will be refreshed in the background. A webhook can be used to be notified when it is completed (Transactions Fetched). This operation has a daily limit of 6 requests per consent. We also keep an history of requests for 7 days.

Authorizations:
bearer
path Parameters
id
required
string <guid>

The id of the consent to refresh

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "traceId": "string",
  • "detail": "string",
  • "errors": {
    }
}