v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Requirement Groups

Update requirement values in requirement group

patch/requirement_groups/{id}

Path parameters

idstring required

ID of the requirement group

Request body

customer_referencestring

Reference for the customer

Example request

{
  "customer_reference": "0002",
  "regulatory_requirements": [
    {
      "field_value": "new requirement value",
      "requirement_id": "53970723-fbff-4f46-a975-f62be6c1a585"
    }
  ]
}

Response

Updated requirement group

actionstring

country_codestring

created_atstring date-time

customer_referencestring

idstring

phone_number_typestring

record_typestring

status'approved' | 'unapproved' | 'pending-approval' | 'declined' | 'expired'

updated_atstring date-time

Example response

{
  "record_type": "requirement_group"
}