Validations

Organization validations API overview

The organization validations API allows integrators to manage validation records for organizations in SCM.

The API supports the following actions:

  • Submitting validation requests
  • Synchronizing validation state with external systems
  • Changing assigned validators
  • Managing external validation assignments
  • Re-submitting validations
  • Resetting or removing existing validation records

Validations API endpoints

The following tables group the validations endpoints by functionality.
Click any action in the first column to open its API reference page.


1. Validation listing & details

ActionMethodPathDescription
List validations for an organizationGET/api/organization/v2/{orgId}/validationsRetrieve all validations associated with the specified organization.
Get validation detailsGET/api/organization/v2/{orgId}/validations/{validationId}Retrieve detailed validation information for a specific validation.

2. Submitting & synchronizing validations

ActionMethodPathDescription
Submit validationPOST/api/organization/v2/{orgId}/validations/submitSubmit organization data for validation.
Synchronize validationPOST/api/organization/v2/{orgId}/validations/{validationId}/syncSynchronize a validation with the external validation backend.

3. Validator assignment

ActionMethodPathDescription
Change a validatorPUT/api/organization/v2/{orgId}/validations/{validationId}/validatorChange the validator assigned to this validation.

4. External validation assignment

ActionMethodPathDescription
Create external validation assignmentPOST/api/organization/v2/{orgId}/validations/assignmentCreate a mapping between this organization and an external validation organization.
Change external validation assignmentPUT/api/organization/v2/{orgId}/validations/assignment/{validationId}Update the assigned external organization's validation.

5. Re-submit & reset validations

ActionMethodPathDescription
Re-submit the validationPUT/api/organization/v2/{orgId}/validations/{validationId}/revalidateRe-submit the validation using orgId and validationId.
Reset and remove the validationDELETE/api/organization/v2/{orgId}/validations/{validationId}Reset the validation state and remove the validation record.