Kafka Commands | DigitalIdentity API

COMMAND

Get Single Person

Retrieve a single person by ID. Send a Kafka message on topic UIBM_REQS with a KafkaRequestDTO JSON where name = "Person" and value equals the Person ID.

Parameters (KafkaRequestDTO)

Field	Type	Description	Required
id	string	Correlation ID for the request. Used to match responses.	Yes
requestor	string	Identifier (system or user) that is making the request.	Yes
name	string	Command name. For this operation use `"Person"`.	Yes
value	string	Person ID to fetch.	Yes
timestamp	number (epoch ms)	Client-side timestamp when the request is produced.	No

{
  "id": "req-123",
  "requestor": "YourSystem",
  "name": "Person",
  "value": "<PERSON_ID>",
  "timestamp": 0
}

COMMAND

Get All Persons

Retrieve all persons. Send a Kafka message on topic UIBM_REQS with a KafkaRequestDTO JSON where name = "AllPersons" and value is null.

Parameters (KafkaRequestDTO)

Field	Type	Description	Required
id	string	Correlation ID for the request. Used to match responses.	Yes
requestor	string	Identifier (system or user) that is making the request.	Yes
name	string	Command name. For this operation use `"AllPersons"`.	Yes
value	null	Must be `null` for this operation.	No
timestamp	number (epoch ms)	Client-side timestamp when the request is produced.	No

{
  "id": "req-456",
  "requestor": "YourSystem",
  "name": "AllPersons",
  "value": null,
  "timestamp": 0
}

Note:

- Kafka topic consumed by the API: UIBM_REQS.
- Responses are produced on topic: UIBM as JSON KafkaProcessedDTO.