Moneyhub Identity Service

connections
auth-requests
user connections
payees
pay-links
pay-file
payments
users
scim
- Create a scim user. This type of user holds personally identifiable informationpost
- Retrieve a scim user. This type of user holds personally identifiable informationget
consents
- Displays the internal consent screen for a given auth requestget
auth
bank-icons
- Retreive the bank icon as SVG when providing a valid bank reference listed under our available connections. Can also return PNG or JPG images when .png or .jpg file extension is added.get

Moneyhub Data API (v3)

accounts
holdings
notification thresholds
standing orders
- Retrieve the standing orders for an accountget
statements
- Retrieve the statements for an accountget
affordability
beneficiaries
- Retrieve all beneficiaries for a userget
- Retrieve a single beneficiaryget
counterparties
- Retrieve global counterpartiesget
transactions
categories
regular transactions
- Retrieve regular transactionsget
- Detect regular transactionspost
rental records
spending analysis
- Retrieve spending analysis by categories, projects and accountspost
spending goals
savings goals
standard-financial-statements
sync
- Sync an existing connectionpost
projects
tax
- Retrieve transactions to help answer SA105 - the Self Assessment questions for properties for HMRCget

Moneyhub Identity Service

connections
auth-requests
user connections
payees
pay-links
pay-file
payments
users
scim
- Create a scim user. This type of user holds personally identifiable informationpost
- Retrieve a scim user. This type of user holds personally identifiable informationget
consents
- Displays the internal consent screen for a given auth requestget
auth
bank-icons
- Retreive the bank icon as SVG when providing a valid bank reference listed under our available connections. Can also return PNG or JPG images when .png or .jpg file extension is added.get

Moneyhub Data API (v3)

accounts
holdings
notification thresholds
standing orders
- Retrieve the standing orders for an accountget
statements
- Retrieve the statements for an accountget
affordability
beneficiaries
- Retrieve all beneficiaries for a userget
- Retrieve a single beneficiaryget
counterparties
- Retrieve global counterpartiesget
transactions
categories
regular transactions
- Retrieve regular transactionsget
- Detect regular transactionspost
rental records
spending analysis
- Retrieve spending analysis by categories, projects and accountspost
spending goals
savings goals
standard-financial-statements
sync
- Sync an existing connectionpost
projects
tax
- Retrieve transactions to help answer SA105 - the Self Assessment questions for properties for HMRCget

Retrieve a single user connection sync

get https://identity.moneyhub.co.uk/users/{userId}/syncs/{syncId}

Requires user:read scope.

URL Expired

The URL for this request expired after 30 days.

Path Params

userId

string

required

length between 24 and 24

The user Id

syncId

string

required

The sync id

Responses

Response body

object

data

object

string

required

ID of sync

connectionId

string

required

Connection id composed of the bank id and unique connection id

action

string

required

Action of the sync

auto-update client-update authorization

method

string

required

Method of the sync

ADD UPDATE

fetchStatus

string

required

Status of the sync

success error partial mfa-required credentials-error

createdAt

date-time

required

When the sync started

fetchedAt

date-time

required

When the sync last updated

accounts

array of objects

required

List of accounts that were synced

accounts*

object

providerId

string

required

The ID of the account held by the banking provider

accountId

string

required

The ID of the account when stored by Moneyhub

postConnectionEnrichmentStatus

string

Shows whether the regular transactions for the given account has been synchronised

success error

postConnectionEnrichedAt

date-time

The time at which regular transactions were retrieved at

meta

object

Has additional fields

Response body

object

code

string

required

The error code

message

string

The error message

correlationId

string

Id that identifies the request and can be used to ask for more details related to the error

Response body

object

code

string

required

The error code

message

string

The error message

correlationId

string

Id that identifies the request and can be used to ask for more details related to the error

Response body

object

code

string

required

The error code

message

string

The error message

correlationId

string

Id that identifies the request and can be used to ask for more details related to the error

Updated over 1 year ago

Retrieve all syncs for a user

payees

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://identity.moneyhub.co.uk/users/userId/syncs/syncId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

Retrieve all syncs for a user

payees

