Skip to main content

10th Verification

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

API Endpoint​

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

Try it out →

Request​

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

{
  "data": {
    "level": "TENTH_STD",
    "nameAsPerDocument": "Shaiwal Shekhar Mishra",
    "nameOfInstitute": "A M A L College",
    "nameOfBoard": "CBSE",
    "registrationNumber": "13232",
    "issueDate": "2024-05-03",
    "yearOfPassing": "2024",
    "documentList": [
      {
        "label": "10th Marksheet",
        "url": "https://storage.googleapis.com/trential-images-dev/65940bdd9b271d7e123a90d2/bgv-twelfth/b12835f116144b414678aa47d56a4dcd161d819651df8487ac4ab2600ccd628d"
      }
    ]
  },
  "verificationName": "bgv-tenth",
  "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": {
      "level": "TENTH_STD",
      "nameAsPerDocument": "Candidate Name",
      "nameOfInstitute": "School Name",
      "nameOfBoard": "CBSE",
      "registrationNumber": "13232",
      "issueDate": "2024-05-03",
      "yearOfPassing": "2010",
      "documentList": [{ "label": "10th Marksheet", "url": "FILE_URL" }]
    },
    "verificationName": "bgv-tenth",
    "transactionId": "YOUR_TRANSACTION_ID"
  }'

Parameters​

  • level (string): Candidate's education level. Accepted values are:- (Required)
    1. TENTH_STD
  • nameAsPerDocument (string): The candidate's name as per the document(Required)
  • nameOfInstitute (string): The candidate's institute name(school)(Required)
  • nameOfBoard (string): Board of education (e.g. CBSE, ICSE, State Board)(Optional)
  • registrationNumber (string): The candidate's registration/roll number(Required)
  • issueDate (string): Document issue date. (Conditionally Required) - Required if yearOfPassing is not provided.
  • yearOfPassing (string): Candidate's passing year. (Conditionally Required) - Required if issueDate is not provided.
  • documentList (string): List of all the document with label like(10th Marksheet), Use File Upload api to get url(Required)
  • verificationName (string): Name of verification Accepted value:- (Required)
    1. bgv-tenth
  • 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"
}