Initiates a citizen merge job

Takes a list of citizens to be merged - secondary into primary.

Please note that you cannot merge records that are already being merged,
or have a previous transaction on a permission option that uses a lawful bases other than consent or legitimate interest
(e.g. contract, legal obligation, public interest or vital interest).
Attempting to merge such records will result in a failure being returned with an appropriate description.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Citizen Merge Batch Request

string
required
length between 1 and 50

The ID associated with the target Application.

mergeDetails
array of objects
required
length between 1 and 1000

Details of citizens to merge

mergeDetails*

Citizen Merge Detail - Only one of citizenId or external ref is required for each citizen. If both are provided they must match the same citizen.

string
required
length between 1 and 50

CitizenId of the citizen to merged INTO

string
required
length between 1 and 100

External reference of the citizen to be merged INTO

string
enum
required

Indicates whether a secondary citizen should be retained after the merge

Allowed:
string
required
length between 1 and 50

CitizenId of the citizen to be merged

string
required
length between 1 and 100

External reference of the citizen to be merged

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json