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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Opply

Opply Buyer Onboarding API

The Buyer Onboarding API from Opply — 21 operation(s) for buyer onboarding.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 21 operations across 21 paths, and defines 39 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.

21 operations 21 paths 39 schemas 13 GET2 PATCH6 POST

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 Onboarding 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 21

Across 21 paths, the API surfaces 21 operations — 13 GET, 2 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Buyer Onboarding 21
GET
/api/v1/buyer-onboarding/merchant-of-record/buyers/
List all onboarding buyers
api_v1_buyer_onboarding_merchant_of_record_buyers_list 4 params → 200403
GET
/api/v1/buyer-onboarding/merchant-of-record/buyers/{uuid}/
Get buyer onboarding details
api_v1_buyer_onboarding_merchant_of_record_buyers_retrieve 1 param → 200403404
GET
/api/v1/buyer-onboarding/merchant-of-record/buyers/{uuid}/account-details/
Get buyer account details
api_v1_buyer_onboarding_merchant_of_record_buyers_account_details_retrieve 1 param → 200403404
GET
/api/v1/buyer-onboarding/merchant-of-record/buyers/{uuid}/delivery-addresses/
Get buyer delivery addresses
api_v1_buyer_onboarding_merchant_of_record_buyers_delivery_addresses_list 3 params → 200403404
GET
/api/v1/buyer-onboarding/merchant-of-record/buyers/{uuid}/delivery-details/
Get buyer delivery details
api_v1_buyer_onboarding_merchant_of_record_buyers_delivery_details_retrieve 1 param → 200403404
GET
/api/v1/buyer-onboarding/merchant-of-record/buyers/{uuid}/delivery-emails/
Get buyer delivery emails
api_v1_buyer_onboarding_merchant_of_record_buyers_delivery_emails_list 3 params → 200403404
GET
/api/v1/buyer-onboarding/merchant-of-record/buyers/{uuid}/documents/
Get buyer documents
api_v1_buyer_onboarding_merchant_of_record_buyers_documents_list 3 params → 200403404
GET
/api/v1/buyer-onboarding/merchant-of-record/buyers/{uuid}/steps/
List buyer onboarding steps
api_v1_buyer_onboarding_merchant_of_record_buyers_steps_list 5 params → 200403404
GET
/api/v1/buyer-onboarding/merchant-of-record/buyers/{uuid}/steps/{step_id}/
Get buyer onboarding step
api_v1_buyer_onboarding_merchant_of_record_buyers_steps_retrieve 2 params → 200403404
PATCH
/api/v1/buyer-onboarding/merchant-of-record/buyers/{uuid}/steps/{step_id}/update/
Update buyer onboarding step
api_v1_buyer_onboarding_merchant_of_record_buyers_steps_update_partial_update 2 params body → 200400403404
GET
/api/v1/buyer-onboarding/merchant-of-record/buyers/{uuid}/suppliers/
List buyer suppliers
api_v1_buyer_onboarding_merchant_of_record_buyers_suppliers_list 3 params → 200403404
PATCH
/api/v1/buyer-onboarding/merchant-of-record/buyers/{uuid}/update/
Update buyer onboarding
api_v1_buyer_onboarding_merchant_of_record_buyers_update_partial_update 1 param body → 200400403404
POST
/api/v1/buyer-onboarding/merchant-of-record/buyers/generate-link/
Generate buyer onboarding link (legacy)
api_v1_buyer_onboarding_merchant_of_record_buyers_generate_link_create body → 201400403
POST
/api/v1/buyer-onboarding/merchant-of-record/buyers/invite/
Invite a buyer to onboard
api_v1_buyer_onboarding_merchant_of_record_buyers_invite_create body → 201400403
GET
/api/v1/buyer-onboarding/merchant-of-record/supplier-submissions/
List buyer-submitted supplier rows pending MoR review.
api_v1_buyer_onboarding_merchant_of_record_supplier_submissions_list 5 params → 200
GET
/api/v1/buyer-onboarding/merchant-of-record/supplier-submissions/{id}/
Retrieve a single supplier submission.
api_v1_buyer_onboarding_merchant_of_record_supplier_submissions_retrieve 1 param → 200
POST
/api/v1/buyer-onboarding/merchant-of-record/supplier-submissions/{id}/match/
Match this submission to an existing supplier company.
api_v1_buyer_onboarding_merchant_of_record_supplier_submissions_match_create 1 param body → 200
GET
/api/v1/buyer-onboarding/merchant-of-record/supplier-submissions/{id}/match-candidates/
Search existing supplier companies as match candidates. Use the returned uuid as companyuuid on the match action.
api_v1_buyer_onboarding_merchant_of_record_supplier_submissions_match_candidates_list 4 params → 200
POST
/api/v1/buyer-onboarding/merchant-of-record/supplier-submissions/{id}/onboard/
Promote this submission to the OnboardingSupplier pipeline. Creates an OnboardingSupplier row that MoR staff can then progress via the existing /mor/onboarding-suppliers/ surface.
api_v1_buyer_onboarding_merchant_of_record_supplier_submissions_onboard_create 1 param → 200
POST
/api/v1/buyer-onboarding/merchant-of-record/supplier-submissions/{id}/reject/
Reject a supplier submission with an operator-supplied reason.
api_v1_buyer_onboarding_merchant_of_record_supplier_submissions_reject_create 1 param body → 200
POST
/api/v1/buyer-onboarding/merchant-of-record/supplier-submissions/{id}/reset/
Reset a previously reviewed submission back to pending.
api_v1_buyer_onboarding_merchant_of_record_supplier_submissions_reset_create 1 param → 200

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are MoRSupplierSubmission (36 properties), BuyerOnboardingDeliveryAddress (30 properties), BuyerOnboardingDetail (19 properties), PatchedBuyerOnboardingDetail (19 properties). Each schema is shown below with its type and property counts.

