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

Opply Opply Documents API

The Opply Documents API from Opply — 7 operation(s) for opply documents.

Opply Opply Documents API is one of 47 APIs that Opply publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 11 operations across 7 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 0.0.0.

Requests are made against the base URL https://api.opply.com.

11 operations 7 paths 8 schemas 1 DELETE7 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.0.0
Base URL
https://api.opply.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Opply Opply Documents API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Authorization (tokenAuth).

  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 11

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

Opply Documents 11
GET
/api/v1/companies/opply-document-types/
List Opply document types
api_v1_companies_opply_document_types_list → 200
GET
/api/v1/companies/opply-document-types/{uuid}/
Retrieve Opply document type
api_v1_companies_opply_document_types_retrieve 1 param → 200
GET
/api/v1/companies/opply-documents/
List Opply documents (MoR)
api_v1_companies_opply_documents_list 4 params → 200
POST
/api/v1/companies/opply-documents/
Create Opply document
api_v1_companies_opply_documents_create body → 201
GET
/api/v1/companies/opply-documents-buyer/
List Opply documents (Buyer)
api_v1_companies_opply_documents_buyer_list 7 params → 200
GET
/api/v1/companies/opply-documents-buyer/{uuid}/
Retrieve Opply document (Buyer)
api_v1_companies_opply_documents_buyer_retrieve 1 param → 200
GET
/api/v1/companies/opply-documents-buyer/types-facet/
List document types present on Opply documents visible to the buyer
api_v1_companies_opply_documents_buyer_types_facet_list 2 params → 200
GET
/api/v1/companies/opply-documents/{uuid}/
Retrieve Opply document (MoR)
api_v1_companies_opply_documents_retrieve 1 param → 200
PUT
/api/v1/companies/opply-documents/{uuid}/
Update Opply document
api_v1_companies_opply_documents_update 1 param body → 200
PATCH
/api/v1/companies/opply-documents/{uuid}/
Partial update Opply document
api_v1_companies_opply_documents_partial_update 1 param body → 200
DELETE
/api/v1/companies/opply-documents/{uuid}/
Delete Opply document
api_v1_companies_opply_documents_destroy 1 param → 204

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are OpplyDocument (15 properties), PatchedOpplyDocument (15 properties), OpplyDocumentBuyer (9 properties), PaginatedOpplyDocumentBuyerList (4 properties). Each schema is shown below with its type and property counts.

PaginatedOpplyDocumentList
object
4 properties 2 required
DocumentLifecycleStatusEnum
string
valid - Valid expired - Expired expiringsoon - Expiring Soon renewed - Renewed
Country
string
AF - Afghanistan AX - Åland Islands AL - Albania DZ - Algeria AS - American Samoa AD - Andorra AO - Angola AI - Anguilla AQ - Antarctica AG - Antigua and Barbu…
OpplyDocumentBuyer
object
Read-only serializer for buyers viewing Opply documents. Returns all documents (including archived) with computed status.
9 properties 9 required
OpplyDocument
object
Serializer for OpplyDocument - for MoR users. Handles CRUD operations with computed status fields.
15 properties 10 required
DocumentType
object
Shared serializer for the DocumentType taxonomy (buyer, supplier, Opply documents).
3 properties 2 required
PatchedOpplyDocument
object
Serializer for OpplyDocument - for MoR users. Handles CRUD operations with computed status fields.
15 properties
PaginatedOpplyDocumentBuyerList
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-opply-documents-api-openapi.yml Raw ↑

Other APIs Opply publishes across the network.

Opply Activity Feed API
Opply Admin panel API
Opply Agents API
Opply Agreements API
Opply api API
Opply App Orders API
Opply Brain API
Opply Brands API
Opply Buyer Documents API
Opply Buyer Financial Documents API
Opply Buyer Onboarding API
Opply Buyer self-onboarding API
Where this information came from

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