Create CaaS Account for User

Given a userId this endpoint will create a CaaS account for the user. The response includes providerId and a populated providerName when a provider is resolved.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The User ID

Body Params

The CaaS account to be created.

string
length ≤ 256

An optional identifying value for an account. This must be 256 characters or less.

string

The optional name of the financial institution this account belongs to. A full list of supported providers can be found via the providers endpoint. Omit or blank values will use default categorisation.

string
enum
required

The account type for CaaS account creation.

Responses

400

Account data validation failed, or the supplied providerName is not a supported provider.

401

API key authentication unsuccessful.

403

CaaS is forbidden for the requesting partner.

404

User is invalid or does not exist.

500

Default provider not found.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json