Resources

Resources API enables you to create and retrieve files.

The resource object representing a file hosted on TransactionLink's servers. The file may have been uploaded by yourself using the create resource request (for example, when uploading documents) or it may have been created by workflow

POST Create Resource

Create resource

Create a resource

POSThttps://api.transactionlink.io/resources

Body

multipart/form-data

filestring (binary)

Response

201400413415

Resource created

Body

application/json

resourceId*string

resource id

resourceName*string

file name

resourcePath*string

resource path

Request

JavaScriptCurl

const response = await fetch('https://api.transactionlink.io/resources', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "resourceId": "text",
  "resourceName": "text",
  "resourcePath": "text"
}

GET Resource

Get resource

Get a resource

GEThttps://api.transactionlink.io/resources/{resourceId}

Path parameters

resourceId*string (uuid)

UUID of the resource to get

Response

200404

Returns the resource

Body

application/pdf

string (binary)

Request

JavaScriptCurl

const response = await fetch('https://api.transactionlink.io/resources/{resourceId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"binary"