Merchant Boarding API Specification

Merchant Boarding API

application-documents

Manage documents related to enrollment applications

Get Application PDF

get /enroll/application/pdf/key/{externalKey}

This endpoint is used to retrieve a downloadable PDF of an application by external key.

Parameters

externalKey required

string^(?!.*/).*$

Minimum:

Example:

0aa000a-000a-00a0-00a0-00000aa00a0

Example Response

200 Return application PDF.

404 Application not found

422 Invalid input

Get Application Raw PDF

get /enroll/application/pdf-raw/key/{externalKey}

This endpoint is used to retrieve the raw PDF version of an application by external key. The application PDF is returned as a base64 formatted string.

Parameters

externalKey required

string^(?!.*/).*$

Minimum:

Example:

0aa000a-000a-00a0-00a0-00000aa00a0

Example Response

200 Return raw PDF application in base64 encoded string format.

404 Application not found.

422 Invalid input.

Get List of Attached Documents

get /enroll/document/list/key/{externalKey}

This endpoint is used to retrieve a detailed list of all documents attached to an existing merchant application by external key.

Parameters

externalKey required

string^(?!.*/).*$

Minimum:

Example:

0aa000a-000a-00a0-00a0-00000aa00a0

Example Response

200 Returns list of documents attached to an application

404 Application not found

422 Invalid input

Get Details for Specific Document

get /enroll/document/id/{applicationDocumentId}/key/{externalKey}

This endpoint uses the document ID and application external key to retrieve details about a specific document attached to an existing application.

Parameters

applicationDocumentId required

number

Example:

12345

externalKey required

string^(?!.*/).*$

Minimum:

Example:

0aa000a-000a-00a0-00a0-00000aa00a0

Example Response

200 Returns document details

403 Document not accessible error response.

404 Document not found error response.

422 Validation error within the request path.

Delete Document

delete /enroll/document/id/{applicationDocumentId}/key/{externalKey}

This endpoint uses the document ID to delete a specific document that was previously attached to an existing application.

Parameters

applicationDocumentId required

number

Example:

12345

externalKey required

string^(?!.*/).*$

Minimum:

Example:

0aa000a-000a-00a0-00a0-00000aa00a0

Example Response

200 Document deleted successfully

400 Unable to delete document

403 Document not accessible error response.

404 Document not found

422 Invalid input

Attach Document to Application

put /enroll/document/upload/key/{externalKey}

This endpoint is used to attach a new document to an existing application. Valid file extensions include .png, .gif, .jpeg, .jpg, .tiff, and .pdf. Each file may not exceed 6 MB.

Parameters

externalKey required

string^(?!.*/).*$

Minimum:

Example:

0aa000a-000a-00a0-00a0-00000aa00a0

Request Schema

fileName

string

Minimum:

Example:

application-12345.pdf

fileType

string

Minimum:

Example:

MERCHANT APPLICATION

attachment

string

Example:

SGVsbG8gV29ybGQh=

Example Request

validEnrollmentApplicationDocumentRequest

{
  "fileName": "meapi-25024-22.pdf",
  "fileType": "MERCHANT APPLICATION",
  "attachment": "SGVsbG8gV29ybGQh="
}

Example Response

200 New document attached to application

400 Invalid data provided within request object

404 Application not found

415 Unsupported media type response - Invalid content type

422 Invalid input

Get Free Placement Form PDF

get /application/free-placement/pdf/key/{externalKey}

Get a free equipment placement form PDF string buffer by application external key.

Parameters

externalKey required

string^(?!.*/).*$

Minimum:

Example:

00000000-00000000-0000000000-00000000-000000000000

Example Response

200 Return free placement form PDF response.

401 Unauthorized response - Need authorized permission to access the resource.

403 Forbidden response.

404 Application not found error response.

500 Internal Server Error response.

Get Free Placement Form Raw PDF

get /application/free-placement/pdf-raw/key/{externalKey}

Get a free equipment placement form in raw format PDF string buffer by application external key.

Parameters

externalKey required

string^(?!.*/).*$

Minimum:

Example:

00000000-00000000-0000000000-00000000-000000000000

Example Response

200 Return free placement form PDF raw (base64 encoded string format) response.

401 Unauthorized response - Need authorized permission to access the resource.

403 Forbidden response.

404 Application not found error response.

500 Internal Server Error response.