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:
Request Body schema: application/jsonrequired
The create consent parameters
providerKey | string The selected provider key |
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
- Payload
{- "providerKey": "string",
- "userId": "string",
- "userIdGuid": "string",
- "externalUserId": "string",
- "redirectUrl": "string",
- "syncMode": "string"
}
Response samples
- 200
- 400
{- "consentId": "string",
- "consentUrl": "string"
}
Retrieve consents
Authorizations:
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
- 200
- 400
[- {
- "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": [
- {
- "date": "2019-08-24T14:15:22Z",
- "type": "string",
- "message": "string",
- "code": "string"
}
]
}
]
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:
path Parameters
id required | string <guid> Id of the consent to delete |
Responses
Response samples
- 400
{- "type": "string",
- "title": "string",
- "status": 0,
- "traceId": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}