Events

Returns the status of current and past reindexing calls

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · min: 1 · max: 100Optional

Responses

200

Successful response

application/json

idstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

timestampstring · date-timeRequiredPattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

statusstring · enumRequiredPossible values:

error_messagestring · nullableRequired

completed_atstring · date-time · nullableRequiredPattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get/events/reindex

HTTPcURLJavaScriptPython

GET /api/events/events/reindex HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2026-07-12T18:45:04.954Z",
    "status": "running",
    "progress": {
      "processed": 1
    },
    "error_message": "text",
    "completed_at": "2026-07-12T18:45:04.954Z"
  }
]

Triggers reindexing of search, workqueues and notifies country config

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

waitForCompletionbooleanOptionalDefault: true

Responses

200

Successful response

application/json

anyOptional

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/events/reindex

HTTPcURLJavaScriptPython

POST /api/events/events/reindex HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "waitForCompletion": true
}

No content

List event configurations

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

Configuration defining an event type registered in OpenCRVS (for example birth or death).

idstringRequired

Machine-readable identifier of the event (e.g. "birth", "death").

dateOfEventany ofOptional

Reference to the field capturing the date of the event (e.g. date of birth). Defaults to the event creation date if unspecified.

or

actionsone of[]Required

Configuration of core and custom actions associated with the event.

or

or

or

or

or

or

or

or

actionOrderstring[]Optional

Order of actions in the action menu. Use either the action type for core actions or the customActionType for custom actions.

analyticsbooleanRequired

Indicates whether the records of this event type are included in analytics

Default: true

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get/config

HTTPcURLJavaScriptPython

GET /api/events/config HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "dateOfEvent": {
      "$$field": "text",
      "$$subfield": [
        "text"
      ],
      "$$code": "text"
    },
    "placeOfEvent": {
      "$$field": "text",
      "$$subfield": [
        "text"
      ],
      "$$code": "text"
    },
    "title": {
      "id": "text",
      "defaultMessage": "text",
      "description": "text"
    },
    "fallbackTitle": {
      "id": "text",
      "defaultMessage": "text",
      "description": "text"
    },
    "summary": {
      "fields": [
        {
          "emptyValueMessage": {
            "id": "text",
            "defaultMessage": "text",
            "description": "text"
          },
          "conditionals": [
            {
              "type": "text",
              "conditional": null
            }
          ],
          "id": "text",
          "value": {
            "id": "text",
            "defaultMessage": "text",
            "description": "text"
          },
          "label": {
            "id": "text",
            "defaultMessage": "text",
            "description": "text"
          }
        }
      ]
    },
    "label": {
      "id": "text",
      "defaultMessage": "text",
      "description": "text"
    },
    "actions": [
      {
        "label": {
          "id": "text",
          "defaultMessage": "text",
          "description": "text"
        },
        "flags": [
          {
            "id": "text",
            "operation": "add",
            "conditional": null
          }
        ],
        "supportingCopy": {
          "id": "text",
          "defaultMessage": "text",
          "description": "text"
        },
        "icon": "text",
        "conditionals": null,
        "type": "text",
        "review": {
          "title": {
            "id": "text",
            "defaultMessage": "text",
            "description": "text"
          },
          "fields": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "actionOrder": [
      "text"
    ],
    "declaration": {
      "label": {
        "id": "text",
        "defaultMessage": "text",
        "description": "text"
      },
      "pages": [
        {
          "id": "text",
          "title": {
            "id": "text",
            "defaultMessage": "text",
            "description": "text"
          },
          "requireCompletionToContinue": false,
          "fields": [
            "[Circular Reference]"
          ],
          "conditional": null,
          "type": "FORM"
        }
      ]
    },
    "advancedSearch": [
      {
        "title": {
          "id": "text",
          "defaultMessage": "text",
          "description": "text"
        },
        "fields": [
          {
            "config": {
              "type": "fuzzy",
              "searchFields": [
                "text"
              ]
            },
            "type": "NAME",
            "label": {
              "id": "text",
              "defaultMessage": "text",
              "description": "text"
            },
            "options": [
              {
                "value": "text",
                "label": "text",
                "conditionals": [
                  {
                    "type": "text",
                    "conditional": null
                  }
                ]
              }
            ],
            "searchCriteriaLabelPrefix": {
              "id": "text",
              "defaultMessage": "text",
              "description": "text"
            },
            "conditionals": [
              {
                "type": "text",
                "conditional": null
              }
            ],
            "validations": [
              {
                "validator": null,
                "message": {
                  "id": "text",
                  "defaultMessage": "text",
                  "description": "text"
                }
              }
            ],
            "allowedLocations": {
              "$jurisdiction": "administrativeArea"
            },
            "fieldId": "text",
            "fieldType": "text"
          }
        ]
      }
    ],
    "flags": [
      {
        "id": "text",
        "requiresAction": true,
        "label": {
          "id": "text",
          "defaultMessage": "text",
          "description": "text"
        }
      }
    ],
    "analytics": true
  }
]

Create event

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

transactionIdstringRequired

typestringRequired

createdAtLocationstring · uuid · nullableOptional

Location where the event occurred. Required for system users.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Responses

200

Successful response

application/json

idstring · uuidRequired

Unique identifier of the event.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

typestringRequired

Type of the event (e.g. birth, death, marriage).

createdAtstring · date-timeRequired

Timestamp indicating when the event was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAtstring · date-timeRequired

Timestamp of the last update, excluding changes from actions.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

trackingIdstringRequired

System-generated tracking identifier used to look up the event.

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/events

HTTPcURLJavaScriptPython

POST /api/events/events HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "transactionId": "text",
  "type": "text",
  "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "createdAt": "2026-07-12T18:45:04.954Z",
  "updatedAt": "2026-07-12T18:45:04.954Z",
  "actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "transactionId": "text",
      "createdByUserType": "user",
      "createdAt": "2026-07-12T18:45:04.954Z",
      "createdBy": "text",
      "createdByRole": "text",
      "createdBySignature": "text",
      "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
      "declaration": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "annotation": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "status": "Requested",
      "originalActionId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "trackingId": "text"
}

