Data In

Credit Clear supports the following ways to receive data:

File based integration

Clients can choose to send us data using files. Below are the transfer mechanisms supported for file-based integration. For details about file format and contents, please refer to the the next section

Option 1: Credit Clear SFTP Gateway

With SFTP you have the option to automate the file upload to Credit Clear on your end and securely transmit the file to us.

Client Checklist

• Raise a support ticket with the Credit Clear team to set up the integration with the SFTP Gateway. Provide the following details in the support ticket for us to action:
  • Generate an SSH Private-Public key pair for authentication and provide Credit Clear with the public key.
  • Provide Credit Clear with your outbound IP addresses so we allow SFTP traffic from your servers.
• Once Credit Clear receives the public key, we will set up the SFTP user for the client and provide the username.
• Additionally, you may be required to add Credit Clear’s SFTP FQDN (sft.creditclear.com.au) to your “Allow list.” Please check with your IT/Security teams regarding this step.

📘

For security reasons and to maintain separation between environments, we need to create a separate SFTP user for UAT. This requires the client to generate a separate SSH Private-Public key pair.

Option 2: Web (upload) portal

If you prefer to upload the data files to Credit Clear manually in a secure manner, please follow the steps below.

Client Checklist

• Send an email to [email protected] to initiate the request to setup your account in the web portal. Please include the following in your email
  • Email address to be granted access.
  • Level of access: Whether access is to upload only or both upload and download.
• Once the request is completed on our end, you will receive credentials to login and access the web portal
• Use the URL and the credentials to access the web portal.
• Upload the files using upload option in the appropriate folder.

Credit Clear API Integration

This option is available for advanced clients who are looking to automate the data-in process through API. The API documentation can be found here

Client Checklist

• Refer to the API documentation and follow the steps of integrating their data with Credit Clear.
• Request API access provisioning by contacting the Credit Clear digital team through a support ticket.
• Use the API key and the endpoint URL to transmit data to Credit Clear.

Data Out

Credit Clear supports the following ways to receive data from clients:

Option 1: Credit Clear SFTP Gateway

Clients can receive the return/ reconciliation files or reports through Credit Clear SFTP Gateway.

Option 2: Email

The other option to send the files to the client is via email.

❗️

Note: Sending files via email is not recommend. Any PII information will be not sent via email.

SFTP/ Web portal folder structure

Both SFTP and web portal feature an identical folder structure to enhance consistency and user-friendliness:

• uploads: Clients need to upload their input files and attachments to this folder. Files in this folder are processed by ingest data into Credit Clear.
• downloads: This folder serves as the destination for return files and reports, conveniently accessible through the Credit Clear SFTP gateway or web portal. The client will have permission to download the files from this folder.