---
title: "Find and update a requirement"
method: PUT
path: "/api/servicecompliancev2/requirements/{identifier}"
tags: ["requirements"]
---

# Find and update a requirement

`PUT /api/servicecompliancev2/requirements/{identifier}`

Partially update one existing requirement

## Path parameters

- `identifier` string, uuid, required

## Request body

- RequirementDtoInput
  - `name` string, required
  - `segmentUuids` string[], required
  - `fulfillmentDocumentTypeUuids` string[], required
  - `status` 'INACTIVE' | 'ACTIVE' | 'ARCHIVED', required
  - `isPapiHireStageOptionType` boolean
  - `multiDocument` boolean
  - `hideFromWorkers` boolean
  - `notifications` object, required
    - `email` boolean, required
    - `sms` boolean, required
    - `admin` object
      - `supervisor` boolean
      - `openingOwner` boolean
      - `adminUserUuids` string[]
  - `type` 'DOCUMENT' | 'BACKGROUND_CHECK'
  - `backgroundCheck` object
    - `provider` 'CHECKR', required
    - `apiKey` string
    - `checkrPackageSlug` string
    - `recollectionDays` integer

## Response `202`

updated requirement.

- object
  - `data` RequirementDto
    - `name` string, required
    - `segmentUuids` string[], required
    - `fulfillmentDocumentTypeUuids` string[], required
    - `status` 'INACTIVE' | 'ACTIVE' | 'ARCHIVED', required
    - `isPapiHireStageOptionType` boolean
    - `multiDocument` boolean
    - `hideFromWorkers` boolean
    - `notifications` object, required
      - `email` boolean, required
      - `sms` boolean, required
      - `admin` object
        - `supervisor` boolean
        - `openingOwner` boolean
        - `adminUserUuids` string[]
    - `type` 'DOCUMENT' | 'BACKGROUND_CHECK'
    - `backgroundCheck` object
      - `provider` 'CHECKR', required
      - `apiKey` string
      - `checkrPackageSlug` string
      - `recollectionDays` integer
    - `uuid` string, required
    - `companyUuid` string, required
    - `customAttributes` object, required
      - `expirationDate` object, required
        - `workerCustomAttributeKey` string, required
        - `workerCustomAttributeUuid` string, required
      - `status` object, required
        - `workerCustomAttributeKey` string, required
        - `workerCustomAttributeUuid` string, required
    - `createdAt` string, date-time, required
    - `createdBy` string, required
    - `updatedAt` string, date-time, required
    - `updatedBy` string, required
  - `meta` ResponsesPartMeta
    - `timestamp` string, date-time, required
    - `verb` 'OPTION' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE'
    - `path` string
    - `jti` string
    - `rid` string
    - `count` number
    - `status` string
    - `duration` number
    - `size` number

## Other responses

- `500` — default error response

---

[API](https://skmtc.net/fountain/apis/hire-public-api.md) · [All operations](https://skmtc.net/fountain/apis/hire-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fountain/hire-public-api/revisions/5f406c0e9462/schema)