Moneyhub Identity Service
connections
Retrieve all connections that allow paymentsget
Retrieve all test connectionsget
Retrieve all legacy connectionsget
Retrieve all api connectionsget
Retrieve all connectionsget
auth-requests
Update a single auth requestpatch
Retrieve a single auth requestget
Create an auth requestpost
Retrieve all auth requests for a userget
user connections
Retrieve a single user connection syncget
Retrieve all syncs for a userget
Retrieve a user connection's syncsget
Deletes a single user connectiondelete
Update a single connectionpatch
Retrieve a user connectionsget
payees
Retrieve one payee created by an API clientget
Create a payeepost
Retrieve all payees created by an API clientget
pay-links
Retrieve one pay-link created by an API clientget
Create a pay-linkpost
Retrieve all pay-links created by an API clientget
pay-file
Retrieve a single payment file consentget
Retrieve all file payment consents created by an API clientget
Execute a payment filepost
Upload payment file datapost
Retrieve a previously uploaded payment fileget
Upload a payment filepost
payments
Creates a payment against a recurring payment consentpost
Revokes a recurring paymentdelete
Retrieve a single recurring paymentget
Retrieve all recurring payments created by an API clientget
Retrieve a single standing orderget
Retrieve all standing orders created by an API clientget
Retrieve a single paymentget
Retrieve all payments created by an API clientget
users
Deletes a single userdelete
Retrieve a single userget
Create a userpost
Retrieve all users created by an API clientget
scim
Retrieve a scim user. This type of user holds personally identifiable informationget
Create a scim user. This type of user holds personally identifiable informationpost
consents
Displays the internal consent screen for a given auth requestget
auth
Retrieve Open ID Connect configurationget
Pushed Authorization Request endpoint. Retrieve a request_uri that can be used with the oidc/auth endpoint. More info here: https://docs.moneyhubenterprise.com/docs/how-to-use-pushed-authorization-request-par-endpointpost
Retrieve an authorisation tokenpost
Construct authorisation url to authenticate the end-userget
bank-icons
Retreive the bank icon as SVG when providing a valid bank reference listed under our available connections. Can also return PNG or JPG images when .png or .jpg file extension is added.get

Moneyhub Data API (v3)
accounts
Retrieve sync information for all of a user's accountsget
Add a new balance for an accountpost
Retrieve the historical balances for an accountget
Delete a single accountdelete
Update a single accountpatch
Retrieve a single accountget
Create a single account for a userpost
Retrieve all accounts for a userget
holdings
Retrieve the holdings for an account with matched ISIN codesget
Retrieves a single holding for an account with matched ISIN codesget
Retrieve the holdings for an accountget
notification thresholds
Delete a single notification thresholddelete
Update a single notification thresholdpatch
Add a notification threshold to an accountpost
Retrieve the notification thresholds for an accountget
standing orders
Retrieve the standing orders for an accountget
statements
Retrieve the statements for an accountget
affordability
Get an existing affordability income calculation for a userget
Request affordability income calculation for a userpost
List of metadata for all affordability income calculations for a userget
Get an existing affordability calculation for a userget
Get the affordability confidence calculation for a user, given the account and transaction data currently availableget
Request affordability calculation for a userpost
List of metadata for all affordability calculations for a userget
beneficiaries
Retrieve a single beneficiaryget
Retrieve all beneficiaries for a userget
counterparties
Retrieve global counterpartiesget
transactions
Patch a transaction splitpatch
Merge split transactionsdelete
Split a transactionpost
Retrieve a transactions splitsget
Delete a single attachment on a transactiondelete
Retrieve a transactions attachmentget
Add an attachment to a transactionpost
Retrieve a transactions attachmentsget
Create multiple transactions for a userpost
Delete a single transactiondelete
Update a single transactionpatch
Retrieve a single transactionget
Create a single transaction for a userpost
Retrieve all transactions for a userget
categories
Retrieve all category groups for a userget
Retrieve a single categoryget
Add a new custom category for a userpost
Retrieve all categories for a userget
regular transactions
Detect regular transactionspost
Retrieve regular transactionsget
rental records
Delete a rental recorddelete
Create a rental recognition record for userpost
Retrieve rental recognition recordget
spending analysis
Retrieve spending analysis by categories, projects and accountspost
spending goals
Delete a single spending goaldelete
Update a single spending goalpatch
Retrieve a single spending goalget
Create a single spending goal for a userpost
Retrieve all spending goals for a userget
savings goals
Delete a single savings goaldelete
Update a single savings goalpatch
Retrieve a single savings goalget
Create a single savings goal for a userpost
Retrieve all saving goals for a userget
standard-financial-statements
Request standard financial statement for a userpost
List of metadata for all standard financial statements for a userget
Get an existing standard financial statement for a userget
sync
Sync an existing connectionpost
projects
Delete a single projectdelete
Update a single projectpatch
Retrieve a single projectget
Create a single project for a userpost
Retrieve all projects for a userget
tax
Retrieve transactions to help answer SA105 - the Self Assessment questions for properties for HMRCget

