Collateral

Download Spec

List Collateral

get /collateral

Returns the associated collateral by a given tpp.

API Key ApiKey

X-API-Key found in header

Response

Examples Schema

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"
}

Not found

Empty response

images

array[object (TppCollateralFile)]

required

TppCollateralFile

object (TppCollateralFile)

url

string

required

description

string

required

files

array[object (TppCollateralFile)]

required

TppCollateralFile

object (TppCollateralFile)

url

string

required

description

string

required

description

array[string]

required

string

meta

object (meta)

id

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

No schema

Update Collateral

post /collateral

Updates an collateral

API Key ApiKey

X-API-Key found in header

images

array[object (TppCollateralFile)]

required

TppCollateralFile

object (TppCollateralFile)

url

string

required

description

string

required

files

array[object (TppCollateralFile)]

required

TppCollateralFile

object (TppCollateralFile)

url

string

required

description

string

required

description

array[string]

required

string

meta

object (meta)

Request

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

Response

Examples Schema

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"
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

images

array[object (TppCollateralFile)]

required

TppCollateralFile

object (TppCollateralFile)

url

string

required

description

string

required

files

array[object (TppCollateralFile)]

required

TppCollateralFile

object (TppCollateralFile)

url

string

required

description

string

required

description

array[string]

required

string

meta

object (meta)

id

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Was this page helpful?