Fetch full event document

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

eventIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query parameters

customActionTypestringOptional

waitForbooleanOptional

Whether the action should wait for the event to be indexed before returning. Defaults to true. Setting this to false completes faster but might lead to stale data in the client if the client tries to read the event immediately after performing the action. Use with care.

Default: true

Responses

200

Successful response

application/json

idstring · uuidRequired

Unique identifier of the event.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

typestringRequired

Type of the event (e.g. birth, death, marriage).

createdAtstring · date-timeRequired

Timestamp indicating when the event was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAtstring · date-timeRequired

Timestamp of the last update, excluding changes from actions.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

trackingIdstringRequired

System-generated tracking identifier used to look up the event.

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get/events/{eventId}

HTTPcURLJavaScriptPython

GET /api/events/events/{eventId} HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "createdAt": "2026-07-12T18:45:04.954Z",
  "updatedAt": "2026-07-12T18:45:04.954Z",
  "actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "transactionId": "text",
      "createdByUserType": "user",
      "createdAt": "2026-07-12T18:45:04.954Z",
      "createdBy": "text",
      "createdByRole": "text",
      "createdBySignature": "text",
      "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
      "declaration": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "annotation": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "status": "Requested",
      "originalActionId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "trackingId": "text"
}

Notify an event

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

eventIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

transactionIdstringRequired

originalActionIdstring · uuidOptionalPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

keepAssignmentbooleanOptional

keepAssignmentIfAcceptedbooleanOptional

keepAssignmentIfRejectedbooleanOptional

waitForbooleanOptional

Whether action waits for the indexing before returning. Defaults to true. Setting this to to false completes faster but might lead to stale data in the client if the client tries to read the event immediately after performing the action. Use with care.

Default: true

createdAtLocationstring · uuid · nullableOptional

A valid office location ID. This is required for system users performing actions. The provided location must be a leaf-location, i.e. it must not have any children locations.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

typeconst: NOTIFYOptionalDefault: NOTIFY

Responses

200

Successful response

application/json

idstring · uuidRequired

Unique identifier of the event.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

typestringRequired

Type of the event (e.g. birth, death, marriage).

createdAtstring · date-timeRequired

Timestamp indicating when the event was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAtstring · date-timeRequired

Timestamp of the last update, excluding changes from actions.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

trackingIdstringRequired

System-generated tracking identifier used to look up the event.

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/events/{eventId}/notify

HTTPcURLJavaScriptPython

POST /api/events/events/{eventId}/notify HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 351

