Overview
This guide covers the Cloudmore API endpoints for managing Microsoft Customer Agreement (MCA) partner attestation.
Use these endpoints when you want to automate the attestation flow — for example, when onboarding customers programmatically and handling MCA acceptance without requiring manual steps in the Cloudmore UI.
For the UI-based attestation workflow, see Manage Microsoft Customer Agreement (5.0).
For authentication and general request structure, see Authentication and Getting started with APIs.
Important: Automatic attestation finalization assumes that you have already collected sufficient evidence of the customer's acceptance. The resulting attestation with Microsoft is recorded as if the customer accessed the agreement link and accepted it directly.
Attestation process stages
Every partner attestation goes through three stages:
-
Create — Generate the attestation object and agreement link.
-
Accept — The designated contact at the customer organization opens the link and accepts, or automatic finalization is used.
-
Finalize — Record the acceptance with Microsoft.
API endpoints
Start partner attestation
Creates the MCA attestation object and generates the agreement link for the customer to accept.
POST /api/resellers/{resellerId}/organizations/{organizationId}/services/csp/mca/attestation
Request body:
{
"signer": {
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"phoneNumber": "string"
},
"language": "string", // Optional. IETF BCP 47 code, e.g. "en-US". Defaults to "en-US".
"country": "string", // ISO 3166-1 alpha-2 country code
"acceptanceDate": "datetime"
}
Success response (HTTP 200):
{
"attestationId": "string",
"agreementLink": "string",
"expiresAt": "datetime"
}
Get partner attestation status
Returns the current status of an ongoing attestation.
GET /api/resellers/{resellerId}/organizations/{organizationId}/services/csp/mca/attestation
Success response (HTTP 200):
{
"attestationId": "string",
"signer": {
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"phoneNumber": "string"
},
"mcaInfo": {
"language": "string",
"country": "string",
"templateId": "string"
},
"acceptanceDate": "datetime",
"status": 0, // 0 = Unspecified, 1 = PendingAgreementAcceptance, 2 = PendingFinalization
"agreementLink": "string",
"expiresAt": "datetime"
}
Returns HTTP 404 if no attestation exists for the customer.
Finalize partner attestation
Finalizes an attestation where the customer has provided acceptance (status = 2).
PUT /api/resellers/{resellerId}/organizations/{organizationId}/services/csp/mca/attestation/finalize
Success response: HTTP 200 OK (no response body)
Get customer acceptance state
Returns whether a customer has accepted the MCA, and via which method.
GET /api/resellers/{resellerId}/organizations/{organizationId}/services/csp/mca/acceptance
Example response (both direct and attested):
{
"accepted": true,
"acceptedVia": ["CustomerDirectAcceptance", "PartnerAttestation"],
"acceptanceViaPartnerAttestation": {
"signer": {
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"phoneNumber": "string"
},
"mcaInfoTemplateId": "string",
"acceptanceDate": "datetime"
},
"lastSyncDate": "datetime"
}
If no acceptance exists, "accepted" is false and "acceptedVia" is an empty array.
Refresh customer acceptance state
Forces a sync with Microsoft to update the stored acceptance state.
POST /api/resellers/{resellerId}/organizations/{organizationId}/services/csp/mca/acceptance/refresh
Success response: HTTP 202 Accepted
Returns HTTP 429 if a sync is already in progress for this customer.
Adding the CSP service with automatic attestation
When onboarding a customer via API, you can create the MCA attestation in the same call that adds the CSP service to the organization. Set automaticFlow: true to have Cloudmore complete the entire attestation process automatically.
POST /api/resellers/{resellerId}/organizations/{organizationId}/services/Csp
Request body:
{
"id": "string",
"currencyCode": "string",
"organizationNumber": "string",
"contactEmail": "string",
"contactFirstName": "string",
"contactLastName": "string",
"contactPhone": "string",
"city": "string",
"address": "string",
"postalCode": "string",
"domainPrefix": "string",
"partnerAttestation": { // Optional
"automaticFlow": true, // Required if partnerAttestation is provided. Must be true.
"signer": {
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"phoneNumber": "string"
},
"language": "string", // Optional. Defaults to "en-US".
"country": "string", // ISO 3166-1 alpha-2
"acceptanceDate": "datetime"
}
}
If partnerAttestation is provided, automaticFlow must be set to true. Manual acceptance is not supported through this combined endpoint.
Manual vs automatic flow
|
Manual |
Automatic |
|
|---|---|---|
|
How acceptance is provided |
Customer opens the agreement link and accepts |
Cloudmore finalizes automatically, no human input required |
|
When to use |
When you want to confirm the customer has personally opened and accepted |
When you have collected acceptance evidence separately and want to minimize steps |
|
Steps |
Start attestation → send link → poll for status = 2 → finalize |
Start attestation with |