Load counterparty data

Overview

Send counterparty records to the staging endpoint as a JSON stream. Each record must include a unique referenceId in UUID format for tracking and error reporting. The system processes the data in batches and returns real-time feedback on success and failure rates.

Refer to the Migrate Counterparties API for detailed schemas.

Load counterparty data to staging

To upload counterparty data, use the following endpoint:

Request

PUT /counterparty-management/migrations/{migration-reference-id}/staging/counterparties

Request headers:

Name	Description	Required
`Content-Type`	Specifies the request body format. Two supported values are `application/jsonl` and `application/json-seq`.	Yes
`Accept`	Specifies the API version. It’s recommended to include an API version in this header to prevent breaking changes. See API versioning for details.	No

It requires one path parameter:

Name	Description	Required
`migration-reference-id`	The migration reference ID obtained from Step 1.	Yes

Provide the data you want to upload in the request body. For example:

{
  "referenceId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "type": "person",
  "isActive": true,
  "initials": "J.D.",
  "firstName": "John",
  "surname": "Doe",
  "nationalities": ["NL"],
  "income": {
    "amount": 50000,
    "currency": "EUR",
    "frequency": "annual"
  },
  "telephoneNumbers": [],
  "externalReferences": [],
  "ratings": [],
  "addresses": [
    {
      "referenceId": "a1b2c3d4-e5f6-1234-5678-9abcdef01234",
      "type": "main",
      "addressLine1": "123 Main Street",
      "postalCode": "12345",
      "locality": "Amsterdam",
      "countryCode": "NL"
    }
  ],
  "relations": [
    {
      "to": "e8f7d6c5-b4a3-9876-5432-1fedcba09876",
      "type": "isSignificantOtherOf"
    }
  ],
  "associatedParties": []
}

Response

The API returns a per-record result for each record submitted in the request body. Each result corresponds to a record, identified by its referenceId, and indicates whether the record was processed successfully.

If a record is valid, it is staged, and the API returns the following response:

{
  "referenceId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "isSuccessful": true,
  "errors": []
}

If a record is invalid, it is not staged. The API returns an error response that describes the issue:

{
  "referenceId": "a1b2c3d4-e5f6-1234-5678-9abcdef01234",
  "isSuccessful": false,
  "errors": [
    {
      "field": "initials",
      "message": "MISSING_REQUIRED_FIELD"
    }
  ]
}

You need to correct these records and re-stage them.

Manage staged data

You can retrieve staged migration data and delete specific staged records by reference ID. For more information, see Manage staged migration data.

Next steps

Once you've loaded your data to staging, you can check the migration status and progress. Refer to Monitor migration and manage jobs.
Proceed to Step 3. Validate data in the staging area to verify your staged data.

Overview​

Load counterparty data to staging​

Request​

Response​

Manage staged data​

Next steps​