v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 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": [
    {
      "requirement_id": "53970723-fbff-4f46-a975-f62be6c1a585",
      "field_value": "new requirement value"
    }
  ]
}

Response

Updated requirement group

idstring
country_codestring
phone_number_typestring
status'approved' | 'unapproved' | 'pending-approval' | 'declined' | 'expired'
actionstring
customer_referencestring
created_atstring date-time
updated_atstring date-time
record_typestring

Example response

{
  "record_type": "requirement_group"
}