Skip to main content

Verification Info

The following documentation explains how to integrate with the Transaction Verification Information API. This API is used to retrieve information about a specific verification in a transaction.

API Endpoint​

Endpoint URL: GET https://api.staging.trential.app/verification/api/1.0/transactions/:verificationName/info?orgId={orgId}&txnId={txnId}

Try it out

Request​

To retrieve verification information, send a GET request to the above endpoint with the required query parameters.

Response​

If the data is valid, the response will be as follows(For Education):

{
  "code": 0,
  "message": "Success",
  "data": {
    "code": 0,
    "message": "Success",
    "data": [
      {
        "name": "bgv-degree",
        "state": "COMPLETED",
        "note": "Success",
        "request": {
          "nameAsPerDocument": "XXXXXXX",
          "issueDate": "xxx-xx-xx",
          "registrationNumber": "xxxx",
          "level": "GRADUATE",
          "nameOfInstitute": "xxxx",
          "documentList": [
            {
              "url": "xxxxx",
              "label": "10th Marksheet"
            }
          ]
        },
        "response": {
          "registrationNumber": "registrationNumber",
          "courseName": "courseName",
          "fieldOfStudy": "fieldOfStudy",
          "educationLevel": "educationLevel",
          "durationInMonths": "durationInMonths",
          "yearOfPassing": "yearOfPassing",
          "grade": "grade",
          "nameOfInstitute": "nameOfInstitute",
          "nameOfBoardUniversity": "nameOfBoardUniversity",
          "courseResult": "courseResult",
          "respondentName": "respondentName",
          "respondentDesignation": "respondentDesignation",
          "respondentEmail": "respondentEmail",
          "result": "result",
          "reason": "reason",
        },
        "mode": "manual",
        "subType": "b8017572-06b6-46d5-8155-a36006f75f23",
        "documentList": [
          {
            "name": "name",
            "url": "url",
            "verified": true/false
          }
        ],
        "reportData": [
          {
            "label": "label",
            "value": "value",
            "childDataList": [{
              "label": "label",
              "value": "value",
            }]
          }
        ],
        "reportUrl": "reportUrl"
      }
    ]
  }
}

Response​

If the data is valid, the response will be as follows(For Credit History):

{
  "code": 0,
  "message": "Success",
  "data": {
    "code": 0,
    "message": "Success",
    "data": [
      {
        "name": "bgv-degree",
        "state": "COMPLETED",
        "note": "Success",
        "request": {
            "pan": "XXXXXXX"
        },
        "response": {
          "scoreValue": "registrationNumber",
          "creditCheckPartner": "creditCheckPartner",
          "givenAddress": "givenAddress",
          "result": "result",
          "reason": "reason"
        },
        "mode": "manual",
        "subType": "b8017572-06b6-46d5-8155-a36006f75f23",
        "documentList": [
          {
            "name": "name",
            "url": "url",
            "verified": true/false
          }
        ],
        "reportData": [
          {
            "label": "label",
            "value": "value",
            "childDataList": [{
              "label": "label",
              "value": "value",
            }]
          }
        ],
        "reportUrl": "reportUrl"
      }
    ]
  }
}

Response​

If the data is valid, the response will be as follows(For Police Verification):

{
  "code": 0,
  "message": "Success",
  "data": {
    "code": 0,
    "message": "Success",
    "data": [
      {
        "name": "bgv-employment",
        "state": "COMPLETED",
        "note": "Success",
        "request": { },
        "response": {
          "state": "state",
          "verifiedAddress": "verifiedAddress",
          "result": "result",
          "reason": "reason",
        },
        "mode": "manual",
        "subType": "b8017572-06b6-46d5-8155-a36006f75f23",
        "documentList": [
          {
            "name": "name",
            "url": "url",
            "verified": true/false
          }
        ],
        "reportData": [
          {
            "label": "label",
            "value": "value",
            "childDataList": [{
              "label": "label",
              "value": "value",
            }]
          }
        ],
        "reportUrl": "reportUrl"
      }
    ]
  }
}

Response​

If the data is valid, the response will be as follows(For Employment Verification):

{
  "code": 0,
  "message": "Success",
  "data": {
    "code": 0,
    "message": "Success",
    "data": [
      {
        "name": "bgv-employment",
        "state": "COMPLETED",
        "note": "Success",
        "request": { },
        "response": {
         "nameAsPerEmployerRecords": "nameAsPerEmployerRecords",
        "employeeId": "employeeId",
        "lastDesignation": "lastDesignation",
        "joiningDate": "joiningDate",
        "lastWorkingDate": "lastWorkingDate",
        "status": "status",
        "fnfStatus": "fnfStatus",
        "performanceIssues": "performanceIssues",
        "integrityIssues": "integrityIssues",
        "annualCompensation": "annualCompensation",
        "remark": "remark",
        "respondentName": "respondentName",
        "respondentDesignation": "respondentDesignation",
        "respondentEmail": "respondentEmail",
        "respondentPhone": "respondentPhone",
        "result": "result",
        "reason": "reason",
        },
        "mode": "manual",
        "subType": "b8017572-06b6-46d5-8155-a36006f75f23",
        "documentList": [
          {
            "name": "name",
            "url": "url",
            "verified": true/false
          }
        ],
        "reportData": [
          {
            "label": "label",
            "value": "value",
            "childDataList": [{
              "label": "label",
              "value": "value",
            }]
          }
        ],
        "reportUrl": "reportUrl"
      }
    ]
  }
}