Getting Started
Authorisations
- PUTUpdate Account Pre-authorisation
- POSTCreate Account Authorisation
- PATCHRe-authorise Account Consent
- POSTCreate Bulk Payment Authorisation
- POSTCreate Embedded Account Authorisation
- PUTUpdate Embedded Account Authorisation
- POSTCreate Embedded Bulk Payment Authorisation
- PUTUpdate Embedded Bulk Payment Authorisation
- POSTCreate Embedded Payment Authorisation
- PUTUpdate Embedded Payment Authorisation
- PUTUpdate Payment Pre-authorisation
- POSTCreate Payment Authorisation
- POSTCreate Pre-authorisation
- POSTCreate Payment Pre-authorisation
Financial Data
- GETGet Accounts
- GETGet Account
- GETGet Account Balances
- GETGet Account Beneficiaries
- GETGet Account Direct Debits
- GETGet Account Periodic Payments
- GETGet Account Scheduled Payments
- GETGet Account Statements
- GETGet Account Statement
- GETGet Account Statement File
- GETGet Account Transactions
- GETGet Identity
- GETGet Real Time Account Transactions
Payments
Consents
Institutions
Notifications
Variable Recurring Payments
Data Plus
Hosted Consent Pages
Hosted Payment Pages
Application Management
- GETRetrieve sub-applications for the root application provided in the authentication token.
- POSTCreates a sub-application for the root application id provided in the authentication token
- GETGet application details
- PUTUpdate an Application
- DELDelete an application
- GETGet application VRP configuration by Application Id
- PUTUpdate application VRP configuration by Application Id
- POSTCreate application VRP configuration by Application Id
Webhooks
Application Beneficiaries
Re-authorise Account Consent
Copy
Ask AI
curl --request PATCH \
--url https://api.yapily.com/account-auth-requests \
--header 'Authorization: Basic <encoded-value>' \
--header 'consent: <consent>'Copy
Ask AI
{
"meta": {
"tracingId": "8719f9c97272463d9c2d1ee6108c8e24"
},
"data": {
"id": "2812b61c-9d0b-4730-8c94-22c18918e66a",
"userUuid": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d",
"applicationUserId": "string",
"institutionId": "modelo-sandbox",
"status": "AWAITING_RE_AUTHORIZATION",
"createdAt": "2021-06-09T08:22:50.135Z",
"featureScope": [
"ACCOUNT_STATEMENT_FILE",
"ACCOUNT_TRANSACTIONS",
"ACCOUNT_STATEMENTS",
"ACCOUNTS",
"ACCOUNT"
],
"state": "0623e536c5044b4aa3f6c66e7537bee0",
"authorizedAt": "2021-06-09T08:23:03.944Z",
"institutionConsentId": "aac-f7847e99-7c66-4bb8-8641-61a24057f2e8",
"authorisationUrl": "https://ob19-auth1-ui.o3bank.co.uk/auth?client_id=e7f6b95b-5f35-419b-b301-8b08bcd946de&response_type=code+id_token&state=0623e536c5044b4aa3f6c66e7537bee0&nonce=0623e536c5044b4aa3f6c66e7537bee0&scope=openid+accounts&redirect_uri=https%3A%2F%2Fauth.yapily.com%2F&request=eyJraWQiOiJnRTRvU3VaZDl4TVpUNXZDdTNWYy1mdktNak0iLCJhbGciOiJQUzI1NiJ9.eyJhdWQiOiJodHRwczovL29iMTktYXV0aDEtdWkubzNiYW5rLmNvLnVrIiwic2NvcGUiOiJvcGVuaWQgYWNjb3VudHMiLCJpc3MiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJjbGllbnRfaWQiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJyZXNwb25zZV90eXBlIjoiY29kZSBpZF90b2tlbiIsInJlZGlyZWN0X3VyaSI6Imh0dHBzOi8vYXV0aC55YXBpbHkuY29tLyIsInN0YXRlIjoiMDYyM2U1MzZjNTA0NGI0YWEzZjZjNjZlNzUzN2JlZTAiLCJjbGFpbXMiOnsiaWRfdG9rZW4iOnsiYWNyIjp7InZhbHVlIjoidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwiZXNzZW50aWFsIjp0cnVlfSwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjp7InZhbHVlIjoiYWFjLWY3ODQ3ZTk5LTdjNjYtNGJiOC04NjQxLTYxYTI0MDU3ZjJlOCIsImVzc2VudGlhbCI6dHJ1ZX19LCJ1c2VyaW5mbyI6eyJvcGVuYmFua2luZ19pbnRlbnRfaWQiOnsidmFsdWUiOiJhYWMtZjc4NDdlOTktN2M2Ni00YmI4LTg2NDEtNjFhMjQwNTdmMmU4IiwiZXNzZW50aWFsIjp0cnVlfX19LCJub25jZSI6IjA2MjNlNTM2YzUwNDRiNGFhM2Y2YzY2ZTc1MzdiZWUwIiwianRpIjoiMjEyM2E1OGMtMTExYi00OGY2LTg2ODAtZTViYTNiMzI3MjM5IiwiaWF0IjoxNjIzMjI3MDAxLCJleHAiOjE2MjMyMjg4MDF9.JG5lc5TWjCucWZPfcyd34trk0QcGNzhYXfhHTlVrcfu1zjrAtSUI8i0o4yKqS19cOGKHq1HtuQac2hhO8gCr_vd5n7eIuIrWfjEM1MuIwsJ85jOpMBkEiSOurLRIgW77VmqHpVUVj5-0-1Tk-N-vaC_4nIdtSi576sOb4rjLQvs2EX_sFODGjyMxHXiZlnr2p71gA3nRy8M2Vv_At4-NPW8OLULS8zXclWoK797HFAGtsNLCy8tz0YCsnEaFhcLhZSliy3a7DRfxvBmIzhY23M4uQ6bpM1zCyqTPsOhqR-qdgnZorBrax_2CQ37yIeV4becUJWvZSdnjYX7gDtNltA",
"qrCodeUrl": "https://images.yapily.com/image/4ef6e16c-dbe2-4d90-9e1b-868d946082ef/1623227001?size=0"
}
}Authorisations
Re-authorise Account Consent
Used to prompt the account holder for continued access to their financial data. This endpoint should be used when a Consent that was previously AUTHORIZED can no longer be used to retrieve data.
Re-authorise Account Consent
Copy
Ask AI
curl --request PATCH \
--url https://api.yapily.com/account-auth-requests \
--header 'Authorization: Basic <encoded-value>' \
--header 'consent: <consent>'Copy
Ask AI
{
"meta": {
"tracingId": "8719f9c97272463d9c2d1ee6108c8e24"
},
"data": {
"id": "2812b61c-9d0b-4730-8c94-22c18918e66a",
"userUuid": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d",
"applicationUserId": "string",
"institutionId": "modelo-sandbox",
"status": "AWAITING_RE_AUTHORIZATION",
"createdAt": "2021-06-09T08:22:50.135Z",
"featureScope": [
"ACCOUNT_STATEMENT_FILE",
"ACCOUNT_TRANSACTIONS",
"ACCOUNT_STATEMENTS",
"ACCOUNTS",
"ACCOUNT"
],
"state": "0623e536c5044b4aa3f6c66e7537bee0",
"authorizedAt": "2021-06-09T08:23:03.944Z",
"institutionConsentId": "aac-f7847e99-7c66-4bb8-8641-61a24057f2e8",
"authorisationUrl": "https://ob19-auth1-ui.o3bank.co.uk/auth?client_id=e7f6b95b-5f35-419b-b301-8b08bcd946de&response_type=code+id_token&state=0623e536c5044b4aa3f6c66e7537bee0&nonce=0623e536c5044b4aa3f6c66e7537bee0&scope=openid+accounts&redirect_uri=https%3A%2F%2Fauth.yapily.com%2F&request=eyJraWQiOiJnRTRvU3VaZDl4TVpUNXZDdTNWYy1mdktNak0iLCJhbGciOiJQUzI1NiJ9.eyJhdWQiOiJodHRwczovL29iMTktYXV0aDEtdWkubzNiYW5rLmNvLnVrIiwic2NvcGUiOiJvcGVuaWQgYWNjb3VudHMiLCJpc3MiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJjbGllbnRfaWQiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJyZXNwb25zZV90eXBlIjoiY29kZSBpZF90b2tlbiIsInJlZGlyZWN0X3VyaSI6Imh0dHBzOi8vYXV0aC55YXBpbHkuY29tLyIsInN0YXRlIjoiMDYyM2U1MzZjNTA0NGI0YWEzZjZjNjZlNzUzN2JlZTAiLCJjbGFpbXMiOnsiaWRfdG9rZW4iOnsiYWNyIjp7InZhbHVlIjoidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwiZXNzZW50aWFsIjp0cnVlfSwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjp7InZhbHVlIjoiYWFjLWY3ODQ3ZTk5LTdjNjYtNGJiOC04NjQxLTYxYTI0MDU3ZjJlOCIsImVzc2VudGlhbCI6dHJ1ZX19LCJ1c2VyaW5mbyI6eyJvcGVuYmFua2luZ19pbnRlbnRfaWQiOnsidmFsdWUiOiJhYWMtZjc4NDdlOTktN2M2Ni00YmI4LTg2NDEtNjFhMjQwNTdmMmU4IiwiZXNzZW50aWFsIjp0cnVlfX19LCJub25jZSI6IjA2MjNlNTM2YzUwNDRiNGFhM2Y2YzY2ZTc1MzdiZWUwIiwianRpIjoiMjEyM2E1OGMtMTExYi00OGY2LTg2ODAtZTViYTNiMzI3MjM5IiwiaWF0IjoxNjIzMjI3MDAxLCJleHAiOjE2MjMyMjg4MDF9.JG5lc5TWjCucWZPfcyd34trk0QcGNzhYXfhHTlVrcfu1zjrAtSUI8i0o4yKqS19cOGKHq1HtuQac2hhO8gCr_vd5n7eIuIrWfjEM1MuIwsJ85jOpMBkEiSOurLRIgW77VmqHpVUVj5-0-1Tk-N-vaC_4nIdtSi576sOb4rjLQvs2EX_sFODGjyMxHXiZlnr2p71gA3nRy8M2Vv_At4-NPW8OLULS8zXclWoK797HFAGtsNLCy8tz0YCsnEaFhcLhZSliy3a7DRfxvBmIzhY23M4uQ6bpM1zCyqTPsOhqR-qdgnZorBrax_2CQ37yIeV4becUJWvZSdnjYX7gDtNltA",
"qrCodeUrl": "https://images.yapily.com/image/4ef6e16c-dbe2-4d90-9e1b-868d946082ef/1623227001?size=0"
}
}Learn more: Re-Authorisation
Authorizations
Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.
Headers
Mandatory. The consent-token containing the user's authorisation to make the request.
Conditional. Represents the user's login ID for the Institution to a personal account.
See PSU identifiers to see if this header is required.
Conditional. Represents the user's login ID for the Institution to a business account.
See PSU identifiers to see if this header is required.
Conditional. The IP address of the PSU.
See PSU identifiers to see if this header is required.
The sub-application ID to which event type is being subscribed to
Was this page helpful?