Retrieve CWB Report

This endpoint allows you to retrieve the report for a specific response. The CWB webhook page contains an extensive sample as well as explanations of the vForm Report Sample Response

GET {{baseurl}}/v2/api/v-forms/:templateId/responses/:reportId

Path Parameters

Name	Type	Description
templateId*	String	template id
reportId*	String	report id

Headers

Name	Type	Description
token*	String	API secret token

CWB Report Sample Responses

{
    "success": true,
    "statusCode": 200,
    "message": "Result retrieved",
    "data": {
        "accessId": null,
        "ipAddress": null,
        "completedVerifications": 0,
        "status": "cleared",
        "billingItemComponents": [
            "vform"
        ],
        "transactionDetails": {
            "transactionReference": "6391dbfe9ff5bf4c3d4a16dc",
            "transactionId": "6391dbfe9ff5bf60ac4a16dd",
            "amountCharged": 100,
            "currency": "NGN",
            "availableBalance": 879670,
            "availableCredit": 0
        },
        "upsertFrequency": 0,
        "_id": "6391dbfd3c70fd9bc72871af",
        "businessId": "62b2e8b281442b03187f7896",
        "userId": "62b2e8b381442b75857f7898",
        "templateId": "6368a5ce75d8197615700ff1",
        "sharedId": null,
        "fields": [
            {
                "value": true,
                "validated": true,
                "__type": "consent-verification",
                "_id": "6391dbfd3c70fd9bc72871b0",
                "label": "Request Verification Consent",
                "fieldTemplateId": "6368a5ce75d819c507700fec",
                "id": "6391dbfd3c70fd9bc72871b0"
            },
            {
                "middleName": null,
                "email": "[e-mail]",
                "dateOfBirth": null,
                "gender": null,
                "mobile": null,
                "photo": null,
                "relationship": null,
                "validated": true,
                "__type": "personal-information",
                "_id": "6391dbfd3c70fd9bc72871b1",
                "label": "User Information",
                "fieldTemplateId": "6368a5ce75d8191746700feb",
                "firstName": "shittu",
                "lastName": "name",
                "id": "6391dbfd3c70fd9bc72871b1"
            }
        ],
        "totalVerifications": 0,
        "fillDurationInMilliSeconds": 22998,
        "createdAt": "2022-12-08T12:43:42.087Z",
        "updatedAt": "2022-12-08T12:43:42.087Z",
        "__v": 0,
        "_createdAt": "2022-12-08T13:43:4242+01:00",
        "_lastModifiedAt": "2022-12-14T18:12:066+01:00",
        "id": "6391dbfd3c70fd9bc72871af"
    },
    "links": []
}