Change Log

• 25 Oct 2024 Sharad. Created

Veremark Features

Updated - 23-02-2026 by Ahsan

• Api for create person, attachments and more info
• Super manager that can manage multiple companies in hr

Basic API Workflow

The purpose of this api to create persons and order checks for them.

You can find out checks you can order by logging in to HR portal and navigate to company info page.

Login with api key, this will return token which will be used for all subsequent api calls.

Login with API key

1. Call the login api, which expects the api key in headers

2. In body pass company shortName in which future operations will be performed

3. If login is successful, you will receive an authorization token. This token you will pass to all future request which required authentication

Creating a person

You will need to pass authorization token for this request

1. Call create person api. You will be required to pass fullName, clientReferenceId and email.

2. This will return an personId.

Order background checks for person

You will need to pass authorization token for this request

1. Call the add check api to which you need to pass the personId and shortName of the check you want to add.

2. Most checks require supporting information before they can be performed. You can pass this information either through this api or later through HR ui.

3. This will create an order for person containing this check, if an not started order already exists then this check will be added to that order.

4. It will return checkId which was created on your behalf. You will use this orderCheckId to add supporting documents for this check.

Add attachment to check

You will need to pass authorization token for this request

1. Call the add attachment api to which you need to pass the orderCheckId, checkShortName, attachmentShortName, contentType, fileName and optionally you can pass the fileCaption.

2. This will generate an url to which you can upload your attachment.

Status Report Management Workflow

• Admin can create a report which include all completed checks.

• Admin can create additional reports, the additional reports contains checks completed after the last report was created.

• Admin can create consolidated report containing all the completed checks.

• Admin can optionally add in progress checks to the report.

• Admin can choose which check and package should be included in the report. And also can include checks in another report for already reported checks.

Cashfree Verification Services Workflow

PAN Verification service

1. Enter the PAN number after the payment is made in passport check.
2. We request cashfree service, it verifies and then returns the result with details.

Passport Verification Service

1. Enter the file number and date of birth after the payment is made in passport check.
2. We request cashfree service, it verifies and then returns the result with details.

UAN Verification Service

1. Enter the UAN number after the payment is made in passport check.
2. We request cashfree service, it verifies and then returns the result with details.

Payment link workflow

B2C

only support order level payment

1. Order is added to the cart and created by the customer.
2. Before work can begin for the order the customer must pay for the order if person does not belong to the postpaid company.
3. It takes you the cashfree payment gateway which handles the payment process.
4. When payment successfully paid by the customer it will redirect to our portal.
5. Our portal updates the database to indicate that the payment has been made.
6. After the payment is made due date is automatically set for the checks in order.
7. Due date column is showing when the payment is made.
8. A mail is sent to customer and all administrators and if assigned then sent to team member as well. (TODO: AHSAN 26-03-2025).
9. This check will be visible in the quick link Paid but not started. (Done: TARUN 26-03-2025).

Admin

Support single order and person level(multiple orders) payment

1. Admin can send payment link to the customer with CC and BCC options.
2. Admin can send multiple payment links to the customer.
3. If payment is less than order value, we treat it as partial payment. person can pay rest amount later.
4. We support overpayment, if customer pay more than the order value we treat it as overpayment and display as Person balance
5. we do not refund overpayment to customer, instead we keep record of overpayment in our DB.

Modify an existing order Workflow

Any order can be modified after it has been created subject to following restrictions

• Completed orders can not be modified. Completed order means all checks in the order have been completed

• Checks on which work has started can not be removed from a order

Even paid orders can be modified as long as all checks are not completed. If checks are added to the paid order, order will require more payment. If checks are removed from the order, then excess paid amount will become advance payment.

Person Credits - Making advance payments

Advance payment is credited to a person

• making advance payment for specific person using the UI (Not implemented)

• when you remove checks from an existing paid order then excess amount become advance payment

• displaying millow credits history

Consuming advance payment

• Refund advance amount to the person (Not implemented)

• When admin send a payment link, advance amount can be optionally applied to future purchases

• when a candidate chooses to pay for an order, we reduce the amount to pay by amount of credits available

OCR

Updated by Ahsan

1. OCR can be performed on any image that admin wants to.
2. Admin just have to press Perform OCR on whatever image they require for OCR.

B2C Portal

• This portal is open to the public. Potential customers can browse(No login required) and purchase(only after login) our services such as packages or individual checks.

• They can also pay for the services purchased and monitors the progress of their orders and can provide information (check info or documents) to get verify.

• Customer can view and download their status report.

• Supports OCR on selected documents.

• Capturing location of the candidate(Admin can see in admin portal).

Google Login

User can login using google.(preferred)

Email Login Workflow

Email login succeeds only if the email has been verified. After creation of email login the user is given a grace period of 30 days.

• User enters an email
• Case 1: Email already used for logging in. We ask for password. If the password is correct, login success.
• Case 2: Email never used for logging in. We inform user that you need to signup. To signup he must provide Full Name and a new password.

Signup with email

• Provides full name and new password.
• This will create your account with contact email set to the signup email.
• Signup email has no relation with contact email. You can change both these emails separately later.

