Skip to main content

Resolve Insufficiency

An insufficiency occurs when a verification check cannot proceed because the submitted data is incomplete, unclear, or needs correction — for example, a blurry document image, a name mismatch, or a missing certificate page.

How It Works​

  1. A verification's state changes to INSUFFICIENT_DATA.
  2. A webhook fires with action: "insufficiency-raised" and the verificationId (subType).
  3. Call Verification Info with the transactionId to see what's needed.
  4. Submit the corrected data or updated document using this API.
  5. A webhook fires with action: "insufficiency-resolved" when processing resumes.

API Endpoint​

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

Try it out →

Request​

{
  "transactionId": "664758ec4c1572facafdafa0",
  "orgId": "65940bdb9b271d7e123a90cc",
  "subType": "b8017572-06b6-46d5-8155-a36006f75f23",
  "dataToUpload": {
    "insufficiencyDataList": [
      {
        "insufficiencyId": "66abc12300f1a2b3c4d5e6f7",
        "value": "Updated name as per certificate"
      }
    ],
    "documents": [
      {
        "documentType": "EducationalCertificates",
        "fileType": "Url",
        "document": {
          "label": "Degree",
          "url": "https://storage.googleapis.com/trential-images-dev/..."
        },
        "fileName": "degree_certificate.pdf"
      }
    ]
  }
}

cURL​

curl -X POST 'https://api.trential.dev/verification/api/1.0/bgv/insufficiency' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data-raw '{
    "transactionId": "YOUR_TRANSACTION_ID",
    "orgId": "YOUR_ORG_ID",
    "subType": "YOUR_VERIFICATION_ID",
    "dataToUpload": {
      "insufficiencyDataList": [
        {
          "insufficiencyId": "66abc12300f1a2b3c4d5e6f7",
          "value": "Updated name as per certificate"
        }
      ],
      "documents": [
        {
          "documentType": "EducationalCertificates",
          "fileType": "Url",
          "document": {
            "label": "Degree",
            "url": "FILE_URL"
          },
          "fileName": "degree_certificate.pdf"
        }
      ]
    }
  }'

Parameters​

  • transactionId (string): The transaction ID returned from the Create Profile API.(Required)
  • orgId (string): Your organisation ID.(Required)
  • subType (string): The verificationId received in the insufficiency-raised webhook.(Required)
  • dataToUpload (object): The resolution payload.(Required)
    • insufficiencyDataList (array): List of insufficiency items with their resolved values.(Required)
      • insufficiencyId (string): ID of the specific insufficiency item.(Required)
      • value (string): Corrected or additional text value.(optional)
    • documents (array): Supporting documents to re-upload.(optional)
      • documentType (string): Type of document. Accepted values: ProfileImage, EducationalCertificates, SalarySlip, AppointmentLetter, CustomDocument, Other.
      • fileType (string): How the file is provided. Accepted values: Url, Binary, Base64.
      • document (object): Document with label and url. Use the File Upload API to get the URL.
      • fileName (string): File name including extension.
    • ignore (boolean): Set to true to mark the insufficiency as ignored without submitting new data.(optional)
tip

At least one item in insufficiencyDataList or one entry in documents is required — you cannot submit an empty dataToUpload.

Response​

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