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

Canopy Connect Whitelabel API

Allows you to create a fully whitelabeled experience

Canopy Connect Whitelabel API is one of 13 APIs that Canopy Connect publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Whitelabel API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

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

Requests are made against a single base URL, https://app.usecanopy.com/api/v1.0.0.

10 operations 10 paths 1 schemas 3 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.usecanopy.com/api/v1.0.0
Authentication
HTTP Basic
License
Resource Areas
1

Authentication & Security 1

Canopy Connect Whitelabel API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BasicAuth — HTTP Basic authentication. Use your Canopy Connect Client ID as the username and your Client Secret as the password. The Authorization header value is Basic .…

Paths & Operations 10

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

Whitelabel API 10

Allows you to create a fully whitelabeled experience

GET
/tos
GET /tos
get-tos → 200
POST
/widget/pull/consentAndConnect
POST /consentAndConnect
post-consent-and-connect body → 200400401404
POST
/widget/pull/consentAndDocuments
POST /consentAndDocuments
post-consent-and-documents body → 200400401404
POST
/widget/pull/{pullId}/connect
POST /connect
post-connect 2 params body → 200400403404
GET
/carriers
GET /carriers
get-carriers 2 params → 200401
GET
/carriers/{carrierId}
GET /carriers/:carrierId
get-carrier 3 params → 200400404
POST
/widget/pull/{pullId}/idv
POST /idv
post-idv 2 params body → 200400403404
POST
/widget/pull/{pullId}/idvoptions
POST /idvoptions
post-idvoptions 2 params body → 200400403404
POST
/widget/pull/reconnectToken
POST /reconnectToken
post-reconnect-token body → 200400403404
POST
/widget/pull/{pullId}/servicingAction
POST /servicingAction
post-servicing-action 2 params body → 200400403404

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

ServicingAction

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canopy-whitelabel-api-api-openapi.yml Raw ↑

Other APIs Canopy Connect publishes across the network.

Canopy Connect Consent API
Canopy Connect Enrichment API
Canopy Connect Misc API
Canopy Connect Monitorings API
Canopy Connect Policy Check Team Setting API
Canopy Connect Policy Forms API
Canopy Connect Policy Search API
Canopy Connect Pulls API
Canopy Connect Servicings API
Canopy Connect Teams API
Canopy Connect Webhooks API
Canopy Connect Widgets API
Where this information came from

This is an independent, third-party profile of Canopy Connect Whitelabel 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.