API Explorer 1884 endpoints

Partially update activity_verification

PATCH /obp/v7.0.0/banks/ogcr/dynamic-entities/activity_verification/ACTIVITY_VERIFICATION_ID

OBPv7.0.0-dynamicEntity_patchactivity_verification_ogcr Roles: CanUpdateDynamicEntityRecord_activity_verification(per bank) _Activity_verification(ogcr)Dynamic-EntityDynamic

Partially update activity_verification: only the fields supplied in the body are changed; others are preserved.

This is also the write path for field-level write-restricted fields (those declared with write_role_required or an explicit write_role). Authorisation is per field present in the body: a write-restricted field requires that field's write role, and an unrestricted field requires the entity update role. You may change a field if (and only if) you hold the role that governs it; the request is rejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update precondition — holding only a field's write role is sufficient to PATCH that field alone.

This is the initial certification done by the certifier scheme and auditors. This Dynamic Entity is part of OGCR.

Property List:

  • parcel_id: (uu)id of the parcel that gets verified
  • activity_id: ID of the project this parcel belongs to
  • status_code: in_progress, verified, failed
  • status_message: further explanation of status code
  • carbon_storage_temporary_net_carbon_removal_benefit: expected amount of CO2e tonnes removed or reduced
  • supporting_document_id: Supporting documents for activity verification

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"activity_verification"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

</details>

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Example request body
{
  "activity_verification_id": "string",
  "parcel_id": "3dece208-c95c-11f0-9041-54e1adfac5b1",
  "activity_id": "3dece208-c95c-11f0-9041-54e1adfac5b1",
  "status_code": "verified",
  "status_message": "could not find owner",
  "permanent_net_carbon_removal_benefit": 5.5,
  "carbon_farming_temporary_net_carbon_removal_benefit": 5.5,
  "carbon_farming_net_soil_emission_reduction_benefit": 5.5,
  "carbon_storage_temporary_net_carbon_removal_benefit": 6.5,
  "supporting_document_id": "string"
}
Example success response
{
  "bank_id": "ogcr",
  "activity_verification": {
    "activity_verification_id": "string",
    "parcel_id": "3dece208-c95c-11f0-9041-54e1adfac5b1",
    "activity_id": "3dece208-c95c-11f0-9041-54e1adfac5b1",
    "status_code": "verified",
    "status_message": "could not find owner",
    "permanent_net_carbon_removal_benefit": 5.5,
    "carbon_farming_temporary_net_carbon_removal_benefit": 5.5,
    "carbon_farming_net_soil_emission_reduction_benefit": 5.5,
    "carbon_storage_temporary_net_carbon_removal_benefit": 6.5,
    "supporting_document_id": "string"
  },
  "metadata": {
    "created": {
      "at": "2026-09-30T10:12:00Z",
      "user_id": "a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f",
      "on_behalf_of_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
    },
    "updated": {
      "at": "2026-09-30T11:40:00Z",
      "user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "on_behalf_of_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
    }
  }
}
Possible errors (4)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 dynamicEntity_patchactivity_verification_ogcr Originally /banks/ogcr/dynamic-entities/activity_verification/ACTIVITY_VERIFICATION_ID