Load financing solution data

Overview

Send financing solution records to the staging area as a JSON stream. Each record must include a unique referenceId in UUID format for tracking and error reporting.

Refer to the Migrate Agreements API for detailed schemas.

Load agreement data to staging

An agreement is a legal contract between a lender and a borrower that defines the loan terms and conditions. Depending on the financing structure, an agreement can include one or more facilities. Refer to Agreements for further details.

To upload agreement data, use the following endpoint:

Request

PUT /financing-solution/migrations/{migration-reference-id}/staging/agreements

Request headers:

Name	Description	Required
Content-Type	Specifies the request body format. Two supported values are application/jsonl and application/json-seq.	Yes
Accept	Include 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 agreement data to upload in the request body. For a complete request body example, see the Stage agreements endpoint in the API schemas.

Response

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

• If a record is valid, the API returns:

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

• If a record is invalid, 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 into the staging area, 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.