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

Cable retail API

The retail API from Cable — 8 operation(s) for retail.

Cable retail API is one of 20 APIs that Cable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include retail. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 8 paths, and defines 32 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.cable.tech.

8 operations 8 paths 32 schemas 8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.cable.tech
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Cable retail API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 8

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

retail 8
POST
/v1/retail/screening_check
Add screening check information
v-1-retail-screening-check 1 param body → 200
POST
/v1/retail/sar_info
Add SAR information
v-1-retail-sar-info 1 param body → 200
POST
/v1/retail/risk_assessment
Add risk assessment information
v-1-retail-risk-assessment 1 param body → 200
POST
/v1/retail/person_info
Add person information
v-1-retail-person-info 1 param body → 200
POST
/v1/retail/onboarding_flow
Add onboarding flow information
v-1-retail-onboarding-flow 1 param body → 200
POST
/v1/retail/idv_info
Add IDV information
v-1-retail-idv-info 1 param body → 200
POST
/v1/retail/account_status
Add account status information
v-1-retail-account-status-info 1 param body → 200
POST
/v1/retail/access_info
Add access information
v-1-retail-access-info 1 param body → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are V1RetailPersonInfoPostRequestBodyContentApplicationJsonSchemaItemsData (13 properties), V1RetailIdvInfoPostRequestBodyContentApplicationJsonSchemaItemsData (10 properties), Address (6 properties), V1RetailScreeningCheckPostRequestBodyContentApplicationJsonSchemaItemsData (6 properties). Each schema is shown below with its type and property counts.

V1RetailPersonInfoPostRequestBodyContentApplicationJsonSchemaItems
object
4 properties 4 required
V1RetailIdvInfoPostRequestBodyContentApplicationJsonSchemaItemsData
object
10 properties 3 required
V1RetailPersonInfoPostRequestBodyContentApplicationJsonSchemaItemsDataNationalIdentificationNumber
object
2 properties 2 required
V1RetailRiskAssessmentPostRequestBodyContentApplicationJsonSchemaItemsData
object
3 properties 2 required
Retail_v1_retail_person_info_Response_200
object
1 property 1 required
V1RetailOnboardingFlowPostRequestBodyContentApplicationJsonSchemaItemsData
object
4 properties 2 required
Retail_v1_retail_sar_info_Response_200
object
1 property 1 required
V1RetailPersonInfoPostRequestBodyContentApplicationJsonSchemaItemsData
object
13 properties
Retail_v1_retail_risk_assessment_Response_200
object
1 property 1 required
V1RetailSarInfoPostRequestBodyContentApplicationJsonSchemaItemsDataStatus
string
Retail_v1_retail_onboarding_flow_Response_200
object
1 property 1 required
Retail_v1_retail_screening_check_Response_200
object
1 property 1 required
V1RetailScreeningCheckPostRequestBodyContentApplicationJsonSchemaItemsData
object
6 properties 4 required
V1RetailIdvInfoPostRequestBodyContentApplicationJsonSchemaItemsDataExternallyVerifiedDataItems
object
4 properties 4 required
V1RetailIdvInfoPostRequestBodyContentApplicationJsonSchemaItems
object
3 properties 3 required
V1RetailRiskAssessmentPostRequestBodyContentApplicationJsonSchemaItems
object
3 properties 3 required
V1RetailScreeningCheckPostRequestBodyContentApplicationJsonSchemaItems
object
3 properties 3 required
V1RetailOnboardingFlowPostRequestBodyContentApplicationJsonSchemaItemsDataOutcomeReason
Address
object
Legal/contact address for the entity
6 properties
RetailEntityParent
object
1 property 1 required
V1RetailAccessInfoPostRequestBodyContentApplicationJsonSchemaItemsData
object
3 properties
V1RetailAccountStatusPostRequestBodyContentApplicationJsonSchemaItems
object
3 properties 3 required
Retail_v1_retail_account_status_info_Response_200
object
1 property 1 required
Retail_v1_retail_idv_info_Response_200
object
1 property 1 required
V1RetailIdvInfoPostRequestBodyContentApplicationJsonSchemaItemsDataDocumentExtractedDataItems
object
2 properties 2 required
Retail_v1_retail_access_info_Response_200
object
1 property 1 required
V1RetailSarInfoPostRequestBodyContentApplicationJsonSchemaItems
object
3 properties 3 required
V1RetailOnboardingFlowPostRequestBodyContentApplicationJsonSchemaItems
object
3 properties 3 required
CustomData
object
Custom data that is relevant. This can be any JSON object. Please include any details and data points that our schema does not capture.
V1RetailAccessInfoPostRequestBodyContentApplicationJsonSchemaItems
object
3 properties 3 required
V1RetailSarInfoPostRequestBodyContentApplicationJsonSchemaItemsData
object
4 properties 1 required
V1RetailAccountStatusPostRequestBodyContentApplicationJsonSchemaItemsData
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cable-retail-api-openapi.yml Raw ↑

Other APIs Cable publishes across the network.

Cable alerts API
Cable authentication API
Cable business API
Cable checks API
Cable company API
Cable customerSar API
Cable helper API
Cable identityVerification API
Cable onboardingFlow API
Cable person API
Cable riskAssessment API
Cable screening API