{
  "transactionId": "text",
  "declaration": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "annotation": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "originalActionId": "123e4567-e89b-12d3-a456-426614174000",
  "keepAssignment": true,
  "keepAssignmentIfAccepted": true,
  "keepAssignmentIfRejected": true,
  "waitFor": true,
  "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
  "type": "NOTIFY"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "createdAt": "2026-07-12T18:45:04.954Z",
  "updatedAt": "2026-07-12T18:45:04.954Z",
  "actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "transactionId": "text",
      "createdByUserType": "user",
      "createdAt": "2026-07-12T18:45:04.954Z",
      "createdBy": "text",
      "createdByRole": "text",
      "createdBySignature": "text",
      "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
      "declaration": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "annotation": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "status": "Requested",
      "originalActionId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "trackingId": "text"
}

Create an event and immediately notify (single request, system clients only)

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

transactionIdstringRequired

originalActionIdstring · uuidOptionalPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

keepAssignmentbooleanOptional

keepAssignmentIfAcceptedbooleanOptional

keepAssignmentIfRejectedbooleanOptional

waitForbooleanOptional

Whether action waits for the indexing before returning. Defaults to true. Setting this to to false completes faster but might lead to stale data in the client if the client tries to read the event immediately after performing the action. Use with care.

Default: true

createdAtLocationstring · uuidRequired

A valid office location ID. Required. The provided location must be a leaf-location, i.e. it must not have any child locations.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

eventTypestringRequired

Responses

200

Successful response

application/json

idstring · uuidRequired

Unique identifier of the event.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

typestringRequired

Type of the event (e.g. birth, death, marriage).

createdAtstring · date-timeRequired

Timestamp indicating when the event was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAtstring · date-timeRequired

Timestamp of the last update, excluding changes from actions.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

trackingIdstringRequired

System-generated tracking identifier used to look up the event.

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/events/notify

HTTPcURLJavaScriptPython

POST /api/events/events/notify HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 354

{
  "transactionId": "text",
  "declaration": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "annotation": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "originalActionId": "123e4567-e89b-12d3-a456-426614174000",
  "keepAssignment": true,
  "keepAssignmentIfAccepted": true,
  "keepAssignmentIfRejected": true,
  "waitFor": true,
  "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
  "eventType": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "createdAt": "2026-07-12T18:45:04.954Z",
  "updatedAt": "2026-07-12T18:45:04.954Z",
  "actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "transactionId": "text",
      "createdByUserType": "user",
      "createdAt": "2026-07-12T18:45:04.954Z",
      "createdBy": "text",
      "createdByRole": "text",
      "createdBySignature": "text",
      "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
      "declaration": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "annotation": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "status": "Requested",
      "originalActionId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "trackingId": "text"
}

Request correction for an event

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

eventIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

transactionIdstringRequired

originalActionIdstring · uuidOptionalPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

keepAssignmentbooleanOptional

keepAssignmentIfAcceptedbooleanOptional

keepAssignmentIfRejectedbooleanOptional

waitForbooleanOptional

Whether action waits for the indexing before returning. Defaults to true. Setting this to to false completes faster but might lead to stale data in the client if the client tries to read the event immediately after performing the action. Use with care.

Default: true

createdAtLocationstring · uuid · nullableOptional

A valid office location ID. This is required for system users performing actions. The provided location must be a leaf-location, i.e. it must not have any children locations.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

typeconst: REQUEST_CORRECTIONOptionalDefault: REQUEST_CORRECTION

Responses

200

Successful response

application/json

idstring · uuidRequired

Unique identifier of the event.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

typestringRequired

Type of the event (e.g. birth, death, marriage).

createdAtstring · date-timeRequired

Timestamp indicating when the event was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAtstring · date-timeRequired

Timestamp of the last update, excluding changes from actions.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

trackingIdstringRequired

System-generated tracking identifier used to look up the event.

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/events/{eventId}/correction/request

HTTPcURLJavaScriptPython

POST /api/events/events/{eventId}/correction/request HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 363

{
  "transactionId": "text",
  "declaration": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "annotation": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "originalActionId": "123e4567-e89b-12d3-a456-426614174000",
  "keepAssignment": true,
  "keepAssignmentIfAccepted": true,
  "keepAssignmentIfRejected": true,
  "waitFor": true,
  "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
  "type": "REQUEST_CORRECTION"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "createdAt": "2026-07-12T18:45:04.954Z",
  "updatedAt": "2026-07-12T18:45:04.954Z",
  "actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "transactionId": "text",
      "createdByUserType": "user",
      "createdAt": "2026-07-12T18:45:04.954Z",
      "createdBy": "text",
      "createdByRole": "text",
      "createdBySignature": "text",
      "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
      "declaration": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "annotation": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "status": "Requested",
      "originalActionId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "trackingId": "text"
}

