Integration

Authorisation Integration involves establishing an API link with eFileReady. The required steps are as follows:

A1) Sign Up

Create an account on efileready.com

1. Visit https://www.efileready.com/ and click on the 'Sign Up' button.
2. Click on the 'Sign Up Now' button.
3. Sign Up for an Account click on the 'Sign Up Now' button.
4. Enter your personal details, read all the terms and conditions, then click 'Accept' and the 'Sign Up Now' button.
5. An account email verification code will be sent to your provided email. Keep the activation code ready, and click on the 'Account Email Verification' button to continue with your activation.
6. Enter the verification code sent to your email and click 'Accept' and the 'Continue' button.
7. Enter System administrator details and click on the 'Continue' button.
8. Enter your Registered Office Address and click on the 'Continue' button.
9. Enter your Business Address and click on the 'Continue' button.
10. Create a Sign-In Password, select a Security Question, and then click the 'Continue' button.
11. Create a pattern word and click the 'Continue' button.
12. Review all your Sign-In essentials and click the 'Confirm' button.
13. You will see an 'Account Activation Successful' message along with a 'Sign In' button.
    Click on the 'Sign In' button to access your account.

A2) Sign In

Log in to efileready.com and request an API link.

1. Sign in to your account by entering your User Sign-In ID and clicking the 'Continue' button.
2. Enter your Sign-In Password, email, and pattern word, then click the 'Sign In' button.
3. Upon successfully signing into your account, you will see a dashboard page.

A3) Provide Data

Log in to efileready.com to provide the mandatory and desired data.

1. After signing in to efileready.com, click on the 'API/SFTP/CSV/Dropbox Integration Setup' button on the dashboard page to request API onboarding.
2. Click on the 'API Integration Setup' link from the options.
3. Provide all relevant information and click the 'Submit Request' button.
4. You will see an acknowledgment page stating that your request has been sent to the API provider for approval.

A4) Obtain API Link Codes

Log in to efileready.com to obtain your API link codes.

1. After obtaining approval to use our APIs, sign in to efileready and click on 'API Integration Setup.
2. Accept the API User Agreement and click the 'Continue' button.
3. Click the 'API Credentials Details' button to obtain your OpenID client credentials.
4. You will see the OpenID client_id, client_secret, and grant_type values. Use these to invoke our Authorization API to obtain an access token. Then, use that access token along with your business data to subsequently call our business APIs.

A5) Install Link Codes

Input API Link Codes at your Partner System using OpenID Connect.

1. Sign into your partner system
2. Open your OpenID Connect page
3. Enter all the link codes you got from efileready API credential details page
4. A possible Partner OpenID Connect layout page.

A6) Test API Link

Test the API link to ensure it is working correctly.

1. Click on OpenID API Setup link and provide the OpenID credentials you obtained earlier on the below page and click on Test Connection to see if you are able to get access token from our Authorisation API. As you can see when we used a test OpenID client credentials, we got the access token successfully.
2. Click the 'Save' button to temporarily store the client credentials in the session within our API Consumer Demo application. You will see the credentials saved as shown below.
3. Now, you are ready to consume our business APIs. To test if you are able to consume one of our business APIs, set up a client by going to the starting page of our API Consumer Demo application.
4. Click on Partner Client’s Sign Up and provide Partner Client’s Email Id, Mobile Number and VRN number and then click on Save button.
5. You will get an acknowledgement that client details are saved as below.
6. Now, click on the 'Partner Client’s Sign In' button.
7. Click on 'Setup Companies House Credentials' link.
8. Enter all the relevant details and click on the 'Save' button to call our business API
9. On save Companies House Credentials setup status will be shown

A7) Troubleshooting and Updates

Perform any necessary troubleshooting and updates.

1. If you face issues getting an access token, verify the OpenID client credentials.
2. If you face issues invoking the business API, ensure you are invoking from pre-arranged static IPs configured within efileready.

If you need any further assistance, our support team is always ready to help.

eFileReady offers various business APIs tailored to different applications. Each business API is designed to meet specific solution requirements systematically. Please choose the required business API and follow the respective instructions provided.

Example Business APIs:

B1) Setup Companies House Credentials

Use this API for Setting up Companies House Credentials

For the complete list of all business APIs

API Documentation

Conclusion: We hope this guide provides you with a clear understanding of the API integration process with eFileReady. By following the step-by-step instructions and referring to the provided screenshots, you can easily set up and utilise our APIs. If you need any further assistance, our support team is always ready to help. Thank you for choosing eFileReady for your integration needs.