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

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

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

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

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

checks 3
GET
/transaction_check
Check if a transaction check exists
check-transaction-check 2 params → 200401404429500
POST
/transaction_check
Add new transaction check(s)
add-transaction-check 1 param body → 201400401409429500
PUT
/transaction_check
Update an existing transaction check
update-transaction-check 1 param body → 200400401404429500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are TransactionCheck (6 properties), UpdateTransactionCheckRequest (6 properties), NewTransactionCheckRequestItems (6 properties), AdditionalProperties (4 properties). Each schema is shown below with its type and property counts.

AdditionalPropertiesType
string
The type of the additional property value, for example "string", "number", "boolean", "object", "array".
NewTransactionCheckRequestItems
object
6 properties 4 required
TransactionCheckStatus
string
NewTransactionCheckRequestItemsType
string
The type of monitoring check that is being performed.
GeneralErrorErrorsItems
object
2 properties
UpdateTransactionCheckRequest
object
Transaction monitoring check data to update, referenced by 'checkid'. The 'timestamp' field represents the update time. Only the fields to be updated need to b…
6 properties 2 required
AdditionalProperties
object
Additional metadata that can be added to a payload, such as transaction checks, alerts, and suspicious activities.
4 properties 4 required
TransactionCheck
object
6 properties 2 required
UpdateTransactionCheckRequestType
string
The type of monitoring check that is being performed.
NewTransactionCheckRequestItemsStatus
string
TransactionCheckType
string
The type of monitoring check that is being performed.
Checks_checkTransactionCheck_Response_200
object
4 properties
GeneralError
object
3 properties 2 required
NewTransactionCheckRequest
array
Transaction monitoring check data to add. relatedtxid is optional and can be updated later to associate the monitoring check to a transaction.
UpdateTransactionCheckRequestStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cable-checks-api-openapi.yml Raw ↑

Other APIs Cable publishes across the network.

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