Verify Collateral ID

Collateral ID Verification

POST {{baseurl}}/v2/api/identity/ke/vehicle-collateral

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
id*	String	Vehicle collateral ID
isSubjectConsent	Boolean	Indicate subject has given consent. Must be true

Collateral ID Verification Sample Request

{
    "id": "111111111",
    "isSubjectConsent": true
}

Collateral ID Verification Sample Response

{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "673735007321cb432ace4a64",
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": false,
        "selfieValidation": false,
        "isConsent": true,
        "idNumber": "111111111",
        "collaterals": [
            {
                "description": "Make HONDA , FIT\r\n       Reg No. : KDN892V\r\n       Chassis No.: GP5-1225288\r\n                Engine No.: LEB-H1-1329619\r\n",
                "serialNo": "GP5-1225288",
                "type": "motor_vehicle"
            }
        ],
        "creditors": [
            {
                "categoryOfSecuredCreditor": "consensual",
                "name": "NCBA BANK KENYA PLC",
                "type": "local_company"
            }
        ],
        "currencyAmounts": [
            {
                "amount": "1133890.29",
                "currency": "KES"
            }
        ],
        "businessId": "628b38f03ae28a14f52d4bf7",
        "type": "keVehicleCollateral",
        "allValidationPassed": true,
        "requestedAt": "2024-11-15T11:48:19.615Z",
        "requestedById": "628b38f03ae28a5a122d4bf3",
        "country": "KE",
        "createdAt": "2024-11-15T11:48:19.757Z",
        "lastModifiedAt": "2024-11-15T11:48:19.757Z",
        "adverseMediaReport": null,
        "amlReport": null,
        "metadata": {},
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "628b38f03ae28a5a122d4bf3"
        }
    },
    "links": []
}

Error Response

{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}