Mark Not Required Verifications as skipped

The following documentation details the process for Mark Not Required Verifications as skipped API, which is used to Mark Not Required Verifications as skipped in transaction as per the form created on the portal.

{/ Try it out → /}

API Endpoint

Endpoint URL: POST https://api.trential.dev/verification/api/1.0/transactions/process/mark-as-skip

Request

To mark verifications as skipped, send a POST request with the following JSON payload:

{
  "orgId": "65940bdb9b271d7e123a90cc",
  "txnId": "68076a35f8ccfbf47ad94f98",
  "verificationNameList": ["bgv-cibil"]
}

cURL

curl -X POST 'https://api.trential.dev/verification/api/1.0/transactions/process/mark-as-skip' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data-raw '{
    "orgId": "YOUR_ORG_ID",
    "txnId": "YOUR_TRANSACTION_ID",
    "verificationNameList": ["bgv-cibil"]
  }'

Parameters

• orgId (string): Your organisation ID.(Required)
• txnId (string): The transaction ID returned from the Create Profile API.(Required)
• verificationNameList (Array of string): The list of verification names to mark as skipped.(Required)

Response

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

{
  "code": 0,
  "message": "Success",
  "data": {
    "_id": "6647408598332f345e0747ae"
  }
}

Success Response

• code (integer): Status code indicating the result of the request. 0 indicates success.
• message (string): Description of the result. Success indicates the verifications were successfully marked as skipped.
• data (object): Contains additional data related to the request.
  • _id (string): A unique identifier for the transaction.

If the request is invalid, the response will be as follows:

{
    "message": "Error message",
    "code": -1
}

Error Response

• message (string): Description of the error(s) encountered. This field provides detailed information about the specific validation issues.
• code (integer): Status code indicating the result of the request. -1 indicates a failure.