Moneyhub Identity Service
connections
Retrieve all connections that allow paymentsget
Retrieve all test connectionsget
Retrieve all legacy connectionsget
Retrieve all api connectionsget
Retrieve all connectionsget
auth-requests
Update a single auth requestpatch
Retrieve a single auth requestget
Create an auth requestpost
Retrieve all auth requests for a userget
user connections
Retrieve a single user connection syncget
Retrieve all syncs for a userget
Retrieve a user connection's syncsget
Deletes a single user connectiondelete
Update a single connectionpatch
Retrieve a user connectionsget
payees
Retrieve one payee created by an API clientget
Create a payeepost
Retrieve all payees created by an API clientget
pay-links
Retrieve one pay-link created by an API clientget
Create a pay-linkpost
Retrieve all pay-links created by an API clientget
pay-file
Retrieve a single payment file consentget
Retrieve all file payment consents created by an API clientget
Execute a payment filepost
Upload payment file datapost
Retrieve a previously uploaded payment fileget
Upload a payment filepost
payments
Creates a payment against a recurring payment consentpost
Revokes a recurring paymentdelete
Retrieve a single recurring paymentget
Retrieve all recurring payments created by an API clientget
Retrieve a single standing orderget
Retrieve all standing orders created by an API clientget
Retrieve a single paymentget
Retrieve all payments created by an API clientget
users
Deletes a single userdelete
Retrieve a single userget
Create a userpost
Retrieve all users created by an API clientget
scim
Retrieve a scim user. This type of user holds personally identifiable informationget
Create a scim user. This type of user holds personally identifiable informationpost
consents
Displays the internal consent screen for a given auth requestget
auth
Retrieve Open ID Connect configurationget
Pushed Authorization Request endpoint. Retrieve a request_uri that can be used with the oidc/auth endpoint. More info here: https://docs.moneyhubenterprise.com/docs/how-to-use-pushed-authorization-request-par-endpointpost
Retrieve an authorisation tokenpost
Construct authorisation url to authenticate the end-userget
bank-icons
Retreive the bank icon as SVG when providing a valid bank reference listed under our available connections. Can also return PNG or JPG images when .png or .jpg file extension is added.get

Moneyhub Data API (v3)
accounts
Retrieve sync information for all of a user's accountsget
Add a new balance for an accountpost
Retrieve the historical balances for an accountget
Delete a single accountdelete
Update a single accountpatch
Retrieve a single accountget
Create a single account for a userpost
Retrieve all accounts for a userget
holdings
Retrieve the holdings for an account with matched ISIN codesget
Retrieves a single holding for an account with matched ISIN codesget
Retrieve the holdings for an accountget
notification thresholds
Delete a single notification thresholddelete
Update a single notification thresholdpatch
Add a notification threshold to an accountpost
Retrieve the notification thresholds for an accountget
standing orders
Retrieve the standing orders for an accountget
statements
Retrieve the statements for an accountget
affordability
Get an existing affordability income calculation for a userget
Request affordability income calculation for a userpost
List of metadata for all affordability income calculations for a userget
Get an existing affordability calculation for a userget
Get the affordability confidence calculation for a user, given the account and transaction data currently availableget
Request affordability calculation for a userpost
List of metadata for all affordability calculations for a userget
beneficiaries
Retrieve a single beneficiaryget
Retrieve all beneficiaries for a userget
counterparties
Retrieve global counterpartiesget
transactions
Patch a transaction splitpatch
Merge split transactionsdelete
Split a transactionpost
Retrieve a transactions splitsget
Delete a single attachment on a transactiondelete
Retrieve a transactions attachmentget
Add an attachment to a transactionpost
Retrieve a transactions attachmentsget
Create multiple transactions for a userpost
Delete a single transactiondelete
Update a single transactionpatch
Retrieve a single transactionget
Create a single transaction for a userpost
Retrieve all transactions for a userget
categories
Retrieve all category groups for a userget
Retrieve a single categoryget
Add a new custom category for a userpost
Retrieve all categories for a userget
regular transactions
Detect regular transactionspost
Retrieve regular transactionsget
rental records
Delete a rental recorddelete
Create a rental recognition record for userpost
Retrieve rental recognition recordget
spending analysis
Retrieve spending analysis by categories, projects and accountspost
spending goals
Delete a single spending goaldelete
Update a single spending goalpatch
Retrieve a single spending goalget
Create a single spending goal for a userpost
Retrieve all spending goals for a userget
savings goals
Delete a single savings goaldelete
Update a single savings goalpatch
Retrieve a single savings goalget
Create a single savings goal for a userpost
Retrieve all saving goals for a userget
standard-financial-statements
Request standard financial statement for a userpost
List of metadata for all standard financial statements for a userget
Get an existing standard financial statement for a userget
sync
Sync an existing connectionpost
projects
Delete a single projectdelete
Update a single projectpatch
Retrieve a single projectget
Create a single project for a userpost
Retrieve all projects for a userget
tax
Retrieve transactions to help answer SA105 - the Self Assessment questions for properties for HMRCget

200Successful Syncs Response

401Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token

403Unsuccessful Response - Forbidden - Invalid scopes

404Unsuccessful Response - Resource Not found