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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Yapily

Yapily Hosted Consent Pages API

Hosted Consent Pages endpoints for data products

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.0, 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.2.0
API Version
12.4.0
Base URL
https://api.yapily.com
Authentication
HTTP Basic
Contact
Yapily Support
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.

CreateHostedConsentRequest
object
7 properties 2 required
RawRequest
object
8 properties
UserSettings
object
Specifies the language and location preferences of the user.
2 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
ResponseMeta
object
1 property
HostedGetConsentRequestResponse
object
13 properties
ApiResponseOfGetHostedConsentRequest
object
2 properties
HostedConsentRequestResponse
object
11 properties
InstitutionIdentifiersResponse
object
Specifies the institution selected for making the payment.
2 properties
HostedAccountRequestDetailsResponse
object
Details of the Account Request.
4 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
ApiResponseOfCreateHostedConsentRequest
object
2 properties
ApiError
object
Provides details of the error that has occurred.
6 properties
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
HostedConsentPhase
object
The phase of the Consent Request.
2 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…
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

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
AE Profile APIs.io
Yapily Consents and Authorisations API
AE Profile APIs.io
Yapily Payments API (PIS)
AE Profile APIs.io
Yapily Data Plus API
AE Profile APIs.io
Yapily Application Beneficiaries API
AE Profile APIs.io
Yapily Application Management API
AE Profile APIs.io
Yapily Authorisations API
AE Profile APIs.io
Yapily Constraints API
AE Profile APIs.io
Yapily Financial Data API
AE Profile APIs.io
Yapily Hosted Payment Pages API
AE Profile APIs.io
Yapily Notifications API
AE Profile APIs.io
Yapily User Beneficiaries API
AE Profile APIs.io
#Hosted Consent Pages
← Back to Y APIs
API Details
ID
yapily:yapily-hosted-consent-pages-api
Base URL
https://api.yapily.com
Docs
https://docs.yapily.com/api/reference/
Provider
Yapily
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yapily-hosted-consent-pages-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yapily-hosted-consent-pages-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Yapily Hosted Consent Pages 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.