Retrieve list of consents.

Request

Returns a list of consents that can be filtered with a number of optional parameters and ordered descending by status updated datetime value

Security

Bearer(Required scopes: api:consent)

Query

configurationNamestring

Optional filter to get consents only for a particular configuration name for the client.

consentStatusstring(DirectID.Consent.Service.Models.ConsentStatus)

Optional filter to get consents with a particular status.

Enum:"Pending""Active""Revoked""Abandoned""Failed""Expired"

providerIdinteger, (int32)

Optional filter to get consents only for a particular provider id.

customerReferencestring

Optional filter to get consents that match the customer reference exactly.

userIdstring

Optional filter to get consents associated with userId

dataSourceTypestring(DirectID.Consent.Service.Models.DataSourceType)

Optional filter to get consents of a particular type (OpenBanking vs. CreditInformation).

Enum:"OpenBanking""CreditInformation""UserSupplied"

fromstring, (date-time)

Optional filter to get consents which have been created/updated after the from date.

tostring, (date-time)

Optional filter to get consents which have been created/updated before the to date.

offsetinteger, (int32)

Number of consents to skip.

Default:0

limitinteger, (int32)

Maximum number of consents in the response.

Default:0

curl -i -X GET \
  'https://uk.api.atto.co/consents/v2?configurationName=string&consentStatus=Pending&providerId=0&customerReference=string&userId=string&dataSourceType=OpenBanking&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&offset=0&limit=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns the list of consents.

Bodyapplication/json

Array [

consentIdstring, (uuid)

Unique reference for the consent.

applicationIdstring, (uuid)

Application Id for the client.

userIdstring, (uuid)

Unique reference for the User the consent is associated with.

providerIdinteger or null, (int32)

Provider Id for the consent.

providerNamestring or null

Provider name for the consent.

configurationNamestring or null

Specific configuration of the client.

customerReferencestring or null

Reference for the consent provided by the client.

consentDurationTypestring(DirectID.Models.Consent.ConsentDurationType)

Type of the consent based on duration.

Enum:"Single""Limited""Infinite"

consentStatusstring(DirectID.Models.Consent.ConsentStatus)

Enum:"Pending""Active""Revoked""Abandoned""Failed""Expired"

consentStartstring or null, (date-time)

Start date for the consent.

consentEndstring or null, (date-time)

End date for the consent.

durationstring or null

Duration of consent in ISO8601 format.

daysOfHistoricalTransactionsinteger or null, (int32)

Number of days of transactions that can be requested from the bank.

statusUpdatedstring, (date-time)

Date of last status update of the consent.

statusDetailsstring or null

Details for the current status.

permissionsArray of strings or null

List of permissions for the consent.

invitationIdstring or null

Associated Invitation Id

journeyTypestring(DirectID.Models.Consent.ConsentJourneyType)

Used to indicate the type of journey that was performed If null it means the default(initial) journey was performed.

Enum:"Reauthentication""Reconfirmation"

dataSourceTypestring(DirectID.Models.Consent.ConsentDataSourceType)

Enum:"OpenBanking""CreditInformation""UserSupplied"

dataSourcestring(DirectID.Models.Consent.ConsentDataSource)

Enum:"Akoya""CIS""Finverse""OAuth""SaltEdge""Yapily""Yodlee""DocumentService"

]

Response

[
  {
    "consentId": "383460e3-8762-4b4d-5d63-08dea9a9a93c",
    "applicationId": "1e2eada7-fea2-4b6c-93f4-e8691e3be657",
    "userId": "b33420fd-987c-4703-fae5-08dea9a9a93d",
    "providerId": 15,
    "providerName": "Barclays",
    "configurationName": "default",
    "customerReference": "Ref123",
    "consentDurationType": "Limited",
    "consentStatus": "Active",
    "consentStart": "2026-05-05T14:08:45",
    "consentEnd": "2027-05-05T14:08:45",
    "duration": "P365D",
    "daysOfHistoricalTransactions": 365,
    "statusUpdated": "2026-05-05T14:08:45",
    "statusDetails": null,
    "permissions": [ … ],
    "invitationId": "e88e9ba5-1ec6-434e-5d62-08dea9a9a93c",
    "journeyType": "Reauthentication",
    "dataSourceType": "OpenBanking",
    "dataSource": "OAuth"
  },
  {
    "consentId": "59cf30f5-e97d-44b0-5d61-08dea9a9a93c",
    "applicationId": "1e2eada7-fea2-4b6c-93f4-e8691e3be657",
    "userId": "5f69ed81-7eca-4a05-fae4-08dea9a9a93d",
    "providerId": 20,
    "providerName": "Monzo",
    "configurationName": "default",
    "customerReference": "Ref123",
    "consentDurationType": "Single",
    "consentStatus": "Expired",
    "consentStart": "2026-05-05T14:08:45",
    "consentEnd": "2026-05-06T14:08:45",
    "duration": "P1D",
    "daysOfHistoricalTransactions": 365,
    "statusUpdated": "2026-05-05T14:08:45",
    "statusDetails": null,
    "permissions": [ … ],
    "invitationId": "e88e9ba5-1ec6-434e-5d62-08dea9a9a93c",
    "journeyType": null,
    "dataSourceType": "OpenBanking",
    "dataSource": "OAuth"
  }
]