light-mode-image
Learn
API Reference

Participant evidence

Upload PDF evidence

Upload PDF evidence

Upload a PDF file as evidence for the given participant. Maximum file size is 10MB.

Analytic events

  • ECOSYSTEM_PARTICIPANT_EVIDENCE_CREATE_START
  • ECOSYSTEM_PARTICIPANT_EVIDENCE_CREATE_SUCCESS
  • ECOSYSTEM_PARTICIPANT_EVIDENCE_CREATE_FAIL
POST/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

Request Body

fileDescription?string
file?file
Formatbinary
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

Download PDF evidence

Retrieves a specific PDF evidence file.

Analytic events

  • ECOSYSTEM_PARTICIPANT_EVIDENCE_DOWNLOAD_START
  • ECOSYSTEM_PARTICIPANT_EVIDENCE_DOWNLOAD_SUCCESS
  • ECOSYSTEM_PARTICIPANT_EVIDENCE_DOWNLOAD_FAIL
GET/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence/{evidenceId}/download

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

participantIdstring

The UUID of the participant

Formatuuid
ecosystemIdstring

The UUID of the ecosystem

Formatuuid
evidenceIdstring

The UUID of the participant evidence

Formatuuid
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

Retrieve all PDF evidence metadata

Retrieve metadata for all PDF evidence uploaded for given participant.

Analytic events

  • ECOSYSTEM_PARTICIPANT_EVIDENCE_RETRIEVE_LIST_START
  • ECOSYSTEM_PARTICIPANT_EVIDENCE_RETRIEVE_LIST_SUCCESS
  • ECOSYSTEM_PARTICIPANT_EVIDENCE_RETRIEVE_LIST_FAIL
GET/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

participantIdstring

The UUID of the participant

Formatuuid
ecosystemIdstring

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.

curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/participants/a24e391a-c27f-4b6e-9805-1ee7e03f3c58/evidence?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"
{
  "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

Retrieve a PDF evidence metadata

Retrieve metadata for a given uploaded PDF evidence.

Analytic events

  • ECOSYSTEM_PARTICIPANT_EVIDENCE_RETRIEVE_START
  • ECOSYSTEM_PARTICIPANT_EVIDENCE_RETRIEVE_SUCCESS
  • ECOSYSTEM_PARTICIPANT_EVIDENCE_RETRIEVE_FAIL
GET/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence/{evidenceId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

participantIdstring

The UUID of the participant

Formatuuid
ecosystemIdstring

The UUID of the ecosystem

Formatuuid
evidenceIdstring

The UUID of the participant evidence

Formatuuid
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

Update PDF evidence metadata

Update metadata for a given uploaded PDF evidence.

Analytic events

  • ECOSYSTEM_PARTICIPANT_EVIDENCE_UPDATE_START
  • ECOSYSTEM_PARTICIPANT_EVIDENCE_UPDATE_SUCCESS
  • ECOSYSTEM_PARTICIPANT_EVIDENCE_UPDATE_FAIL
PUT/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence/{evidenceId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

evidenceIdstring

The UUID of the participant evidence

Formatuuid

Request Body

fileDescription?string
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 PDF evidence

Delete metadata for a given uploaded PDF evidence and remove it from storage.

Analytic events

  • ECOSYSTEM_PARTICIPANT_EVIDENCE_DELETE_START
  • ECOSYSTEM_PARTICIPANT_EVIDENCE_DELETE_SUCCESS
  • ECOSYSTEM_PARTICIPANT_EVIDENCE_DELETE_FAIL
DELETE/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence/{evidenceId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

evidenceIdstring

The UUID of the participant evidence

Formatuuid
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