Skip to main content
GET
/
v1
/
ais
/
users
/
{userId}
/
consents
Get User Consents
curl --request GET \
  --url https://acount-apis-staging-a8cdb2402163.herokuapp.com/v1/ais/users/{userId}/consents \
  --header 'Authorization: Bearer <token>'
[
  {
    "requestId": "rq:3dWkVGNFae3FaS3h8UQJ4tBs5SrY:5zKtXEAq",
    "merchantId": 1,
    "userId": "user_2abc123def456",
    "permissions": [
      "ReadAccountsDetail",
      "ReadBalances",
      "ReadTransactionsDetail"
    ],
    "expirationDateTime": "2025-09-30T00:00:00Z",
    "transactionFromDateTime": "2025-01-01T00:00:00Z",
    "status": "pending",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z",
    "consentId": "consent_2abc123def456",
    "authorizationUrl": "https://web-app.token.io/app/consent/consent_2abc123def456",
    "errorMessage": "User denied consent"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
userId
string
required

Clerk user ID

Example:

"user_2abc123def456"

Query Parameters

​
merchantId
number
required

Merchant ID

Example:

1

Response

User consents retrieved successfully

​
requestId
string
required

Request ID (Token.io request ID)

Example:

"rq:3dWkVGNFae3FaS3h8UQJ4tBs5SrY:5zKtXEAq"

​
merchantId
number
required

Merchant ID

Example:

1

​
userId
string
required

User ID

Example:

"user_2abc123def456"

​
permissions
enum<string>[]
required

Array of consent permissions

Available options:
ReadAccountsDetail,
ReadBalances,
ReadTransactionsDetail
Example:
[
  "ReadAccountsDetail",
  "ReadBalances",
  "ReadTransactionsDetail"
]
​
expirationDateTime
string
required

Consent expiration date and time

Example:

"2025-09-30T00:00:00Z"

​
transactionFromDateTime
string
required

Earliest transaction date accessible

Example:

"2025-01-01T00:00:00Z"

​
status
enum<string>
required

Current consent status

Available options:
pending,
authorized,
expired,
revoked,
failed
Example:

"pending"

​
createdAt
string
required

Consent creation timestamp

Example:

"2024-01-15T10:30:00Z"

​
updatedAt
string
required

Last update timestamp

Example:

"2024-01-15T10:30:00Z"

​
consentId
string

Consent ID (Token.io tokenId) - populated after callback

Example:

"consent_2abc123def456"

​
authorizationUrl
string

Authorization URL for bank redirect

Example:

"https://web-app.token.io/app/consent/consent_2abc123def456"

​
errorMessage
string

Error message if consent failed

Example:

"User denied consent"