Collateral

Download Spec

List Collateral

get /collateral

Returns the associated collateral by a given tpp.

API Key ApiKey

Returns the associated collateral by a given tpp.

X-API-Key found in header

Response

ExamplesSchema

Successful Response

{
  "images": [
    {
      "url": "string",
      "description": "string"
    }
  ],
  "files": [
    {
      "url": "string",
      "description": "string"
    }
  ],
  "description": [
    "string"
  ],
  "meta": {},
  "id": "string",
  "tpp_id": "string",
  "created": "2023-06-07T17:32:28Z",
  "updated": "2023-06-07T17:32:28Z"
}

Update Collateral

post /collateral

Updates an collateral

images

array[object (TppCollateralFile)]

required

files

array[object (TppCollateralFile)]

required

description

array[string]

required

Request

{
  "images": [
    {
      "url": "string",
      "description": "string"
    }
  ],
  "files": [
    {
      "url": "string",
      "description": "string"
    }
  ],
  "description": [
    "string"
  ],
  "meta": {}
}

Response

ExamplesSchema

Successful Response

{
  "images": [
    {
      "url": "string",
      "description": "string"
    }
  ],
  "files": [
    {
      "url": "string",
      "description": "string"
    }
  ],
  "description": [
    "string"
  ],
  "meta": {},
  "id": "string",
  "tpp_id": "string",
  "created": "2023-06-07T17:32:28Z",
  "updated": "2023-06-07T17:32:28Z"
}