Skip to main content

Employment Verification

The following documentation explains how to integrate with the Employment Verification API. This API is used to perform employment verification for candidates.

API Endpoint​

Endpoint URL: POST https://api.trential.dev/verification/api/1.0/bgv/diy

Try it out →

Request​

To perform employment verification, send a POST request to the above endpoint with the following JSON payload:

{
  "data": {
    "employmentDocumentType": "appointmentletter",
    "nameAsPerEmployerRecords": "Shaiwal Shekhar Mishra",
    "employerName": "dsvdfvd",
    "joiningDate": "2018-01-04",
    "lastWorkingDate": "2024-03-06",
    "document": {
      "label": "appointmentletter",
      "url": "https://storage.googleapis.com/trential-images-dev/65940bdd9b271d7e123a90d2/bgv-employment/90c5aadbcc80a708b2196731bc470075e0b54bdd0749a038a8f98ef19ba8cbf3"
    }
  },
  "verificationName": "bgv-employment",
  "transactionId": "664758ec4c1572facafdafa0"
}

cURL​

curl -X POST 'https://api.trential.dev/verification/api/1.0/bgv/diy' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data-raw '{
    "data": {
      "employmentDocumentType": "appointmentletter",
      "nameAsPerEmployerRecords": "Candidate Name",
      "employerName": "Employer Name",
      "joiningDate": "2018-01-04",
      "lastWorkingDate": "2024-03-06",
      "document": { "label": "appointmentletter", "url": "FILE_URL" }
    },
    "verificationName": "bgv-employment",
    "transactionId": "YOUR_TRANSACTION_ID"
  }'

Parameters​

  • employmentDocumentType (string): Type of document attached for verification, Accepted values are:-(Required)
    1. salaryslip
    2. appointmentletter
    3. experienceletter
  • nameAsPerEmployerRecords (string): The candidate's name as per the document(Required)
  • employerName (string): The candidate's employer name(employer)(Required)
  • joiningDate (string): Joining date(Required)
  • lastWorkingDate (string): Last Working date(Required)
  • document (object): Document object with label (employmentDocumentType) and url. Use the File Upload API to get the URL.(Required)
  • verificationName (string): Name of verification Accepted value:- bgv-employment(Required)
  • transactionId (string): Id you get in the add candidate api response(Required)

Response​

If the data is valid, the response will be as follows:

{
  "code": 0,
  "message": "Success"
}