Approve correction for an event

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

eventIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

transactionIdstringRequired

originalActionIdstring · uuidOptionalPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

keepAssignmentbooleanOptional

keepAssignmentIfAcceptedbooleanOptional

keepAssignmentIfRejectedbooleanOptional

waitForbooleanOptional

Whether action waits for the indexing before returning. Defaults to true. Setting this to to false completes faster but might lead to stale data in the client if the client tries to read the event immediately after performing the action. Use with care.

Default: true

createdAtLocationstring · uuid · nullableOptional

A valid office location ID. This is required for system users performing actions. The provided location must be a leaf-location, i.e. it must not have any children locations.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

requestIdstringRequired

typeconst: APPROVE_CORRECTIONOptionalDefault: APPROVE_CORRECTION

Responses

200

Successful response

application/json

idstring · uuidRequired

Unique identifier of the event.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

typestringRequired

Type of the event (e.g. birth, death, marriage).

createdAtstring · date-timeRequired

Timestamp indicating when the event was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAtstring · date-timeRequired

Timestamp of the last update, excluding changes from actions.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

trackingIdstringRequired

System-generated tracking identifier used to look up the event.

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/events/{eventId}/correction/approve

HTTPcURLJavaScriptPython

POST /api/events/events/{eventId}/correction/approve HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 421

{
  "transactionId": "text",
  "declaration": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "annotation": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "originalActionId": "123e4567-e89b-12d3-a456-426614174000",
  "keepAssignment": true,
  "keepAssignmentIfAccepted": true,
  "keepAssignmentIfRejected": true,
  "waitFor": true,
  "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
  "requestId": "text",
  "type": "APPROVE_CORRECTION",
  "content": {
    "immediateCorrection": true
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "createdAt": "2026-07-12T18:45:04.954Z",
  "updatedAt": "2026-07-12T18:45:04.954Z",
  "actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "transactionId": "text",
      "createdByUserType": "user",
      "createdAt": "2026-07-12T18:45:04.954Z",
      "createdBy": "text",
      "createdByRole": "text",
      "createdBySignature": "text",
      "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
      "declaration": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "annotation": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "status": "Requested",
      "originalActionId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "trackingId": "text"
}

Reject correction for an event

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

eventIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

transactionIdstringRequired

originalActionIdstring · uuidOptionalPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

keepAssignmentbooleanOptional

keepAssignmentIfAcceptedbooleanOptional

keepAssignmentIfRejectedbooleanOptional

waitForbooleanOptional

Whether action waits for the indexing before returning. Defaults to true. Setting this to to false completes faster but might lead to stale data in the client if the client tries to read the event immediately after performing the action. Use with care.

Default: true

createdAtLocationstring · uuid · nullableOptional

A valid office location ID. This is required for system users performing actions. The provided location must be a leaf-location, i.e. it must not have any children locations.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

requestIdstringRequired

typeconst: REJECT_CORRECTIONOptionalDefault: REJECT_CORRECTION

Responses

200

Successful response

application/json

idstring · uuidRequired

Unique identifier of the event.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

typestringRequired

Type of the event (e.g. birth, death, marriage).

createdAtstring · date-timeRequired

Timestamp indicating when the event was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAtstring · date-timeRequired

Timestamp of the last update, excluding changes from actions.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

trackingIdstringRequired

System-generated tracking identifier used to look up the event.

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/events/{eventId}/correction/reject

HTTPcURLJavaScriptPython

POST /api/events/events/{eventId}/correction/reject HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 409

{
  "transactionId": "text",
  "declaration": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "annotation": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "originalActionId": "123e4567-e89b-12d3-a456-426614174000",
  "keepAssignment": true,
  "keepAssignmentIfAccepted": true,
  "keepAssignmentIfRejected": true,
  "waitFor": true,
  "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
  "requestId": "text",
  "type": "REJECT_CORRECTION",
  "content": {
    "reason": "text"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "createdAt": "2026-07-12T18:45:04.954Z",
  "updatedAt": "2026-07-12T18:45:04.954Z",
  "actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "transactionId": "text",
      "createdByUserType": "user",
      "createdAt": "2026-07-12T18:45:04.954Z",
      "createdBy": "text",
      "createdByRole": "text",
      "createdBySignature": "text",
      "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
      "declaration": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "annotation": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "status": "Requested",
      "originalActionId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "trackingId": "text"
}