How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yapily Consents and Authorisations API

Create, retrieve, revoke, and re-authorise PSD2 consents for AIS and PIS interactions across UK Open Banking and Berlin Group ASPSPs. Supports redirect, embedded, and decoupled flows.

Yapily Consents and Authorisations API is one of 16 APIs that Yapily publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Consents, Authorisations, PSD2, and Open Banking. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 JSON Schema.

This API exposes 6 operations across 5 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 12.4.0.

Requests are made against a single base URL, https://api.yapily.com.

6 operations 5 paths 28 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
12.4.0
Base URL
https://api.yapily.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Yapily Consents and Authorisations API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the [Yapily Console](https://conso…

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Consents 6

The Consents endpoints are used to manage each Consent created by Yapily in response to an authorisation created for a user. The Consent object contains data that identifies a use…

POST
/consent-auth-code
Exchange Oauth2 Code
createConsentWithCode body → 200default
POST
/consent-one-time-token
Exchange One Time Token
getConsentBySingleAccessConsent body → 201default
GET
/consents
Get Consents
getConsents 8 params → 200default
DELETE
/consents/{consentId}
Delete Consent
delete 2 params → 200default
GET
/consents/{consentId}
Get Consent
getConsentById 1 param → 200default
POST
/consents/{consentId}/extend
Extend Consent
extendConsent 1 param body → 200400default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Consent (20 properties), RawRequest (8 properties), ApiListResponseOfConsent (7 properties), ApiResponseOfConsentDeleteResponse (6 properties). Each schema is shown below with its type and property counts.

DeleteStatusEnum
string
Indicates the outcome of the delete request.
ExtendConsentRequest
object
1 property 1 required
SortEnum
string
The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.
FilteredClientPayloadListConsent
object
6 properties
ApiResponseOfConsent
object
6 properties
ConsentAuthCodeRequest
object
The request body containing the ConsentAuthCodeRequest json payload
2 properties 2 required
ErrorIssue
object
Detailed information regarding the issue that was experienced during processing of the request
5 properties 2 required
RawRequest
object
8 properties
ApiResponseError
object
Used to return errors from the bank from each request - 400 - Returned by any POST endpoint when the body does not conform to the contract - 401 - Returned by…
2 properties
ErrorDetails
object
6 properties 3 required
ApiError
object
Provides details of the error that has occurred.
6 properties
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
ResponseForwardedData
object
2 properties
AuthorisationStatus
string
Current status of the embedded authorisation request in code form.
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
Pagination
object
3 properties
ResponseListMeta
object
3 properties
ConsentDeleteResponse
object
5 properties
FeatureEnum
string
Used to describe what functions are supported by the associated Institution. For more information on each feature, see the following links: - [Financial Data F…
ApiListResponseOfConsent
object
7 properties
Consent
object
Consent detailing the requested authorisation from a user to a specific Institution.
20 properties
ApiCall
object
FilterAndSort
object
6 properties
ApiErrorResponse
object
Used to return errors from the bank from each request - 400 - Returned by any POST endpoint when the body does not conform to the contract - 401 - Returned by…
1 property
OneTimeTokenRequest
object
The request body containing the OneTimeTokenRequest json payload
1 property 1 required
ResponseMeta
object
1 property
ApiResponseOfConsentDeleteResponse
object
6 properties
Next
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yapily-consents-api-openapi.yml Raw ↑

Other APIs Yapily publishes across the network.

Yapily Institutions API
Yapily Payments API (PIS)
Yapily Data Plus API
Yapily Application Beneficiaries API
Yapily Application Management API
Yapily Authorisations API
Yapily Constraints API
Yapily Financial Data API
Yapily Hosted Consent Pages API
Yapily Hosted Payment Pages API
Yapily Notifications API
Yapily User Beneficiaries API
Where this information came from

This is an independent, third-party profile of Yapily Consents and Authorisations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.