Verix Employment Verification API Documentation API Reference

API Endpoint
https://employment.verixapi.com/api/1.0.0
Contact: hello@verix.co
Schemes: https
Version: 1.0.0

Send Email

POST /sendEmail

Sends a verification email to the email specified. Email contains the verification code to be used for authentification.

Work email address of the person to be verified

Request Content-Types: application/json
Request Example
{
  "email": "john.doe@verix.com"
}
200 OK

email verification was sent

400 NOT_WORK_EMAIL

non-work email was used

400 INVALID_EMAIL

an invalid email was used

Verify Email

POST /verifyEmail

Checks to see if email has been verified by employee

Email address of employee

Request Content-Types: application/json
Request Example
{
  "email": "john.doe@verix.com",
  "passcode": "123456"
}
200 OK

email was successfully verified

400 INCORRECT_PASSCODE

incorrect passcode

400 EMAIL_NOT_FOUND

email provided was not found

Get Company Details

POST /getCompanyDetails

Obtains company information on person to be verified

Email address of person to be verified

Request Content-Types: application/json
Request Example
{
  "email": "john.doe@verix.com"
}

company details were successfully sent

400 EMAIL_NOT_VERIFIED

email entered has not been verified

400 COULD_NOT_GET_DETAILS

could not obtain company details

Response Example (200 OK )
{
  "confidence": "0.75",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@verix.com",
  "employer": {
    "name": "Verix",
    "legalName": "Arima Technologies Inc.",
    "domain": "verixapi.com",
    "foundedYear": "2018",
    "timeZone": "America/Los_Angeles",
    "geo": {
      "streetNumber": "320",
      "streetName": "High Street",
      "subPremise": null,
      "city": "Palo Alto",
      "postalCode": "94301",
      "state": "California",
      "stateCode": "CA",
      "country": "United States",
      "countryCode": "US",
      "lat": "37.4452229",
      "lng": "-122.1655131"
    }
  }
}

Schema Definitions

emailBody: object

email: string (email)
Example
{
  "email": "john.doe@verix.com"
}

verifyEmailBody: object

email: string (email)
passcode: string (number)
Example
{
  "email": "john.doe@verix.com",
  "passcode": "123456"
}

companyDetails: object

confidence: string
firstName: string
lastName: string
email: string
employer: object
Example
{
  "confidence": "0.75",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@verix.com",
  "employer": {
    "name": "Verix",
    "legalName": "Arima Technologies Inc.",
    "domain": "verixapi.com",
    "foundedYear": "2018",
    "timeZone": "America/Los_Angeles",
    "geo": {
      "streetNumber": "320",
      "streetName": "High Street",
      "subPremise": null,
      "city": "Palo Alto",
      "postalCode": "94301",
      "state": "California",
      "stateCode": "CA",
      "country": "United States",
      "countryCode": "US",
      "lat": "37.4452229",
      "lng": "-122.1655131"
    }
  }
}