light-mode-image
Learn
API Reference

Participant evidence

Upload PDF evidence

POST/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

participantId*string

The UUID of the participant

Formatuuid
ecosystemId*string

The UUID of the ecosystem

Formatuuid

Request Body

multipart/form-data

fileDescription?string
file?file
Formatbinary

Response Body

application/json

application/json

application/json

curl -X POST "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/participants/a24e391a-c27f-4b6e-9805-1ee7e03f3c58/evidence"
{
  "filename": "pdf-evidence.pdf",
  "fileDescription": "This is an example file description",
  "id": "920f2489-d953-42f2-b2dd-f37c29b818cf",
  "uploadedBy": {
    "clientId": "string",
    "managementUserId": "string"
  },
  "uploadedAt": "2025-07-01T00:00:00.000Z"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Download PDF evidence

GET/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence/{evidenceId}/download

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

participantId*string

The UUID of the participant

Formatuuid
ecosystemId*string

The UUID of the ecosystem

Formatuuid
evidenceId*string

The UUID of the participant evidence

Formatuuid

Response Body

application/pdf

application/json

curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/participants/a24e391a-c27f-4b6e-9805-1ee7e03f3c58/evidence/920f2489-d953-42f2-b2dd-f37c29b818cf/download"
"string"
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve all PDF evidence metadata

GET/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

participantId*string

The UUID of the participant

Formatuuid
ecosystemId*string

The UUID of the ecosystem

Formatuuid

Query Parameters

limit?number

Range size of returned list.

Default100
Range1 <= value <= 1000
cursor?string

Starting point for the list of entries.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/participants/a24e391a-c27f-4b6e-9805-1ee7e03f3c58/evidence"
{
  "data": [
    {
      "filename": "pdf-evidence.pdf",
      "fileDescription": "This is an example file description",
      "id": "920f2489-d953-42f2-b2dd-f37c29b818cf",
      "uploadedBy": {
        "clientId": "string",
        "managementUserId": "string"
      },
      "uploadedAt": "2025-07-01T00:00:00.000Z"
    }
  ],
  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve a PDF evidence metadata

GET/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence/{evidenceId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

participantId*string

The UUID of the participant

Formatuuid
ecosystemId*string

The UUID of the ecosystem

Formatuuid
evidenceId*string

The UUID of the participant evidence

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/participants/a24e391a-c27f-4b6e-9805-1ee7e03f3c58/evidence/920f2489-d953-42f2-b2dd-f37c29b818cf"
{
  "filename": "pdf-evidence.pdf",
  "fileDescription": "This is an example file description",
  "id": "920f2489-d953-42f2-b2dd-f37c29b818cf",
  "uploadedBy": {
    "clientId": "string",
    "managementUserId": "string"
  },
  "uploadedAt": "2025-07-01T00:00:00.000Z"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Update a PDF evidence metadata

PUT/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence/{evidenceId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

participantId*string

The UUID of the participant

Formatuuid
ecosystemId*string

The UUID of the ecosystem

Formatuuid
evidenceId*string

The UUID of the participant evidence

Formatuuid

Request Body

application/json

fileDescription?string

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/participants/a24e391a-c27f-4b6e-9805-1ee7e03f3c58/evidence/920f2489-d953-42f2-b2dd-f37c29b818cf" \  -H "Content-Type: application/json" \  -d '{}'
{
  "filename": "pdf-evidence.pdf",
  "fileDescription": "This is an example file description",
  "id": "920f2489-d953-42f2-b2dd-f37c29b818cf",
  "uploadedBy": {
    "clientId": "string",
    "managementUserId": "string"
  },
  "uploadedAt": "2025-07-01T00:00:00.000Z"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Delete a PDF evidence

DELETE/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence/{evidenceId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

participantId*string

The UUID of the participant

Formatuuid
ecosystemId*string

The UUID of the ecosystem

Formatuuid
evidenceId*string

The UUID of the participant evidence

Formatuuid

Response Body

application/json

application/json

curl -X DELETE "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/participants/a24e391a-c27f-4b6e-9805-1ee7e03f3c58/evidence/920f2489-d953-42f2-b2dd-f37c29b818cf"
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

Participant contacts

Previous Page

Participant validation

Next Page

On this page

Upload PDF evidenceDownload PDF evidenceRetrieve all PDF evidence metadataRetrieve a PDF evidence metadataUpdate a PDF evidence metadataDelete a PDF evidence