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 Buyer Documents API

The Buyer Documents API from Opply — 6 operation(s) for buyer documents.

Opply Buyer 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 Buyer Documents. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 6 paths, and defines 11 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.

10 operations 6 paths 11 schemas 1 DELETE6 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 Buyer 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 10

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

Buyer Documents 10
GET
/api/v1/companies/buyer-documents/
List buyer documents
api_v1_companies_buyer_documents_list 7 params → 200
POST
/api/v1/companies/buyer-documents/
Upload buyer document
api_v1_companies_buyer_documents_create body → 201
GET
/api/v1/companies/buyer-documents/{uuid}/
Retrieve buyer document
api_v1_companies_buyer_documents_retrieve 1 param → 200
PUT
/api/v1/companies/buyer-documents/{uuid}/
Update buyer document
api_v1_companies_buyer_documents_update 1 param body → 200
PATCH
/api/v1/companies/buyer-documents/{uuid}/
Partial update buyer document
api_v1_companies_buyer_documents_partial_update 1 param body → 200
DELETE
/api/v1/companies/buyer-documents/{uuid}/
Delete buyer document
api_v1_companies_buyer_documents_destroy 1 param → 204
GET
/api/v1/companies/buyer-documents/types-facet/
List document types present on the buyer's documents
api_v1_companies_buyer_documents_types_facet_list 2 params → 200
GET
/api/v1/companies/buyer-supplier-documents/
List supplier documents for buyer
api_v1_companies_buyer_supplier_documents_list 10 params → 200
GET
/api/v1/companies/buyer-supplier-documents/{uuid}/
Retrieve supplier document (buyer view)
api_v1_companies_buyer_supplier_documents_retrieve 1 param → 200
GET
/api/v1/companies/buyer-supplier-documents/types-facet/
List document types present on supplier documents visible to the buyer
api_v1_companies_buyer_supplier_documents_types_facet_list 2 params → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are BuyerDocument (20 properties), PatchedBuyerDocument (20 properties), SupplierDocument (19 properties), PaginatedBuyerDocumentList (4 properties). Each schema is shown below with its type and property counts.

SupplierSite
object
3 properties 3 required
USStateEnum
string
AL - Alabama AK - Alaska AZ - Arizona AR - Arkansas CA - California CO - Colorado CT - Connecticut DE - Delaware FL - Florida GA - Georgia HI - Hawaii ID - Ida…
BuyerDocument
object
Serializer for BuyerDocument — buyer certification and compliance documents. Handles CRUD with computed status fields, mirroring OpplyDocumentSerializer.
20 properties 9 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…
BlankEnum
PatchedBuyerDocument
object
Serializer for BuyerDocument — buyer certification and compliance documents. Handles CRUD with computed status fields, mirroring OpplyDocumentSerializer.
20 properties
PaginatedSupplierDocumentList
object
4 properties 2 required
DocumentType
object
Shared serializer for the DocumentType taxonomy (buyer, supplier, Opply documents).
3 properties 2 required
SupplierDocument
object
19 properties 11 required
PaginatedBuyerDocumentList
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-buyer-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 Financial Documents API
Opply Buyer Onboarding API
Opply Buyer self-onboarding API
Opply Buyers API
Where this information came from

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