Basic API Workflow

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

You can find out checks you can buy 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.

• 1. Quick Start
  1. You can access our test apis code here
• 2. Get Token
  1. Call the login api, which expects the authorization 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
• 3. Create Person
  1. Call create person api. You will be required to pass fullName, clientReferenceId and email
  2. This will return an personId
• 4. Add Check
  1. Call the add check api to which you need to pass the personId and checkShortName 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 orderCheckId which was created on your behalf. You will use this `orderCheckId` to optionally add supporting documents for this check.
• 5. Add Attachment
  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.
  3. You can call it multiple time to add more files.
• 6. Get Report
  1. Retrieves the report associated with a specific person. The report is returned as a PDF file on success