Forgot Password

During case 1 of email login workflow, the user prompted for password. He can click a button to indicate that he has forgotten the password. This will cause an email will be sent to this email address. The will contain a link to reset the password.

If the contact email is different from this email, a copy of this email also sent to contact email as well.

When a person is invited via admin, he sends a dummy email and password for login. In this case, email will be sent to only the contact email.

Admin Portal

All activity performed by logged in users is extensively logged. Notifications shown in app bar about updates. Newly added, overdue etc checks lists are shown. Create check, package, company, persons etc ui are in admin portal. Search bar to search person through name, email etc. Person list can be exported through export button.

Location of candidate history is shown in the admin portal.

Admin portal only allows google login.

Creating checks Workflow

Basic info to create a check

required info: check name

optional info (You can add these after creating the check too)

• category name to categorized checks for customer. for e.g. Financial Checks category contains Bankruptcy Check, Conflict of Interest checks.

• Turn around days set expected time to complete this check.

• Admin can select any one of verification service from PAN, criminal record, IDFY Uan this check required, required check info for verification service automatically gets add to the check.

• Check description helps to provide detailed information about the particular check.

Operations after check creation Workflow

• You can add multiple prices of check. Purpose behind multiple prices to run sale.

• You can specify attachments for this check if need any to help with the verification process. can be displayed in report by enabling show in report switch. for e.g Company Details (Discreet) check recommends two attachments Pan card, GST Certificate to help with verification process.

• You can add check infos to help with the verification process, verification process will not proceed if the information is not provided.

• rest can perform all operations same as check creation such as choose verification service, description etc.

Creating a admin

• Create a person whose contact email is an google email.
• Designate this person as administrator.
• Now the google login of this person will succeed.

The first admin must be created using mongoDb compass. In the person collection add this person.

{
    // This will be auto-generated.
  "_id": ObjectId("6720639461db275fb0239a45"),
  "createdAt": 2024-10-29T04:24:52.438Z,
  "createdBy": "Self login",
  "__v": 0,
  "fullName": "Orange Orange",
  "contactEmail": "orange.orange.640@example.com",
  "roles": ["admin"]
}

Invite Person Workflow

Admins can create persons using the admin portal and then they can be invited through admin portal. After the invitation person can log in on the b2c portal. The email sent to invited person contains the b2c portal link where the person will login with the username and password.

To promote the use of B2C portal to invite the persons to login. The invite mail contains the temporary username and password which the user can use. user can change them later.

If the person has logged in before then we just remind the user of what the login credentials are.

Persons in bulk can be invited.

Insuff Management Workflow

Insufficiency happens when required documents or check info are not up to the mark.

We can add comment while marking insufficiency. Reason to why it is being marked as insuff.

Admins can see the cases of insuff in their assigned bucket.

The comment added while marking insuff is shown in event history as well as in the person check list column.

List of insufficiency total counts is shown in check status list.

Assigned person will receive attempt to clear insuff mail whenever the customer tries to update the more info or attachments.

Company Management Workflow

Companies can be created by admins. The company can have multiple candidates to have them verified.

All companies shown in company list ui.

Create and update company is done through admin portal.

New checks can be added in a company and old ones can be removed.

A company can have several special purpose email addresses.

• Insufficiency. addresses to which insufficiency mails will be sent.

• Manage payments made by the company.

Supporting Company Managers

Admins can create company managers. They can also promote or demote company candidates to manager

1. create person allows creating manager now.
2. person list indicates special icon for manager
3. manager text in person profile instead of admin
4. filtering of manager etc on person list

Managers created by admins will be able to log in to the manager portal. They will not be able to log in to the admin portal.

Future Features

Service Automation Workflow

1. Automatic service invocation in bulk on those checks where a service exists, all the required check info and the check status should be not started then the service can be automatically called.
2. Manually entering of required services information is removed by this feature as it will automatically detect the information and pass it to the service.

Separate status list for billed candidates.

Email status reports to stakeholders.

Bulk email final report for stakeholders.

(Does not exist): Lists for persons invitation pending, awaiting response, responded, consent pending, consented list.

New notification in app bar will show whenever new insuff happens and new notifications means the ones admin has not read yet(does not exist).

Whenever status of check is change to insufficiency if the person is in a company then email will be sent to the company insuff email address(does not exist).

To know whenever someone worked and cleared insuff.(does not exist).

Each company will be assigned a team member. When team member will login they will receive all the major notification regarding the companies(does not exist).

Each company will have checks and packages to be done for their candidates.

All deleted candidate log should be shown in company(does not exist).

Archiving companies(does not exist).

1. In-built database of HR emails- This is so our employment department can easily find emails of company HR departments to do employment checks. We have been maintaining this in google drive as of now and so would be better to have on the portal itself
2. In-built database of colleges/educations- Same as above but for emails of colleges/universities
3. For some services like IDD & Matrimony DD we are not checking TAT and updating status on the portal. Team are manually keeping track of TAT which becomes tricky so we need this on the portal itself

Vendor Management

27-11-24 does not exist yet.

University Management

27-11-24 does not exist yet.