Channel-partner operations API for upGrad's referral and franchise network: partner onboarding and KYC document upload/verification, prospect (lead) capture and status transitions, store and team-member hierarchy management, commission rules, and partner invoice / credit-note reporting. 54 operations across 46 paths, secured by an AUTH-TOKEN API key header. The springdoc-generated OpenAPI is served anonymously at https://partner.upgrad.com/api-docs while every operation itself requires credentials.
This API exposes
54 operations
across 46 paths,
organized into 15 resource areas,
and defines 45 schemas.
It is described by OpenAPI 3.0.1, at version 1.
Requests are made against a single base URL, https://partner.upgrad.com.
54 operations46 paths45 schemas3 DELETE26 GET16 POST9 PUT
Metadata
The identity and technical contract details declared by the specification.
upGrad Partner Service API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as AUTH-TOKEN (AUTH-TOKEN).
By default, every request must be authenticated.
Paths & Operations 54
Across 46 paths, the API surfaces 54 operations — 3 DELETE, 26 GET, 16 POST, 9 PUT. They span 15 resource areas, including partner-controller, prospect-controller, status-controller, partner-invoice-credit-note-controller, team-member-controller, store-controller, commission-rule-controller, login-list-upload-controller, and 7 more. Each is listed below with its method, path, parameters, and response codes.
The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are LearnerInvoiceCreditNoteDto (29 properties), PartnerInvoiceCreditNoteReportDto (25 properties), PartnerDto (25 properties), ProspectDto (20 properties). Each schema is shown below with its type and property counts.
ErrorContext
object
3 properties
UpdatePartnerStageRequestDto
object
5 properties
UpdateRmIdDto
object
2 properties
StoreDto
object
13 properties
CommissionRuleDto
object
15 properties
CommissionRuleSlabDto
object
5 properties
LoginListUploadDto
object
5 properties
DocumentVerifyRequest
object
3 properties
DMSUploadResponse
object
1 property
CoPartnerDto
object
4 properties
DocumentDto
object
8 properties
DocumentResponse
object
3 properties
PartnerBaseDto
object
16 properties3 required
TeamMemberDto
object
19 properties
MemberDto
object
16 properties
TeamMemberResponseDto
object
19 properties
StatusDto
object
3 properties
ProspectDto
object
20 properties
UserDto
object
9 properties
DeleteFormConfigRequest
object
2 properties
AddFormConfigRequest
object
5 properties
AddBusinessTypeRequest
object
3 properties
PartnerDto
object
25 properties3 required
PartnerStageDto
object
7 properties
PartnerStatusSummary
object
4 properties
Pageable
object
3 properties
Predicate
object
PageResponseTeamMemberResponseDto
object
2 properties
PageResponseTeamMemberDto
object
2 properties
StoreFilterDto
object
7 properties
PageResponseResponseStoreDto
object
2 properties
ResponseStoreDto
object
15 properties
PageResponsePartnerDto
object
2 properties
ProspectFilterDto
object
15 properties
PageResponseProspectDto
object
2 properties
PageResponsePartnerInvoiceCreditNoteReportDto
object
2 properties
PartnerInvoiceCreditNoteReportDto
object
25 properties
LearnerInvoiceCreditNoteDto
object
29 properties
PageResponseLearnerInvoiceCreditNoteDto
object
2 properties
InvoiceStatusFlowDto
object
4 properties
UserUploadedEventTempUrlDto
object
1 property
PartnerInvoiceCreditNoteDashboardDto
object
3 properties
FetchFormConfigResponse
object
5 properties
PageResponseCommissionRuleDto
object
2 properties
FetchBusinessTypeResponse
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 upGrad Partner Service 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.
