API Reference
Start typing to search…
These docs are for v2.5. Click to read the latest docs for v3.0.

Create an auth request

post
https://identity.moneyhub.co.uk/auth-requests

Requires auth_requests:write scope.

Body Params
string

One of the redirect uri that is set up under your API client. Required until separate bank registration is complete

string
length between 24 and 24

The id of the user. Required for second use case - account access.

string
required

The scope for the auth request

string

The connection id. Required when scope has 'reauth' or 'refresh'

payment
object
standingOrder
object
recurringPayment
object
reversePayment
object
string
enum

Type of transaction categorisation to use. Defaults to personal categories

Allowed:
boolean

If you require the connection to check for benefits payments, set this to true

counterpartiesCheck
array of uuids

If set, will check the connection for transactions with these counterparties. Will return true if one exists.

counterpartiesCheck
permissions
array of strings

Defines permissions, which can enable functionalities like standing orders or beneficiaries. Can also be used to apply a lighter set of permissions than the default set. The behavior depends on 'permissionsAction'.

permissions
string
enum

Dictates how 'permissions' function. 'add' (default) to increment, or 'replace' to substitute default permissions.

Allowed:
date-time

The date time that an AIS consent will expire at. If no user ID is provided, expiry will default to 24 hours. Maximum allowed 90 days from now.

date-time

The date time transactions will be retrieved from. Maximum allowed 24 months before now.

sync
object

Options for the sync of a connection

string

This field could be used to pass the custom customer's IP address to the bank.

string

The time when the customer last logged in represented as an ISO 8601 date-time format including timezone

Responses

Updated 7 months ago

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