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

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

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

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

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

4 operations 1 paths 11 schemas 1 DELETE1 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 person 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 4

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

person 4
GET
/v2/person
Check if a person exists
check-person 2 params → 200401404429500
POST
/v2/person
Add person information
add-person-info 1 param body → 201400401409429500
PUT
/v2/person
Update person in batch
update-persons 1 param body → 200400401404429500
DELETE
/v2/person
Submit a deletion request for a person and any related data
delete-person 1 param body → 200401404429500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Person (25 properties), Address (6 properties), WriteOperationResponse (4 properties), Person_checkPerson_Response_200 (4 properties). Each schema is shown below with its type and property counts.

Person_checkPerson_Response_200
object
4 properties
Address
object
Legal/contact address for the entity
6 properties
GeneralErrorErrorsItems
object
2 properties
PersonAccountStatus
string
The account status for the related person. Refer to the Developer Guide "Entity Account Statuses" to understand what account statuses mean at Cable, and how to…
PersonNationalIdentificationNumber
object
2 properties 2 required
GeneralError
object
3 properties 2 required
NewPersonRequest
array
Person_deletePerson_Response_200
object
2 properties
Person
object
Request body for adding information about persons
25 properties 4 required
WriteOperationResponse
object
4 properties 4 required
UpdatePersonRequest
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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