Skip to content

Workflows

New organization sign-up

  1. Sign-up a user
  2. Create an organization. The API automatically creates and returns a default team for every organization.
  3. Redirect the user to the just created team
  4. Create a role based on a role template.
    You can add candidates in a single request with the role creation. If you want to add a candidate later, you need to create a ref check.

Candidate invitation handling

When you add a candidate to a role (by role or refcheck creation), the API sends an email notification to the candidate.

The notification contains an auth link with next query param.
An example of the url in the email notification: https://frontend.app/auth/link/{token}/?next=/candidate-dashboard/refchecks/{id}/

The user flow is following:

  1. After handling the auth link with the next param, the candidate will be redirected to a references management page.
    TODO: please, provide a frontend app path of the page to the backend team
  2. Fetch the refcheck with query param ?expand=role (the refcheck id will be passed in the url or selected by the user) and show a list of references that need to be invited (key role.references_required).
    The request example : https://api.nitrohiredev.xyz/v1/refcheks/{id}/?expand=role
  3. Add references to the refcheck.

HR manager cabinet

hr manager cabinet

  1. The user data is returned within successful login response.
  2. That's a list of refchecks
  3. That's a refchecks summary // TODO: add refchecks summary endpoint
  4. You can filter refcehcks and refchecks summary using search, created_at, status (TODO: handling refcheck status in backend), and role query parameters.
  5. In order to invite a candidate, create a refcheck
  6. Create a role
  7. In order to logout, stop sending Authorization header to the backend

Candidate report

Here is a dedicated page available that describes how to get a candidate/refcheck report.

Edit profile

Here is the current user update endpoint

Manage organization/team members

A team admin and owner can manage team members

Provide feedback about a candidate

  1. A reference receives an email invitation
  2. The reference can accept or reject invitation // TODO: add swagger links to the endpoints
  3. Refer to the questionnaires guide to learn how to work with questions and answers for accepted invitations