Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yapily Hosted Consent Pages API

Hosted Consent Pages endpoints for data products

Yapily Hosted Consent Pages API is one of 16 APIs that Yapily publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Hosted Consent Pages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 18 schemas. It is described by OpenAPI 3.0.1, at version 12.4.0.

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

2 operations 2 paths 18 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Yapily Hosted Consent Pages 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 2

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

Hosted Consent Pages 2

Hosted Consent Pages endpoints for data products

POST
/hosted/consent-requests
Create Hosted Consent Request
createHostedConsentRequest 1 param body → 201400401500default
GET
/hosted/consent-requests/{consentRequestId}
Get Hosted Consent Request
getHostedConsentRequest 2 params → 200401404500default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are HostedGetConsentRequestResponse (13 properties), HostedConsentRequestResponse (11 properties), RawRequest (8 properties), CreateHostedConsentRequest (7 properties). Each schema is shown below with its type and property counts.

HostedAccountRequestDetailsResponse
object
Details of the Account Request.
4 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…
UserSettings
object
Specifies the language and location preferences of the user.
2 properties
HostedConsentRequestResponse
object
11 properties
HostedAccountRequest
object
Conditional. Used to further specify details of the Consent to request Conditions: 1. Mandatory to specify the individual scopes to request from the user at th…
4 properties
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
ResponseMeta
object
1 property
ApiResponseOfGetHostedConsentRequest
object
2 properties
ApiError
object
Provides details of the error that has occurred.
6 properties
InstitutionIdentifiersResponse
object
Specifies the institution selected for making the payment.
2 properties
HostedGetConsentRequestResponse
object
13 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
InstitutionIdentifiers
object
Specifies the institution requirements for making the payment. Skips the bank selection screen in payment flow if the institutionId and institutionCountryCode…
2 properties 1 required
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
ApiResponseOfCreateHostedConsentRequest
object
2 properties
RawRequest
object
8 properties
HostedConsentPhase
object
The phase of the Consent Request.
2 properties
CreateHostedConsentRequest
object
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yapily-hosted-consent-pages-api-openapi.yml Raw ↑

Other APIs Yapily publishes across the network.

Yapily Institutions API
Yapily Consents and Authorisations 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 Payment Pages API
Yapily Notifications API
Yapily User Beneficiaries API