Update eCAF API Login
Objectives
This article outlines the workflows on how to
Apply for eCAF API credentials
Update your eCAF password stored within Paradigm
Â
Complexity: Medium
Page Contents
Assumptions
The User has sufficient security level to access the Paradigm System menu
The User understands the implications of securely handling government credentials
The User knows the difference between their eCAF API credentials and their HEIMS Web Service credentials
Â
Key Concepts
Higher Education providers with Fee-HELP status may wish to use Paradigm to automatically send and retrieve Electronic Commonwealth Assistance Form (eCAF) information from the relevant government systems. This is a convenient way to provide enrolment information to the Department for students who have expressed an interest in accessing a HELP loan / VET Student Loan. The eCAF system facilitates access to HELP loans / VET Student Loan, removing the requirement for paper CAFs or maintenance of in-house eCAFs.
An active eCAF API credential is required for Paradigm to successfully integrate with the government eCAF system. This credential must be stored within Paradigm for the integration to function. Each provider will need to apply for and be granted an eCAF credential by the relevant government body before attempting to use the Paradigm eCAF integration.
It is important to recognise that the eCAF credential is not related to a HEIMS Web Service credential. Even if the username is the same, the two systems are distinct and not connected. The only point of similarity between the eCAF and HEIMS Web Service systems is that they are supported by the same government help desk.
Â
Key Terms
Field name | Brief Overview |
---|---|
eCAF Username: | The username provided by the government |
eCAF Password: | New Password that meets the password policy outlined below |
eCAF Password (repeat): | Type the password a second time to ensure no data entry error has occurred |
ECAF Last Updated | The date that the eCAF password was last updated |
Â
Implications
The password requirements are as follows:
A minimum of 8 characters
At least one numeric character
At least one special character
At least one uppercase character
The password must be different to the previous 10 passwords used
Â
Workflow
Â