PaginatedBuyerOnboardingListList
object
4 properties 2 required
BuyerOnboardingDocument
object
Serializer for BuyerOnboardingDocument model.
6 properties 5 required
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…
PriorityEnum
string
high - High medium - Medium low - Low
PaginatedBuyerOnboardingDocumentList
object
4 properties 2 required
PaginatedMoRSupplierSubmissionList
object
4 properties 2 required
PatchedBuyerOnboardingStep
object
Serializer for buyer onboarding step with template information.
15 properties
PatchedBuyerOnboardingDetail
object
Detailed serializer for buyer onboarding. Includes all related information. For self-onboarded buyers (buyeronboarding.company is set), the name / email fields…
19 properties
BuyerOnboardingStep
object
Serializer for buyer onboarding step with template information.
15 properties 11 required
NullEnum
PhoneCountryCodeEnum
string
+376 - +376 +971 - +971 +93 - +93 +1268 - +1268 +1264 - +1264 +355 - +355 +374 - +374 +244 - +244 +672 - +672 +54 - +54 +1684 - +1684 +43 - +43 +61 - +61 +297…
MoRSupplierMatchCandidate
object
Shape of a single match candidate (existing supplier Company).
5 properties 5 required
AccountDetail
object
Serializer for account details with country-specific validation. Supports DUNS field and AccountEmail management. UK buyers require: companyname, vatnumber, co…
13 properties 9 required
PaginatedSupplierList
object
4 properties 2 required
CountryTypeEnum
string
EU - Eu GB - Gb Other - Other
DeliveryEmail
object
Serializer for DeliveryEmail model.
5 properties 5 required
InviteBuyerResponse
object
Response shape for the new invite endpoint. No link field — the buyer is invited via the commit-onboarding email and enters the app authenticated.
5 properties 5 required
BuyerOnboardingLinkResponse
object
Response serializer for the legacy generate-link endpoint. Includes the UUID-based shareable onboarding URL.
6 properties 6 required
DeliveryLocationTypeEnum
string
warehouse - Warehouse factory - Factory distributioncenter - Distribution Center retaillocation - Retail Location other - Other
AddressTypeEnum
string
billingaddress - Billing address deliveryaddress - Delivery address dispatchaddress - Dispatch address companyaddress - Company address
BuyerOnboardingCountry
string
us - United States uk - United Kingdom
MoRSupplierMatch
object
Payload for POST .../supplier-submissions/{id}/match/. The candidate Company is constrained to suppliers scoped to the calling MoR (merchantofrecord=context['m…
1 property 1 required
PaginatedMoRSupplierMatchCandidateList
object
4 properties 2 required
BuyerOnboardingDetail
object
Detailed serializer for buyer onboarding. Includes all related information. For self-onboarded buyers (buyeronboarding.company is set), the name / email fields…
19 properties 18 required
DeliveryDetails
object
Serializer for delivery details.
15 properties 5 required
GenerateBuyerLink
object
Legacy serializer: creates a BuyerOnboarding row and returns a UUID-based shareable link the MoR can hand to the buyer. Used by the pre-isBuyerInvitationFlowEn…
3 properties 3 required
PaginatedBuyerOnboardingStepList
object
4 properties 2 required
AccessRequirementsEnum
string
deliveryappointment - Delivery appointment requirement insidedelivery - Inside delivery Required liftgate - Lift gate required
PaginatedDeliveryEmailList
object
4 properties 2 required
MoRSupplierSubmission
object
MoR-side read of a buyer's buyeronboarding.Supplier submission. Adds buyer context (company + contact) and review-pipeline pointers so an operator can decide w…
36 properties 36 required
BlankEnum
BuyerOnboardingDeliveryAddress
object
Serializer for BuyerOnboardingDeliveryAddress model. Includes all BaseAddress fields plus delivery-specific fields.
30 properties 5 required
BuyerOnboardingList
object
Serializer for listing buyer onboardings. Includes summary information about steps and submission status. For self-onboarded buyers (buyeronboarding.company is…
13 properties 11 required
MoRSupplierReject
object
Payload for POST .../supplier-submissions/{id}/reject/.
1 property 1 required
InviteBuyer
object
Serializer for inviting a buyer through the new MoR onboarding flow (feature flag isBuyerInvitationFlowEnabled on). Required fields: - name: Buyer's trading na…
12 properties 3 required
Supplier
object
Serializer for supplier information. Only includes fields that are actively used in the public buyer onboarding form. Other model fields are kept for backward…
15 properties 5 required
PaginatedBuyerOnboardingDeliveryAddressList
object
4 properties 2 required
AccountEmail
object
Serializer for AccountEmail model.
5 properties 5 required
SupplierReviewStatusEnum
string
pendingreview - Pending review matched - Matched to existing supplier onboarding - Onboarding new supplier rejected - Rejected

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-buyer-onboarding-api-openapi.yml Raw ↑

Other APIs Opply publishes across the network.

Opply Activity Feed API
AE Profile APIs.io
Opply Admin panel API
AE Profile APIs.io
Opply Agents API
AE Profile APIs.io
Opply Agreements API
AE Profile APIs.io
Opply api API
AE Profile APIs.io
Opply App Orders API
AE Profile APIs.io
Opply Brain API
AE Profile APIs.io
Opply Brands API
AE Profile APIs.io
Opply Buyer Documents API
AE Profile APIs.io
Opply Buyer Financial Documents API
AE Profile APIs.io
Opply Buyer self-onboarding API
AE Profile APIs.io
Opply Buyers API
AE Profile APIs.io
#Buyer Onboarding
← Back to O APIs
API Details
ID
opply:opply-buyer-onboarding-api
Base URL
https://api.opply.com
Docs
https://opply.com/
Provider
Opply
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=opply-buyer-onboarding-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/opply-buyer-onboarding-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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