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 onboardingFlow API

The onboardingFlow API from Cable — 1 operation(s) for onboardingflow.

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

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

This API exposes 3 operations across 1 path, and defines 8 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.

3 operations 1 paths 8 schemas 1 GET1 POST1 PUT

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 onboardingFlow 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 3

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

onboardingFlow 3
GET
/v2/onboarding_flow
Check if an onboarding flow exists
check-onboarding-f-low 2 params → 200401404429500
POST
/v2/onboarding_flow
Add onboarding flow information
add-onboarding-flow 1 param body → 201400401409429500
PUT
/v2/onboarding_flow
Update onboarding flow in batch
update-onboarding-flows 1 param body → 200400401404429500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are OnboardingFlow (7 properties), Onboarding Flow_checkOnboardingFLow_Response_200 (4 properties), WriteOperationResponse (4 properties), GeneralError (3 properties). Each schema is shown below with its type and property counts.

OnboardingFlow
object
Request body for adding Onboarding Flow information for a parent entity, applicable to both retail and business contexts
7 properties 4 required
Onboarding Flow_checkOnboardingFLow_Response_200
object
4 properties
GeneralErrorErrorsItems
object
2 properties
OnboardingFlowOutcomeReason
UpdateOnboardingFlowRequest
array
NewOnboardingFlowRequest
array
GeneralError
object
3 properties 2 required
WriteOperationResponse
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cable-onboardingflow-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 person API
Cable retail API
Cable riskAssessment API
Cable screening API