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

Sikoia Affordability Insights API

The Affordability Insights API from Sikoia — 5 operation(s) for affordability insights.

Sikoia Affordability Insights API is one of 19 APIs that Sikoia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Affordability Insights. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

Requests are made against 4 base URLs: https://api.sikoia.com, https://oauth2.sikoia.com, https://api-staging.sikoia.com, https://oauth2-staging.sikoia.com.

5 operations 5 paths 17 schemas 4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.sikoia.com
Authentication
HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Sikoia Affordability Insights API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (authorizationHeader). An API key is passed in the header as apikey (apiKeyHeader). By default, every request must be authenticated.

Paths & Operations 5

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

Affordability Insights 5
POST
/v2/affordability-insights
Request affordability insight
POST_v2-affordability-insights body → 201400401403429500
GET
/v2/{entity_type}/{entity_id}/affordability-insights
List all affordability insight requests
GET_v2-entity_type-entity_id-affordability-insights 2 params → 200401404429500
GET
/v2/affordability-insights/{request_id}
Retrieve affordability insight
GET_v2-affordability-insights-request_id 1 param → 200401404429500
GET
/v2/affordability-insights/{request_id}/transactions
Retrieve a monthly summary of transaction data
GET_v2-affordability-insights-request_id-transactions 1 param → 200401404429500
GET
/v2/affordability-insights/{request_id}/transaction-details
Retrieve a full breakdown of all transaction data
GET_v2-affordability-insights-request_id-transaction-details 1 param → 200401404429500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.Transaction (10 properties), SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.DetailedTransaction (9 properties), SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.TransactionDetailMappedResponse (9 properties), SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.TransactionViewMappedResponse (9 properties). Each schema is shown below with its type and property counts.

SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.MonthlyData
object
3 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.Cashflow
object
3 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.OrchestrationResponse
object
5 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.DataSource
object
4 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.AffordabilityInsightsData
object
3 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.Indicator
object
3 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.OrchestrationListResponse
object
3 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.Category
object
3 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Request.AffordabilityInsightsRequest
object
2 properties 2 required
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.AffordabilityInsightsMappedResponse
object
8 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.DetailedTransaction
object
9 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.SubCategory
object
2 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.TransactionViewMappedResponse
object
9 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.Transaction
object
10 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.TransactionDetailMappedResponse
object
9 properties
SikoiaCore.Common.SikoiaErrorResponse
object
See the [Response Guide](https://docs.sikoia.com/docs/api-behaviourresponses) for more detail
5 properties
SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.AffordabilityInsightsResponse
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sikoia-affordability-insights-api-openapi.yml Raw ↑

Other APIs Sikoia publishes across the network.

Sikoia Adverse Media API
Sikoia Authentication API
Sikoia Banking API
Sikoia Cases API
Sikoia Checklist API
Sikoia Companies & People API
Sikoia Company Credit Report API
Sikoia Company Registry API
Sikoia Data Sources API
Sikoia Documents API
Sikoia Excel Report API
Sikoia Identity Verification API
Where this information came from

This is an independent, third-party profile of Sikoia Affordability Insights 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.