Skip to main content

Users API (v1)

Download OpenAPI specification:Download

Users

Create a user

Authorizations:
bearer
Request Body schema: application/json
required

The user parameter

externalUserId
string

A unique case-insensitive key for the user.

Responses

Request samples

Content type
application/json
{
  • "externalUserId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "externalUserId": "string"
}

Delete user

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

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

The User ID to delete

ExternalUserId
string or null

The External User ID to delete

Responses

Response samples

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

Get user information by UserId or ExternalUserId

This endpoint returns details about the user with the given UserId or ExternalUserId and its consents, if found.

Authorizations:
bearer
path Parameters
Id
required
string

The User ID or External User ID for which to get information

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "appId": 0,
  • "externalUserId": "string",
  • "consents": [
    ],
  • "created": "2019-08-24T14:15:22Z"
}