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

Zoca Onboarding API

The onboarding API from Zoca — 17 operation(s) for onboarding.

Zoca Onboarding API is one of 193 APIs that Zoca publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 18 operations across 17 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 3.20.10.

Requests are made against a single base URL, https://api.zoca.ai.

18 operations 17 paths 1 schemas 1 DELETE12 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.20.10
Base URL
https://api.zoca.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Zoca Onboarding API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (access-token).

  • access-token — Enter JWT token in the format Bearer

Paths & Operations 18

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

onboarding 18
GET
/onboarding
Health check for onboarding service
t_value → 200
GET
/onboarding/app-visitor
Register app visitor
t_value → 200
POST
/onboarding/update-user
Update User Profile
t_value body → 200400404
GET
/onboarding/locations/{entity_id}
Get locations for entity
t_value → 200
GET
/onboarding/onboarding-state
Get onboarding state for entity
t_value → 200
GET
/onboarding/user-profile
Get user profile information
t_value → 200
DELETE
/onboarding/clear-user-data
Clear user data (admin only)
t_value → 200
GET
/onboarding/quick-recap
Get onboarding quick recap pointers
t_value → 200
GET
/onboarding/business-categories
Get list of business categories
t_value → 200
GET
/onboarding/customer-sources
Get list of customer sources
t_value → 200
GET
/onboarding/search-booking-link
Search for booking platform link
t_value → 200
GET
/onboarding/search-all-links
Search for all links related to entity
t_value → 200
POST
/onboarding/{entityId}/add-user-for-sm
Add user for social media onboarding
t_value → 200404
GET
/onboarding/check-platform-selection/{locationEntityId}
Check if specific platforms were selected during onboarding within 10 hours
t_value → 200400404
POST
/onboarding/trigger-comms
Trigger onboarding communications for MoEngage notifications
t_value → 200400500
GET
/onboarding/onboarding-record
Get onboarding record by entity ID and version
t_value → 200
PATCH
/onboarding/onboarding-record
Update an app.onboarding record by entity and version
t_value → 200
POST
/onboarding/web-visitor
Create a web visitor onboarding record
t_value → 201

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is e (6 properties). Each schema is shown below with its type and property counts.

e
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoca-onboarding-api-openapi.yml Raw ↑

Other APIs Zoca publishes across the network.

Zoca ACM API
Zoca Acuity API
Zoca Addon Groups API
Zoca Addons API
Zoca Aeo Lead Magnet API
Zoca Agents API
Zoca API Keys API
Zoca App API
Zoca App Blocker API
Zoca App Blocker Updates API
Zoca Approvals API
Zoca Auth API
Where this information came from

This is an independent, third-party profile of Zoca Onboarding 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.