Home

Attachment Upload

A guide to integrate client data and upload attachments for invoices and claims

This documentation explains how to upload attachments or supporting documents for your customers to the Credit Clear platform. Attachments are useful when you want to provide additional information or evidence to your customers, such as invoices, receipts, contracts, etc.

Requirements for attachments

Before uploading an attachment, please make sure that it meets the following requirements:

  • The attachment is in PDF format.
  • The attachment does not contain any personally identifiable information (PII) that you do not want your customers to see. You should redact any PII from the file before uploading it.
  • The attachment has a file name that follows the naming convention described below.

File name convention

The file name of the attachment should contain a unique client reference id for the invoice (or claim) that the attachment is related to. The client reference id helps Credit Clear to match the attachment to the correct customer and invoice.

If you have more than one brand and portfolio in the Credit Clear platform, you should also include them in the file name as prefixes. A brand is a name or logo that identifies your company or product, and a portfolio is a group of customers or accounts that share some characteristics.

Each part of the file name (brand, portfolio, and client reference ID) should be separated by an agreed separator, such as a dash (-) or an underscore (__). You should use the same separator throughout the file name.

Here are some examples of file names that follow the convention:

Supports more than one brandSupports more than one portfolioSeparatorExample file name
-$Brand-$Portfolio-$ClientReferenceId.pdf
__$Brand__$ClientReferenceId.pdf
N/A$ClientReferenceId.pdf