Added

ControlMap API - Vendor Management


Summary

Manage client vendors through the API, including contacts, links, documents, assessments, and relationships to risks and action items. Policy-search sections also gain snake_case field names while preserving the legacy fields and their values for backward compatibility. The major version remains v1.


Changes

New endpoints

Vendors

  • POST /controlmap/v1/clients/{client_id}/vendors/search

    • N/A → Available
    • Type: addition
    • Notes: Search vendors with filtering, sorting, and cursor pagination.
  • POST /controlmap/v1/clients/{client_id}/vendors; GET, PATCH, and DELETE /controlmap/v1/clients/{client_id}/vendors/{vendor_code}

    • N/A → Available
    • Type: addition
    • Notes: Create, retrieve, update, and delete client vendors. Vendor details include available lookup options and linked resources. Contact summaries and owner details do not include email or telephone fields.
  • GET and POST /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/contacts; PATCH and DELETE /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/contacts/{contact_id}

    • N/A → Available
    • Type: addition
    • Notes: List, create, update, and delete vendor contacts. Contacts used by assessments cannot be deleted.
  • GET and POST /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/links; DELETE /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/links/{link_id}

    • N/A → Available
    • Type: addition
    • Notes: List, add, and remove named vendor links.
  • GET /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/quick-assessment; GET and PATCH /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/quick-assessment/{assessment_link_id}

    • N/A → Available
    • Type: addition
    • Notes: List Quick Assessment metadata with cursor pagination. Read questions and answers using the assignment ID from the list in the detail URL. Recipients are identified by ID and name, without email or telephone fields. Update an answer with question_code and the answer label from that question's choices; numeric question and answer IDs are not accepted in the PATCH body.
  • GET /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/risk-assessments; GET and PATCH /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/risk-assessments/{assessment_link_id}

    • N/A → Available
    • Type: addition
    • Notes: List assessment metadata with cursor pagination. Retrieve one assignment's questions, or update answers, notes, internal review and workflow status, using its assignment ID in the detail URL. Recipients are identified by ID and name, without email or telephone fields. Select a question with question_code and an answer with its label, or answer_code when labels repeat. Status-only updates do not need a question code.
  • GET and POST /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/documents; DELETE /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/documents/{document_id}

    • N/A → Available
    • Type: addition
    • Notes: List, upload, and delete vendor documents. Download URLs expire after five minutes; retrieve the list again for fresh URLs.
  • POST /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/documents/signed-url and /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/documents/complete-upload

    • N/A → Available
    • Type: addition
    • Notes: Prepare a signed upload, upload the file directly, then complete the upload using the returned token before its completion deadline.
  • POST /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/mappings and /controlmap/v1/clients/{client_id}/vendors/{vendor_code}/mappings/bulk-delete

    • N/A → Available
    • Type: addition
    • Notes: Map and unmap existing client risks and action items using their codes. Links through assessment questions remain unchanged.

Changed

  • POST /controlmap/v1/clients/{client_id}/policies/search
    • Legacy section fields → Legacy fields plus snake_case names
    • Type: addition
    • Notes: Each policy's sections list adds policy_id, section_order, major_version, minor_version, created_at, and updated_at. The legacy policyId, sectionOrder, majorVersion, minorVersion, createdate, and updatedate properties remain available with identical values, so existing consumers can continue using them. The legacy policySections field and timestamps preserve their existing null/omission behavior; sections are returned in the policy's flat sections list.

Dates

  • Effective: [2026-10-13]