
Engineering — 2 min
With the recent migration toward the remote, work-from-anywhere work model, global job listing sites are becoming increasingly popular. But how can your job site or applicant tracking system help employers take the next step of getting job candidates hired and onboarded in their country of residence? Enter the Remote API!
With the Remote API, employers can complete the hiring process for successful candidates in more than 60 countries without leaving your platform. In this blog series, we will provide examples of the different levels of onboarding integrations you can achieve using the Remote API.
This series begins in this post, where we provide instructions for the basic integration that allows employers to kick off employee onboarding with the click of a button in your platform, making the hiring process faster and smoother. Future posts in this series will give you the building blocks to create an even deeper employee onboarding integration.
With that, let’s learn how to launch an integration with the Remote API!
To launch an integration that improves the lives of your customers and requires minimal development effort — or if you just want to gauge customer interest before committing to a deeper integration — we recommend starting with a lightweight approach.
In a lightweight integration with Remote, employers select the candidates they want to hire on your platform. With the click of a button, they are redirected to Remote, where they see the candidate already added to our system and ready to begin the international onboarding process. From here, the employer simply adds some contract details so Remote can generate an employment agreement, inviting the new hire to add their personal details. Remote takes care of the rest to ensure the new hire is compliantly hired in their country, registered for benefits, and set up for payroll.
It’s important to note this lightweight integration has a few prerequisites:
You can build your integration with the Remote API in three easy steps:
Let’s take a closer look at how each step works.
When you sign up as an API partner, Remote will:
Ready to start the journey to becoming an API partner now? Sign up now to learn more!
Remote has implemented an OAuth 2 Authorization Code Flow so our customers can consent to an API integration partner accessing and managing their resources in Remote. When a new user attempts to use your API integration for the first time, they will see what actions the integration can take and will be asked to provide consent. All operations performed through the integration are performed on behalf of the logged-in user.
Remote will work with your team to get the correct consent flow implemented for your integration. Once the consent flow has been implemented, the flow for a new user of the integration will be as follows:
Detailed instructions and code examples for implementing the authorization code flow are available in the Remote API documentation.
When a user in your platform indicates they want to move forward with hiring a candidate, you can send the candidate’s details to Remote and, at the same time, redirect the user to Remote’s platform, where they will see the new hire’s profile and can move the new hire to the next stage of the onboarding flow.
To send the candidate’s details to Remote, send a request to POST /v1/employments with the following required details:
When Remote receives the POST request, a new hire record is created. The new hire appears in Remote’s Onboarding page.
Redirect the user to Remote’s onboarding page so they can finish adding any additional details required by Remote and invite the employee to complete onboarding in Remote. There are two options for handling user logins when redirecting them to the Onboarding page:
That’s it! You now have a delightful integration with Remote that helps your customers achieve their hiring goals faster, regardless of where in the world a candidate is located!
Hopefully this guide sparked new ideas on how you can use the Remote API to solve some of your customers’ top pains. We have only scratched the surface of how the API can be used to build streamlined customer flows. Stay tuned for more in this series, where we’ll be diving deeper into our API capabilities and exploring additional possibilities for building a comprehensive API integration with Remote!
At Remote, we believe in learning together, listening to feedback from our developer community, and continuously making improvements based on the feedback we receive. Our Remote API is now available, so request access to our developer documentation and share your feedback today!
Subscribe to receive the latest
Remote blog posts and updates in your inbox.