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.


baseUrl: https://api.bgvpreview.millowapp.com/

Login with API key

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

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

Get Token

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.

Create Person

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 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.

Add Attachment