API docs by Redocly

Matchio File-service App API (1.0)

Download OpenAPI specification:Download

File service public API

Get health check

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "version": "unknown"
}

File service backend private API

Get JWT token

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
documentSlotPublicId
string
documentPublicId
string

if we need to attach files to a specific document, new document will be created if not provided

pathPrefix
required
string

path prefix for the files, should be provided by Matchio

userId
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "documentSlotPublicId": "string",
  • "documentPublicId": "string",
  • "pathPrefix": "string",
  • "userId": "string",
  • "documentTemplate": {
    }
}

Response samples

Content type
application/json
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkb2NUeXBlIjoicGl6emFkYXkiLCJhaWQiOiJwaXp6YWRheSIsImlhdCI6MTcxMzE5NTI1MCwiZXhwIjoxNzEzMTk4ODUwfQ.NosVCVir9ShJ1SPKiAss7nMNGCSCtQGs3oaZR3CzBLU"
}

Get multiple upload URLs

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
documentSlotPublicId
string
documentPublicId
string

if we need to attach files to a specific document, new document will be created if not provided

pathPrefix
string

path prefix for the files, should be provided by Matchio

userId
string
object
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "documentSlotPublicId": "string",
  • "documentPublicId": "string",
  • "pathPrefix": "string",
  • "userId": "string",
  • "documentTemplate": {
    },
  • "fileOptions": [
    ]
}

Response samples

Content type
application/json
{
  • "urls": [
    ]
}

Get multiple download URLs

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "files": [
    ]
}

Remove files

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "deletedRecords": [
    ]
}

Merge files

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
required
Array of objects
mergedFilePath
required
string
mergedFileName
required
string
object

Responses

Request samples

Content type
application/json
{
  • "files": [
    ],
  • "mergedFilePath": "string",
  • "mergedFileName": "string",
  • "pdfConfigurationOptions": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "mergedFilePath": "string"
}

Fill PDF with formatted text

Adds multi-line formatted text to a PDF document with support for custom positioning, fonts, colors, line spacing, and paragraph spacing

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
filePath
required
string

S3 path to the source PDF file

outputFilePath
required
string

S3 path where the filled PDF should be saved

text
required
string

Multi-line text to add to the PDF. Use \n for line breaks, empty lines create paragraph spacing.

required
object

Text formatting options for positioning and styling

Responses

Request samples

Content type
application/json
{
  • "filePath": "documents/original.pdf",
  • "outputFilePath": "documents/filled.pdf",
  • "text": "Dear U.S. Official,\n\nThis letter confirms that John Doe has been accepted to the J-1 Camp Counselor Exchange Visitor Program.\n\nWe thank you for your time.\n\nSincerely,\n",
  • "textOptions": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "filePath": "documents/filled.pdf",
  • "fileSize": 245678
}

File service frontend public API

Get form configuration

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "maxFilesCount": 0,
  • "allowedFilesMimeTypes": [
    ],
  • "maxFileSize": 0,
  • "fileExtensionsMessage": "string",
  • "allowDescription": true,
  • "allowExpirationDate": true,
  • "crop": {
    }
}

File service frontend private API

Get multiple upload URLs

Authorizations:
bearerAuth
Request Body schema: application/json
required
documentSlotPublicId
string
documentPublicId
string

if we need to attach files to a specific document, new document will be created if not provided

pathPrefix
string

path prefix for the files, should be provided by Matchio

userId
string
object
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "documentSlotPublicId": "string",
  • "documentPublicId": "string",
  • "pathPrefix": "string",
  • "userId": "string",
  • "documentTemplate": {
    },
  • "fileOptions": [
    ]
}

Response samples

Content type
application/json
{
  • "urls": [
    ]
}

Save multiple Salesforce records

Authorizations:
bearerAuth
Request Body schema: application/json
required
expirationDate
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "expirationDate": "string",
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "created": [
    ],
  • "ommited": [
    ]
}