Fixed

ControlMap API - Vendor contract clarifications


Summary

Risk Assessment creation returns a public assignment detail location, and assessment contact emails are trimmed before validation. Vendor error examples and update guidance clarify the existing request and permission rules. The major version remains v1.


Changes

Changed

  • POST /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/risk-assessments

    • Available → Improved
    • Type: improvement
    • Notes: The 201 response documents a required Location header using the public assignment detail path. Follow it to retrieve the assignment. Contact emails are trimmed before validation; empty names and emails remain invalid. Not-found examples identify the vendor rather than an assignment that has not been created.
  • PATCH /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/risk-assessments/{assessment_link_id}

    • Available → Improved
    • Type: improvement
    • Notes: Contact emails are trimmed before validation. Send metadata, question changes and workflow changes separately. A workflow update may include question_code, which is validated when supplied. Invalid answer errors identify the supplied answer label or code. Success remains 204; use GET for readback.
  • GET /controlmap/v1/clients/{client_id}/vendors/questionnaires

    • Available → Improved
    • Type: improvement
    • Notes: Error descriptions distinguish client or role denial from missing account or user mappings. They no longer refer to an assignment identifier, which this lookup does not accept.
  • DELETE /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/risk-assessments/{assessment_link_id}

    • Available → Improved
    • Type: improvement
    • Notes: The 400 example describes an invalid assignment identifier rather than date validation. Success remains 204 with no body; a missing or already deleted assignment returns 404.
  • GET /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/risk-assessments; GET /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/quick-assessment

    • Available → Improved
    • Type: improvement
    • Notes: Filter guidance now describes the existing behavior accurately: completed selects completed workflow status, while active, future and overdue group incomplete assignments by their dates. expired remains an alias for overdue.
  • GET and PATCH /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/quick-assessment/{assessment_link_id}

    • Available → Improved
    • Type: improvement
    • Notes: Returned answer IDs are informational. PATCH accepts question_code, an answer label and optional notes; empty answers remain invalid. The invalid-answer 400 example names answer, matching the field accepted by this operation.
  • DELETE /controlmap/v1/clients/{client_id}/vendors/{vendor_code}

    • Available → Improved
    • Type: improvement
    • Notes: Documentation clarifies the existing restriction: vendors with source PARTNER cannot be deleted, regardless of tech-stack activity or archived products. Changing their status to Inactive does not remove the restriction.
  • POST /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/documents

    • Available → Improved
    • Type: improvement
    • Notes: Multipart upload documentation includes the existing 413 response with PAYLOAD_TOO_LARGE when the server upload limit is exceeded. Use the signed upload flow for larger files.

Dates

  • Effective: [2026-10-22]