CWB Webhook

This page contains samples as well as details about the CWB webhook object.

* Check out the Webhooks page to get instructions on how to set your webhook.

The CWB Webhook Object

This is the object (JSON) you will receive when you set up your webhook and someone fills out your form. It consists of the webhook event, apiVersion, and the data object . The data object contains the entry's (the form filler's) response, as well as reports generated by vForm on the response if required.

Full CWB Webhook Object Sample

{
  "event": "vform.completed",
  "apiVersion":"v1",
  "data": {
    "accessId": null,
    "ipAddress": null,
    "completedVerifications": 9,
    "status": "not_cleared",
    "billingItemComponents": [
      "vform",
      "aml",
      "facial_compare",
      "drivers_license",
      "id_capture",
      "facial_compare",
      "passport",
      "id_capture",
      "facial_compare",
      "drivers_license",
      "facial_compare",
      "inec",
      "company_search",
      "company_search"
    ],
    "transactionDetails": {
      "transactionReference": "63c9c46bb48f6ae9d46bc2f6",
      "transactionId": "63c9c46bb48f6a667b6bc2f7",
      "amountCharged": 1480,
      "currency": "NGN",
      "availableBalance": 463050,
      "availableCredit": 0
    },
    "upsertFrequency": 0,
    "_id": "63c9c46b25efdd314e1bf823",
    "businessId": "6222a5ed3e7a41c29c031ecc",
    "userId": "62346b6b283d48fb58b57e8e",
    "templateId": "63c967d725efdd42541bf668",
    "sharedId": null,
    "fields": [
      {
        "value": true,
        "validated": true,
        "__type": "consent-verification",
        "_id": "63c9c46b25efddb7491bf825",
        "label": "Request Verification Consent",
        "fieldTemplateId": "63c967d725efdd359a1bf663",
        "id": "63c9c46b25efddb7491bf825"
      },
      {
        "middleName": "TEST",
        "email": "[e-mail]",
        "dateOfBirth": "2023-01-01T00:00:00.000Z",
        "gender": "MALE",
        "mobile": "[phone]",
        "photo": "https://cdn.youverify.co/1674167402807-VlZyzrQ6CB85EMb01s58Z.jpg",
        "relationship": "wife",
        "validated": true,
        "__type": "personal-information",
        "_id": "63c9c46b25efddb6391bf826",
        "label": "User Information Field Label",
        "fieldTemplateId": "63c967d725efdd78b21bf662",
        "firstName": "OMAH",
        "lastName": "LAY",
        "amlCheck": {
          "report": {
            "status": "cleared",
            "parentId": null,
            "isSubjectConsent": true,
            "middleName": "TEST",
            "pepList": [],
            "sanctionList": [],
            "firstName": "OMAH",
            "lastName": "LAY",
            "businessId": "6222fac719fab43e133f0d44",
            "requestedAt": "2023-01-19T22:30:07.324Z",
            "requestedById": "6222fac719fab4c11a3f0d40",
            "createdAt": "2023-01-19T22:30:07.336Z",
            "lastModifiedAt": "2023-01-19T22:30:07.336Z",
            "_createdAt": "2023-01-19T22:30:077+00:00",
            "_lastModifiedAt": "2023-01-19T22:30:077+00:00",
            "id": "63c9c46dd80a7bfb6e9f1560",
            "requestedBy": {
              "firstName": "API",
              "lastName": "User",
              "middleName": "",
              "id": "6222fac719fab4c11a3f0d40"
            }
          },
          "status": "cleared",
          "_id": "63d80a5b74738c257c3e4bfd"
        },
        "id": "63c9c46b25efddb6391bf826"
      },
      {
        "typeCountryCode": "NG",
        "firstName": "OMAH",
        "lastName": "LAY",
        "dateOfBirth": "2023-01-01T00:00:00.000Z",
        "photo": "https://cdn.youverify.co/1674167402807-VlZyzrQ6CB85EMb01s58Z.jpg",
        "identityCardPhotoFront": "",
        "identityCardPhotoBack": "",
        "livenessCheckSnapshot": null,
        "status": "found",
        "report": {
          "id": "63c9c46fdd95fcd7fc3c7f69",
          "validations": {
            "data": {
              "lastName": {
                "validated": false,
                "value": "LAY"
              },
              "dateOfBirth": {
                "validated": false,
                "value": "2023-01-01"
              },
              "firstName": {
                "validated": false,
                "value": "OMAH"
              }
            },
            "selfie": {
              "selfieVerification": {
                "confidenceLevel": 25,
                "threshold": 80,
                "match": false,
                "image": "https://cdn.youverify.co/1674167402807-VlZyzrQ6CB85EMb01s58Z.jpg"
              }
            },
            "validationMessages": "First name does not match, Last name does not match, Date of birth does not match, Provided image does not match ID image"
          },
          "parentId": null,
          "status": "found",
          "reason": null,
          "dataValidation": true,
          "selfieValidation": true,
          "firstName": "GBENGA",
          "middleName": null,
          "lastName": "ODEGBAMI",
          "expiredDate": "2024-04-25",
          "issuedDate": "2019-04-29",
          "stateOfIssuance": "LAGOS",
          "notifyWhenIdExpire": false,
          "image": "data:image/jpg;base64,/9j/4AAQSkZJRgABAQEBOgE6AAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjI",
          "mobile": null,
          "email": null,
          "dateOfBirth": "1981-04-25",
          "isConsent": true,
          "idNumber": "KJA08067AA01",
          "businessId": "6222fac719fab43e133f0d44",
          "type": "ndl",
          "allValidationPassed": false,
          "gender": "female",
          "requestedAt": "2023-01-19T22:30:08.539Z",
          "requestedById": "6222fac719fab4c11a3f0d40",
          "country": "NG",
          "createdAt": "2023-01-19T22:30:08.552Z",
          "lastModifiedAt": "2023-01-19T22:30:08.552Z",
          "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "6222fac719fab4c11a3f0d40"
          }
        },
        "validated": false,
        "__type": "identity",
        "_id": "63c9c46b25efdd64831bf829",
        "label": "Identity Field Label",
        "fieldTemplateId": "63c9c1bfeb600fc087807329",
        "type": "drivers-license",
        "value": "Kja08067aa01",
        "id": "63c9c46b25efdd64831bf829"
      },
      {
        "companyName": null,
        "registeredName": null,
        "companyAddress": null,
        "supportEmail": null,
        "supportPhoneNumber": null,
        "countryCode": "NG",
        "status": "found",
        "report": {
          "parentId": null,
          "searchBusinessName": null,
          "name": "THINK HAT SERVICES LIMITED",
          "formerName": null,
          "registrationNumber": "RC1733970",
          "registryNumber": "1733970",
          "vatNumber": "23739807-0001",
          "registrationDate": "2020-11-12T00:00:00.000+00:00",
          "registrationSubmissionDate": "2020-11-04T14:57:00.210+00:00",
          "dateDisolved": null,
          "tin": "23739807-0001",
          "jtbTin": null,
          "taxOffice": null,
          "email": "[e-mail]",
          "phone": null,
          "websiteEmail": null,
          "typeOfEntity": "PRIVATE COMPANY LIMITED BY SHARES",
          "activity": "GENERAL CONTRACT AND MERCHANDISE",
          "address": "NO. 220, FREEDOM WAY, LEKKI PHASE 1, ",
          "state": "LAGOS",
          "lga": "Lagos Island",
          "city": "LEKKI",
          "branchAddress": "NO. 220, FREEDOM WAY, LEKKI PHASE 1, , LEKKI, LAGOS STATE ",
          "headOfficeAddress": null,
          "objectives": null,
          "status": "found",
          "companyStatus": "INACTIVE",
          "isConsent": true,
          "lastUpdatedAt": "2022-10-07T14:27:18.767+00:00",
          "shareCapitalInWords": "ONE MILLION NAIRA",
          "paidShareCapital": "1000000",
          "subscribedShareCapital": "1000000",
          "sharesValue": "1 NGN",
          "activityDescription": "GENERAL CONTRACT AND MERCHANDISE",
          "sharesIssued": "1000000",
          "parentCountry": null,
          "companyContactPersons": [
            {
              "contacts": {
                "email": ["[e-mail]"],
                "phone": ["08030810838"]
              },
              "name": "Sokari Blessing Boma "
            }
          ],
          "country": "Nigeria",
          "countryCode": "NG",
          "keyPersonnel": [
            {
              "name": "Sokari Blessing Boma",
              "designation": "PRESENTER",
              "isCorporate": false,
              "appointedOn": null,
              "resignedOn": null,
              "sharesType": null,
              "sharesValue": null,
              "sharesCount": null,
              "occupation": null,
              "nationality": null,
              "birthYear": null,
              "birthMonth": null,
              "birthDate": null,
              "dateOfBirth": "1990-08-29T23:00:00.000+00:00",
              "gender": "MALE",
              "address": null,
              "countryOfResidence": "NIGERIA",
              "number": null,
              "isForeign": "false",
              "documentType": "National Identification Number",
              "documentIssuedOn": null,
              "documentIssuedBy": null,
              "documentNumber": null,
              "email": "[e-mail]",
              "phone": "08030810838",
              "status": "ACTIVE",
              "companies": []
            },
            {
              "name": "Sokari Blessing Boma",
              "designation": "PRESENTER",
              "isCorporate": false,
              "appointedOn": null,
              "resignedOn": null,
              "sharesType": null,
              "sharesValue": null,
              "sharesCount": null,
              "occupation": null,
              "nationality": "Nigerian",
              "birthYear": null,
              "birthMonth": null,
              "birthDate": null,
              "dateOfBirth": "1990-08-29T23:00:00.000+00:00",
              "gender": null,
              "address": "3,E,CLOSE UNITY ESTATE,MARARABA, KARU, ABUJA",
              "countryOfResidence": "NIGERIA",
              "number": null,
              "isForeign": "false",
              "documentType": null,
              "documentIssuedOn": null,
              "documentIssuedBy": null,
              "documentNumber": null,
              "email": "[e-mail]",
              "phone": "08030810838",
              "status": "ACTIVE",
              "companies": []
            },
            {
              "name": "AMADI-EMINA NKIRU ANTOINETTE",
              "designation": "DIRECTOR",
              "isCorporate": false,
              "appointedOn": null,
              "resignedOn": null,
              "sharesType": "ORDINARY",
              "sharesValue": "700000",
              "sharesCount": "700000",
              "occupation": null,
              "nationality": "Nigerian",
              "birthYear": null,
              "birthMonth": null,
              "birthDate": null,
              "dateOfBirth": "1989-10-25T23:00:00.000+00:00",
              "gender": "FEMALE",
              "address": "UNIT 2 C4, MERIDIAN PARK ESTATE AWOYAYA, LEKKI/EPE EXPRESSWAY",
              "countryOfResidence": "NIGERIA",
              "number": "A50584625",
              "isForeign": "false",
              "documentType": "International Passport",
              "documentIssuedOn": null,
              "documentIssuedBy": null,
              "documentNumber": "A50584625",
              "email": "[e-mail]",
              "phone": "08030883778",
              "status": "ACTIVE",
              "companies": []
            },
            {
              "name": "AMADI-EMINA NKIRU ANTOINETTE",
              "designation": "SHAREHOLDER",
              "isCorporate": false,
              "appointedOn": null,
              "resignedOn": null,
              "sharesType": "ORDINARY",
              "sharesValue": "700000",
              "sharesCount": "700000",
              "occupation": null,
              "nationality": "Nigerian",
              "birthYear": null,
              "birthMonth": null,
              "birthDate": null,
              "dateOfBirth": "1989-10-25T23:00:00.000+00:00",
              "gender": "FEMALE",
              "address": "UNIT 2 C4, MERIDIAN PARK ESTATE AWOYAYA, LEKKI/EPE EXPRESSWAY",
              "countryOfResidence": "NIGERIA",
              "number": "A50584625",
              "isForeign": "false",
              "documentType": "International Passport",
              "documentIssuedOn": null,
              "documentIssuedBy": null,
              "documentNumber": "A50584625",
              "email": "[e-mail]",
              "phone": "08030883778",
              "status": "ACTIVE",
              "companies": []
            },
            {
              "name": "AMADI-EMINA MARIE ANNE",
              "designation": "DIRECTOR",
              "isCorporate": false,
              "appointedOn": null,
              "resignedOn": null,
              "sharesType": "ORDINARY",
              "sharesValue": "300000",
              "sharesCount": "300000",
              "occupation": null,
              "nationality": "Nigerian",
              "birthYear": null,
              "birthMonth": null,
              "birthDate": null,
              "dateOfBirth": "1994-07-24T23:00:00.000+00:00",
              "gender": "FEMALE",
              "address": "UNIT 2 C4, MERIDIAN PARK ESTATE AWOYAYA, LEKKI/EPE EXPRESSWAY",
              "countryOfResidence": "NIGERIA",
              "number": "A07154518",
              "isForeign": "false",
              "documentType": "International Passport",
              "documentIssuedOn": null,
              "documentIssuedBy": null,
              "documentNumber": "A07154518",
              "email": "[e-mail]",
              "phone": "08166052917",
              "status": "ACTIVE",
              "companies": []
            },
            {
              "name": "AMADI-EMINA MARIE ANNE",
              "designation": "SHAREHOLDER",
              "isCorporate": false,
              "appointedOn": null,
              "resignedOn": null,
              "sharesType": "ORDINARY",
              "sharesValue": "300000",
              "sharesCount": "300000",
              "occupation": null,
              "nationality": "Nigerian",
              "birthYear": null,
              "birthMonth": null,
              "birthDate": null,
              "dateOfBirth": "1994-07-24T23:00:00.000+00:00",
              "gender": "FEMALE",
              "address": "UNIT 2 C4, MERIDIAN PARK ESTATE AWOYAYA, LEKKI/EPE EXPRESSWAY",
              "countryOfResidence": "NIGERIA",
              "number": "A07154518",
              "isForeign": "false",
              "documentType": "International Passport",
              "documentIssuedOn": null,
              "documentIssuedBy": null,
              "documentNumber": "A07154518",
              "email": "[e-mail]",
              "phone": "08166052917",
              "status": "ACTIVE",
              "companies": []
            },
            {
              "name": "AMADI-EMINA MARIE ANNE",
              "designation": "SECRETARY",
              "isCorporate": false,
              "appointedOn": null,
              "resignedOn": null,
              "sharesType": null,
              "sharesValue": null,
              "sharesCount": null,
              "occupation": null,
              "nationality": null,
              "birthYear": null,
              "birthMonth": null,
              "birthDate": null,
              "dateOfBirth": null,
              "gender": null,
              "address": "UNIT 2 C4, MERIDIAN PARK ESTATE AWOYAYA, LEKKI/EPE EXPRESSWAY ",
              "countryOfResidence": "NIGERIA",
              "number": "A07154518",
              "isForeign": "false",
              "documentType": "International Passport",
              "documentIssuedOn": null,
              "documentIssuedBy": null,
              "documentNumber": "A07154518",
              "email": "[e-mail]",
              "phone": "08166052917",
              "status": "ACTIVE",
              "companies": []
            },
            {
              "name": "BOMA SOKARI BLESSING",
              "designation": "DEPONENT",
              "isCorporate": false,
              "appointedOn": null,
              "resignedOn": null,
              "sharesType": null,
              "sharesValue": null,
              "sharesCount": null,
              "occupation": null,
              "nationality": null,
              "birthYear": null,
              "birthMonth": null,
              "birthDate": null,
              "dateOfBirth": null,
              "gender": null,
              "address": "3,E,CLOSE UNITY ESTATE,MARARABA, KARU, ABUJA ",
              "countryOfResidence": "NIGERIA",
              "number": null,
              "isForeign": "false",
              "documentType": null,
              "documentIssuedOn": null,
              "documentIssuedBy": null,
              "documentNumber": null,
              "email": "[e-mail]",
              "phone": "08030810838",
              "status": "ACTIVE",
              "companies": []
            }
          ],
          "activities": [],
          "legalEntityIdentifierRegister": [],
          "centralIndexKeyRegister": [],
          "filings": [],
          "affiliates": [],
          "businessId": "6222fac719fab43e133f0d44",
          "type": "advance_company_check",
          "requestedAt": "2023-01-19T22:30:12.862Z",
          "requestedById": "6222fac719fab4c11a3f0d40",
          "searchTerm": "RC1733970",
          "createdAt": "2023-01-19T22:30:12.978Z",
          "lastModifiedAt": "2023-01-19T22:30:12.978Z",
          "_createdAt": "2023-01-19T22:30:1212+00:00",
          "_lastModifiedAt": "2023-01-19T22:30:1212+00:00",
          "id": "63c9c46f7eb0a0dff6186872",
          "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "6222fac719fab4c11a3f0d40"
          }
        },
        "validated": true,
        "__type": "company-search",
        "_id": "63c9c46b25efdd34851bf82b",
        "label": "Business Search",
        "fieldTemplateId": "63c9b83feb600f5ea88072ab",
        "type": "registrationNumber",
        "value": "RC1733970",
        "id": "63c9c46b25efdd34851bf82b"
      },
      {
        "name": "1674127188116",
        "size": 7028,
        "status": "completed",
        "validated": true,
        "__type": "file-upload",
        "_id": "63c9c46b25efdd8ca01bf82d",
        "label": "File Upload Field Label",
        "fieldTemplateId": "63c9bb3aeb600f3a9b8072d4",
        "url": "https://cdn.youverify.co/1674167402808-PgGVBkErMmR9ihSmIFTcR.jpg",
        "fileType": "jpg",
        "id": "63c9c46b25efdd8ca01bf82d"
      },
      {
        "value": ["Omah Lay"],
        "options": [],
        "status": "completed",
        "validated": true,
        "__type": "supplementary-field",
        "_id": "63c9c46b25efdd41b21bf82e",
        "label": "What's your name",
        "fieldTemplateId": "63c9bcb1e05ace51e6f8cbba",
        "type": "text",
        "format": "short",
        "id": "63c9c46b25efdd41b21bf82e"
      },
      {
        "value": ["Option 2"],
        "options": ["Option 1", "Option 2", "Option 3"],
        "status": "completed",
        "validated": true,
        "__type": "supplementary-field",
        "_id": "63c9c46b25efdd92a91bf82f",
        "label": "pick one",
        "fieldTemplateId": "63c9bd3ce05ace819ff8cbd0",
        "type": "radio",
        "format": "short",
        "id": "63c9c46b25efdd92a91bf82f"
      },
      {
        "value": ["Option 1"],
        "options": ["Option 1", "Option 2", "Option 3"],
        "status": "completed",
        "validated": true,
        "__type": "supplementary-field",
        "_id": "63c9c46b25efdde77c1bf830",
        "label": "pick one",
        "fieldTemplateId": "63c9bd460b8e960d56652d85",
        "type": "dropdown",
        "format": "short",
        "id": "63c9c46b25efdde77c1bf830"
      },
      {
        "value": ["Option 3"],
        "options": ["Option 1", "Option 2", "Option 3"],
        "status": "completed",
        "validated": true,
        "__type": "supplementary-field",
        "_id": "63c9c46b25efdd67821bf831",
        "label": "pick one or more",
        "fieldTemplateId": "63c9bd4f25efdd5ce11bf7ca",
        "type": "dropdown",
        "format": "short",
        "id": "63c9c46b25efdd67821bf831"
      },
      {
        "value": ["2023-01-23"],
        "options": ["Option 1", "Option 2", "Option 3"],
        "status": "completed",
        "validated": true,
        "__type": "supplementary-field",
        "_id": "63c9c46b25efdd1f261bf832",
        "label": "Date of Birth",
        "fieldTemplateId": "63c9bd59e05ace78fdf8cbd7",
        "type": "date",
        "format": "short",
        "id": "63c9c46b25efdd1f261bf832"
      },
      {
        "value": [
          "It’s difficult to say without more information about what the code is supposed to do and what’s happening when it’s executed. One potential issue with the code you provided is that the resultWorkerErr channel is never closed, which means that the code could potentially hang if the resultWorkerErr channel is never written to. This could happen if b.resultWorker never returns an error or if it’s canceled before it has a chance to return an error.\n\nTo fix this issue, you could close the resultWorkerErr channel after writing to it. For example, you could add the following line of code after the line that sends the error on the channel:"
        ],
        "options": ["Option 1", "Option 2", "Option 3"],
        "status": "completed",
        "validated": true,
        "__type": "supplementary-field",
        "_id": "63c9c46b25efdd82021bf833",
        "label": "Explain yourself",
        "fieldTemplateId": "63c9bd650b8e9643b2652d8c",
        "type": "text",
        "format": "long",
        "id": "63c9c46b25efdd82021bf833"
      },
      {
        "firstName": null,
        "lastName": null,
        "status": "not_cleared",
        "fields": [
          {
            "value": true,
            "validated": true,
            "__type": "consent-verification",
            "_id": "63c9c4bbe05ace68f6f8cc3a",
            "label": "Request Verification Consent",
            "fieldTemplateId": "63c9bfdb0b8e962615652da0",
            "id": "63c9c4bbe05ace68f6f8cc3a"
          },
          {
            "middleName": null,
            "email": null,
            "dateOfBirth": null,
            "gender": null,
            "mobile": null,
            "photo": null,
            "relationship": null,
            "validated": true,
            "__type": "personal-information",
            "_id": "63c9c4bbe05ace5277f8cc3b",
            "label": "User Information",
            "fieldTemplateId": "63c9bfdb0b8e96f5b8652d9f",
            "firstName": "Famous",
            "lastName": "EHICHIOYA",
            "id": "63c9c4bbe05ace5277f8cc3b"
          },
          {
            "typeCountryCode": "NG",
            "firstName": "Famous",
            "lastName": "EHICHIOYA",
            "dateOfBirth": null,
            "photo": null,
            "identityCardPhotoFront": "",
            "identityCardPhotoBack": "",
            "livenessCheckSnapshot": null,
            "status": "found",
            "report": {
              "id": "63c9c4bcdd95fcc3dc3c7f6c",
              "validations": {
                "data": {
                  "firstName": {
                    "validated": true,
                    "value": "Famous"
                  }
                },
                "validationMessages": "Document has expired"
              },
              "parentId": null,
              "status": "found",
              "reason": null,
              "dataValidation": true,
              "selfieValidation": false,
              "firstName": "FAMOUS",
              "middleName": "PRIOR",
              "lastName": "Ehichioya",
              "expiredDate": "2021-02-22",
              "notifyWhenIdExpire": false,
              "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAFACAYAAACC6PFTAAAAAXNSR0IArs4c6QAAIABJREFUeJzsvVmPHElyLvqZe0Rm",
              "signature": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUsAAABICAYAAAB/VNeEAAAAAXNSR0IArs4c6QAAEBVJREFUeJzt3XtsFNX7x/H37uzO",
              "issuedAt": "MINNA",
              "issuedDate": "2016-02-23",
              "mobile": null,
              "dateOfBirth": "1990-04-04",
              "isConsent": true,
              "idNumber": "A07074823",
              "businessId": "6222fac719fab43e133f0d44",
              "type": "passport",
              "allValidationPassed": false,
              "gender": "male",
              "requestedAt": "2023-01-19T22:31:24.471Z",
              "requestedById": "6222fac719fab4c11a3f0d40",
              "country": "NG",
              "createdAt": "2023-01-19T22:31:24.489Z",
              "lastModifiedAt": "2023-01-19T22:31:24.489Z",
              "requestedBy": {
                "firstName": "API",
                "lastName": "User",
                "middleName": "",
                "id": "6222fac719fab4c11a3f0d40"
              }
            },
            "validated": false,
            "__type": "identity",
            "_id": "63c9c4bbe05ace21ebf8cc3c",
            "label": "Identity",
            "fieldTemplateId": "63c9bfe20b8e96ec3b652dad",
            "type": "passport",
            "value": "A07074823",
            "id": "63c9c4bbe05ace21ebf8cc3c"
          }
        ],
        "validated": true,
        "__type": "reference",
        "_id": "63c9c46b25efdd90cc1bf834",
        "label": "Reference Field Label",
        "fieldTemplateId": "63c9c20feb600f487c80734f",
        "referenceTemplateId": "63c9bfdb0b8e96183b652da5",
        "email": "[e-mail]",
        "id": "63c9c46b25efdd90cc1bf834"
      },
      {
        "firstName": "Jerry",
        "lastName": "Osobase",
        "status": "cleared",
        "fields": [
          {
            "value": true,
            "validated": true,
            "__type": "consent-verification",
            "_id": "63c9c4d38a056ce15cb7afd8",
            "label": "Request Verification Consent",
            "fieldTemplateId": "63c9bfdb0b8e962615652da0",
            "id": "63c9c4d38a056ce15cb7afd8"
          },
          {
            "middleName": null,
            "email": null,
            "dateOfBirth": null,
            "gender": null,
            "mobile": null,
            "photo": null,
            "relationship": null,
            "validated": true,
            "__type": "personal-information",
            "_id": "63c9c4d38a056c097bb7afd9",
            "label": "User Information",
            "fieldTemplateId": "63c9bfdb0b8e96f5b8652d9f",
            "firstName": "Jerry",
            "lastName": "Osobase",
            "id": "63c9c4d38a056c097bb7afd9"
          },
          {
            "typeCountryCode": "NG",
            "firstName": "Jerry",
            "lastName": "Osobase",
            "dateOfBirth": null,
            "photo": null,
            "identityCardPhotoFront": "",
            "identityCardPhotoBack": "",
            "livenessCheckSnapshot": null,
            "status": "found",
            "report": {
              "id": "63c9c4d48db8b79f16914f79",
              "validations": {
                "data": {
                  "lastName": {
                    "validated": true,
                    "value": "Osobase"
                  },
                  "firstName": {
                    "validated": true,
                    "value": "Jerry"
                  }
                },
                "validationMessages": ""
              },
              "parentId": null,
              "status": "found",
              "reason": null,
              "dataValidation": true,
              "selfieValidation": false,
              "firstName": "JERRY",
              "middleName": "OSAMUDIAMEH",
              "lastName": "OSOBASE",
              "image": "data:image/jpg;base64,/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwc",
              "enrollmentBranch": "",
              "enrollmentInstitution": "WEMA BANK",
              "mobile": "08138493645",
              "dateOfBirth": "1998-06-22",
              "isConsent": true,
              "idNumber": "22553780729",
              "nin": null,
              "shouldRetrivedNin": true,
              "businessId": "6222fac719fab43e133f0d44",
              "type": "bvn",
              "allValidationPassed": true,
              "gender": "",
              "requestedAt": "2023-01-19T22:31:48.360Z",
              "requestedById": "6222fac719fab4c11a3f0d40",
              "country": "NG",
              "createdAt": "2023-01-19T22:31:48.373Z",
              "lastModifiedAt": "2023-01-19T22:31:48.373Z",
              "requestedBy": {
                "firstName": "API",
                "lastName": "User",
                "middleName": "",
                "id": "6222fac719fab4c11a3f0d40"
              }
            },
            "validated": true,
            "__type": "identity",
            "_id": "63c9c4d38a056c9508b7afda",
            "label": "Identity",
            "fieldTemplateId": "63c9bfe20b8e96ec3b652dad",
            "type": "bvn",
            "value": "22553780729",
            "id": "63c9c4d38a056c9508b7afda"
          }
        ],
        "validated": true,
        "__type": "reference",
        "_id": "63c9c46b25efdd1b621bf835",
        "label": "Reference Field Label",
        "fieldTemplateId": "63c9c2d30b8e962a52652de1",
        "referenceTemplateId": "63c9bfdb0b8e96183b652da5",
        "email": "[e-mail]",
        "id": "63c9c46b25efdd1b621bf835"
      }
    ],
    "totalVerifications": 9,
    "fillDurationInMilliSeconds": 287278,
    "createdAt": "2023-01-19T22:30:03.521Z",
    "updatedAt": "2023-01-19T22:31:48.907Z",
    "__v": 0,
    "_createdAt": "2023-01-19T22:30:033+00:00",
    "_lastModifiedAt": "2023-01-30T18:20:1111+00:00",
    "id": "63c9c46b25efdd314e1bf823"
  },
  "links": []
}

The Webhook Attributes

This section contains object samples for all possible webhook events, as well as explanations for each in the Explanation tab.

CWB Added

 {
  "event": "vForm.added",
  "apiVersion": "v1",
  "data": {...}
}

CWB Updated

{
  "event": "vForm.updated",
  "apiVersion": "v1",
  "data": {...}
}

CWB Completed

{
  "event": "vForm.completed",
  "apiVersion": "v1",
  "data": {...}
}

Explanation

Attributes	Type	Description
event	String	This represents the status of a webhook entry. Which can be one of the following: "vForm.added": when there is a new response entry. This comes with a data object that contains the response. "vForm.updated": when there is an update on an old entry. The data object will be updated. "vForm.completed": when all updates are completed on an old entry. Usually when all verifications have been processed. The data object will be updated for the last time , containing the full response and full verification details
apiVersion	String	The webhook version

The Data Object

This object is made up of attributes that provide general information about the form entry. It also contains the field array, which consists of response objects for each section of the form.

The Sample and Explanation tabs below show a sample object as well as explanations for the attributes.

Sample

{
  ...
  "data": {
    "accessId": null,
    "ipAddress": null,
    "completedVerifications": 9,
    "status": "not_cleared",
    "billingItemComponents": [
      "vform",
      "aml",
      "facial_compare",
      "drivers_license",
      "id_capture",
      "facial_compare",
      "passport",
      "id_capture",
      "facial_compare",
      "drivers_license",
      "facial_compare",
      "inec",
      "company_search",
      "company_search"
    ],
    "transactionDetails": {
      "transactionReference": "63c9c46bb48f6ae9d46bc2f6",
      "transactionId": "63c9c46bb48f6a667b6bc2f7",
      "amountCharged": 1480,
      "currency": "NGN",
      "availableBalance": 463050,
      "availableCredit": 0
    },
    "upsertFrequency": 0,
    "_id": "63c9c46b25efdd314e1bf823",
    "businessId": "6222a5ed3e7a41c29c031ecc",
    "userId": "62346b6b283d48fb58b57e8e",
    "templateId": "63c967d725efdd42541bf668",
    "sharedId": null,
    "field":[{..},{...},....],
    "totalVerifications": 9,
    "fillDurationInMilliSeconds": 287278,
    "createdAt": "2023-01-19T22:30:03.521Z",
    "updatedAt": "2023-01-19T22:31:48.907Z",
    "__v": 0,
    "_createdAt": "2023-01-19T22:30:033+00:00",
    "_lastModifiedAt": "2023-01-30T18:20:1111+00:00",
    "id": "63c9c46b25efdd314e1bf823"
    }

Explanation

Attribute	Type	Description
id	String	vForm's object unique identifier.
businessId	String	This is the unique identifier of the business that created the vForm.
userId	String	This is the unique identifier of the user that created the vForm ,a vForm business can have multiple usersThis is the unique identifier of the business that created the vForm.
billingItemComponents	Array	This is a list of all the features (such as liveness check, facial compare, and id capture) and verifications that the vform's owner included while configuring the form and are intended to be paid for. This can include one or more of the following based on the configuration . "phonenumber","drivers_license","bvn","nin" "passport","inec","bav","aml","address_verification","vform" "livenesss","facial_compare","id_capture" and "company_search"
transactionDetails	Object	This object contains details about the amount charged and deducted after the submission of this response as configured by the owner.
transactionId	String	TransactionDetail's object unique identifier.
amountCharged	Integer	Amount charged for this response.
currency	String (CountryCode)	Currency in which the charge was made.
availableBalance	Integer	Available balance in the vForm business account.
totalVerifications	Integer	The total number of verifications that vForm is expected to perform on this response.
completedVerifications	Integer	The total number of verifications vForm has completed on this response.
fields	Array of Objects	List of objects for each section of the form that contains responses from the person filling out the form and can contain a report on the responses after vform performs verifications and validations on them as specified by the form owner. Each section can be one of the following specified by __type in each objects. personal-information, identity, company-search, address, file-upload , reference ,supplementary-field , consent-verification.
fillDurationInMilliSeconds	Integer	The amount of time the person spent filling out the form in milliseconds.
createdAt	String (Date)	The date this response was submitted.
updatedAt	String (Date)	The date this response was last updated.
status	String	This is the overall status of this response which can be anyone of the following "pending": This is the overall status of a response when there is/are still a/some verification(s) to be done on the response or when some responses are still expected from a reference form. "cleared": This is the overall status of the response when a form with no verification has been submitted or when all the verifications and validations have been performed by vform on a response and are all passed "not_cleared": This is the overall status of the response when one or more of the verifications and validations performed by vform on a response failed. "pending_payment": When payment is still pending, no verification will be done.

The Fields Array

List of objects for each section of the form that contains responses from the person filling out the form and can contain a report on the responses after CWB performs verifications and validations on them as specified by the form owner.

Each section can be one of the following specified by the __type attribute in each objects. personal-information, identity, company-search, address, file-upload , reference ,supplementary-field , consent-verification.

{
  ...
  "data":{
   ...
   "field":[
   {
     ...
     "__type":"consent-verification",
   },
   {
     ...
     "__type":"personal-information",
   },
   {
     ...
     "__type":"identity",
   },
   {
     ...
     "__type":"company-search",
   },
   {
     ...
     "__type":"file-upload",
   },
   {
     ...
     "__type":"address",
   },
   {
     ...
     "__type":"reference",
   },
   {
     ...
     "__type":"supplementary-field",
   },
          ],
   
}

Consent verification field object

The Sample and Explanation tabs below show a sample object as well as explanations for the attributes in the consent-verification field object.

Sample

{
 ...
 "field":[
    {
      "value": true,
      "validated": true,
      "__type": "consent-verification",
      "_id": "63c9c46b25efddb7491bf825",
      "label": "Request Verification Consent",
      "fieldTemplateId": "63c967d725efdd359a1bf663",
      "id": "63c9c46b25efddb7491bf825"
    },
    ...
    ]
  ...
}

Explanation

Attribute	Type	Description
__type	String	A vform-defined tag for this section of the form. It has a constant value of consent-verification.
id	String	Consent verification's object unique identifier.
label	String	A short descriptive title for the consent verification section of the form usually set by the form owner
value	Boolean	A true or false value indicating whether or not the formfiller accepts the conditions of the consent.

Personal Information field object

This object stores the user's personal information; there may be one or more personal information fields, any of which can also be linked to identity or address fields by the form owner to serve as the default personal information for performing validations.

The Sample and Explanation tabs below show a sample object as well as explanations for the attributes in the personal-information field object.

Sample

{
 ...
 "field":[
    ...
    {
      "middleName": "Yin",
      "email": "[e-mail]",
      "dateOfBirth": "2023-01-01T00:00:00.000Z",
      "gender": "MALE",
      "mobile": "[phone]",
      "photo": "https://cdn.youverify.co/1674167402807-VlZyzrQ6CB85EMb01s58Z.jpg",
      "relationship": "wife",
      "validated": true,
      "__type": "personal-information",
      "_id": "63c9c46b25efddb6391bf826",
      "label": "User Information Field Label",
      "fieldTemplateId": "63c967d725efdd78b21bf662",
      "firstName": "John",
      "lastName": "Doe",
      "amlCheck": {
        "report": {
          "status": "cleared",
          "parentId": null,
          "isSubjectConsent": true,
          "middleName": "TEST",
          "pepList": [],
          "sanctionList": [],
          "firstName": "John",
          "lastName": "Doe",
          "businessId": "6222fac719fab43e133f0d44",
          "requestedAt": "2023-01-19T22:30:07.324Z",
          "requestedById": "6222fac719fab4c11a3f0d40",
          "createdAt": "2023-01-19T22:30:07.336Z",
          "lastModifiedAt": "2023-01-19T22:30:07.336Z",
          "_createdAt": "2023-01-19T22:30:077+00:00",
          "_lastModifiedAt": "2023-01-19T22:30:077+00:00",
          "id": "63c9c46dd80a7bfb6e9f1560",
          "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "6222fac719fab4c11a3f0d40"
          }
        },
        "status": "cleared",
        "_id": "63d80a5b74738c257c3e4bfd"
      },
      "id": "63c9c46b25efddb6391bf826"
    },
    ...
    ]
  ...
}

Explanation

Attribute	Type	Description
__type	String	A vform-defined tag for this section of the form. It has a constant value of personal-information. This tag appears on all sections that accepts personal information from the formfiller.
id	String	Personal information's object unique identifier.
label	String	A short descriptive title for the personal information section of the form usually set by the form owner
firstName	String	A mandatory first name, usually the formfiller's or as specified by the form owner in the section's label or description. Example: If the formfiller is filling out a section that requires his/her guarantor or guardian's first name
lastName	String	A mandatory last name, usually the formfiller's or as specified by the form owner in the section's label or description. Example: If the formfiller is filling out a section that requires his/her guarantor or guardian's last name/surname
email	String(email)	An email address , usually the formfiller's or as specified by the form owner in the section's label or description. Example: If the formfiller is filling out a section that requires his/her guarantor or guardian's email This can be optional or required as set by the form owner
gender	String	Gender, usually the formfiller's or as specified by the form owner in the section's label or description. Example: If the formfiller is filling out a section that requires his/her guarantor or guardian's gender This can be optional or required as set by the form owner.
photo	String(url)	image, usually the formfiller's or as specified by the form owner in the section's label or description. Example: If the formfiller is filling out a section that requires his/her guarantor or guardian's photo This can be optional or required asset by the form owner.
relationship	String	Personal relationship, which can be one of the following "brother","sister","father","mother","wife","husband","other". This is usually based on the context that is specified by the form owner in the section label or description. Example: If the formfiller is filling out a section that requires his/her relationship with his/her guarantor or guardian's This can be optional or required as set by the form owner.
mobile	String(phone)	Phone number, usually the formfiller's or as specified by the form owner in the section's label or description. Example:If the formfiller is filling out a section that requires his/her guarantor or guardian's phone number This can be optional or required as set by the form owner.
middleName	String	Middle name, usually the formfiller's or as specified by the form owner in the section's label or description. Example: If the formfiller is filling out a section that requires his/her guarantor or guardian's middle name This can be optional or required as set by the form owner.
dateOfBirth	String(date)	Date of birth, usually the formfiller's or as specified by the form owner in the section's label or description. Example: If the formfiller is filling out a section that requires his/her guarantor or guardian's date of birth This can be optional or required as set by the form owner.
amlCheck	Object	This contains reports and status from vform when the form owner wants vform to perform an anti-money laundering(aml) check on the personal information field (firstname and lastname). This objects is not available if an aml check is not performed
-- report	Object	This is the report from the aml check.
-- status	String	This is the status from the aml check which can be anyone of the following "cleared": When the form filler's name is not in aml list "review_required": "not_cleared": When the form filler's name is in aml list

Identity field object

The Sample and Explanation tabs below show a sample object as well as explanations for the attributes in the identity field object.

Sample

{
 ...
 "field":[
    ...   
     {
      "typeCountryCode": "NG",
      "firstName": "John",
      "lastName": "Doe",
      "dateOfBirth": "2023-01-01T00:00:00.000Z",
      "photo": "https://cdn.youverify.co/1674167402807-VlZyzrQ6CB85EMb01s58Z.jpg",
      "identityCardPhotoFront": "",
      "identityCardPhotoBack": "",
      "livenessCheckSnapshot": null,
      "status": "found",
      "report": {
        "id": "63c9c46fdd95fcd7fc3c7f69",
        "validations": {
          "data": {
            "lastName": {
              "validated": false,
              "value": "Doe"
            },
            "dateOfBirth": {
              "validated": false,
              "value": "2023-01-01"
            },
            "firstName": {
              "validated": false,
              "value": "John"
            }
          },
          "selfie": {
            "selfieVerification": {
              "confidenceLevel": 25,
              "threshold": 80,
              "match": false,
              "image": "https://cdn.youverify.co/1674167402807-VlZyzrQ6CB85EMb01s58Z.jpg"
            }
          },
          "validationMessages": "First name does not match, Last name does not match, Date of birth does not match, Provided image does not match ID image"
        },
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": true,
        "selfieValidation": true,
        "firstName": "John",
        "middleName": null,
        "lastName": "Doe",
        "expiredDate": "2024-04-25",
        "issuedDate": "2019-04-29",
        "stateOfIssuance": "LAGOS",
        "notifyWhenIdExpire": false,
        "image": "data:image/jpg;base64,/9j/4AAQSkZJRgABAQEBOgE6AAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjI",
        "mobile": null,
        "email": null,
        "dateOfBirth": "1981-04-25",
        "isConsent": true,
        "idNumber": "KJA08031BA51",
        "businessId": "6222fac719fab43e133f0d44",
        "type": "ndl",
        "allValidationPassed": false,
        "gender": "male",
        "requestedAt": "2023-01-19T22:30:08.539Z",
        "requestedById": "6222fac719fab4c11a3f0d40",
        "country": "NG",
        "createdAt": "2023-01-19T22:30:08.552Z",
        "lastModifiedAt": "2023-01-19T22:30:08.552Z",
        "requestedBy": {
          "firstName": "API",
          "lastName": "User",
          "middleName": "",
          "id": "6222fac719fab4c11a3f0d40"
        }
      },
      "validated": false,
      "__type": "identity",
      "_id": "63c9c46b25efdd64831bf829",
      "label": "Identity Field Label",
      "fieldTemplateId": "63c9c1bfeb600fc087807329",
      "type": "drivers-license",
      "value": "Kja08067aa01",
      "id": "63c9c46b25efdd64831bf829"
    },
    ...
    ]
  ...
}

Explanation

Attribute	Type	Description
__type	String	A vform-defined tag for this section of the form. It has a constant value of identity.This tag appears on all sections that accepts identity information from the formfiller.
id	String	Identity object unique identifier.
typeCountryCode	String(countryCode)	The country code under which the identity card was issued. This might also be the province/region code the identity card was issued.
firstName	String	This is the first name from the personal information field linked/set to this identity field by the form owner for vform to perform validations against. The first personal information field is the default if none was linked by the form owner. The first name is null if validations was not to be performed on it.
lastName	String	This is the last name from the personal information field linked/set to this identity field by the form owner for vform to perform validations against. The first personal information field is the default if none was linked by the form owner. The last name is null if validations was not to be performed on it.
label	String	A short descriptive title for the identity section of the form usually set by the form owner
dateOfBirth	String(date)	This is the date of birth from the personal information field linked/set to this identity field by the form owner for vform to perform validations against. The first personal information field is the default if none was linked by the form owner. The date of birth is null if validations was not to be performed on it.
identityCardPhotoFront	String(url)	The captured identity card's front image. If the identity number was manually entered, this will be an empty string.
identityCardPhotoBack	String(url)	The captured identity card's back image. If the identity number was manually entered, this will be an empty string.
photo	String(url)	This is the photo from the personal information field linked/set to this identity field by the form owner for vform to perform validations against. The first personal information field is the default if none was linked by the form owner. The photo is null if validations was not to be performed on it.
value	String	The identity number that was entered manually or extracted from the captured identity card. This can be optional or required as set set by the form owner.
type	String	The identity card type . Example: Passport, ID Card, Residence Permit, Driving License. e.t.c
report	Object	This contains reports generated by vform when the form owner requests that vform perform verification and validations on the identity number. This will be null if no verification is to be conducted or if the verification is already in progress.
status	String	This is the status of the verification and validation conducted on the identity number by vForm. which can be anyone of the following. "not_applicable": When no verification is performed. "pending": When the verification is in process. "found": When the identity number is found in the official database. "not_found": When the identity number is not found in the official database.

Business Search field object

The Sample and Explanation tabs below show a sample object as well as explanations for the attributes in the company-search field object.

Sample

 {
 ...
 "field":[
    ...   
       {
      "companyName": null,
      "registeredName": null,
      "companyAddress": null,
      "supportEmail": null,
      "supportPhoneNumber": null,
      "countryCode": "NG",
      "status": "found",
      "report": {
        "parentId": null,
        "searchBusinessName": null,
        "name": "THINK HAT SERVICES LIMITED",
        "formerName": null,
        "registrationNumber": "RC1733970",
        "registryNumber": "1733970",
        "vatNumber": "23739807-0001",
        "registrationDate": "2020-11-12T00:00:00.000+00:00",
        "registrationSubmissionDate": "2020-11-04T14:57:00.210+00:00",
        "dateDisolved": null,
        "tin": "23739807-0001",
        "jtbTin": null,
        "taxOffice": null,
        "email": "[e-mail]",
        "phone": null,
        "websiteEmail": null,
        "typeOfEntity": "PRIVATE COMPANY LIMITED BY SHARES",
        "activity": "GENERAL CONTRACT AND MERCHANDISE",
        "address": "NO. 220, FREEDOM WAY, LEKKI PHASE 1, ",
        "state": "LAGOS",
        "lga": "Lagos Island",
        "city": "LEKKI",
        "branchAddress": "NO. 220, FREEDOM WAY, LEKKI PHASE 1, , LEKKI, LAGOS STATE ",
        "headOfficeAddress": null,
        "objectives": null,
        "status": "found",
        "companyStatus": "INACTIVE",
        "isConsent": true,
        "lastUpdatedAt": "2022-10-07T14:27:18.767+00:00",
        "shareCapitalInWords": "ONE MILLION NAIRA",
        "paidShareCapital": "1000000",
        "subscribedShareCapital": "1000000",
        "sharesValue": "1 NGN",
        "activityDescription": "GENERAL CONTRACT AND MERCHANDISE",
        "sharesIssued": "1000000",
        "parentCountry": null,
        "companyContactPersons": [
          {
            "contacts": {
              "email": ["[e-mail]"],
              "phone": ["08030810838"]
            },
            "name": "Sokari Blessing Boma "
          }
        ],
        "country": "Nigeria",
        "countryCode": "NG",
        "keyPersonnel": [
          {
            "name": "Sokari Blessing Boma",
            "designation": "PRESENTER",
            "isCorporate": false,
            "appointedOn": null,
            "resignedOn": null,
            "sharesType": null,
            "sharesValue": null,
            "sharesCount": null,
            "occupation": null,
            "nationality": null,
            "birthYear": null,
            "birthMonth": null,
            "birthDate": null,
            "dateOfBirth": "1990-08-29T23:00:00.000+00:00",
            "gender": "MALE",
            "address": null,
            "countryOfResidence": "NIGERIA",
            "number": null,
            "isForeign": "false",
            "documentType": "National Identification Number",
            "documentIssuedOn": null,
            "documentIssuedBy": null,
            "documentNumber": null,
            "email": "[e-mail]",
            "phone": "08030810838",
            "status": "ACTIVE",
            "companies": []
          },
        ],
        "activities": [],
        "legalEntityIdentifierRegister": [],
        "centralIndexKeyRegister": [],
        "filings": [],
        "affiliates": [],
        "businessId": "6222fac719fab43e133f0d44",
        "type": "advance_company_check",
        "requestedAt": "2023-01-19T22:30:12.862Z",
        "requestedById": "6222fac719fab4c11a3f0d40",
        "searchTerm": "RC1733970",
        "createdAt": "2023-01-19T22:30:12.978Z",
        "lastModifiedAt": "2023-01-19T22:30:12.978Z",
        "_createdAt": "2023-01-19T22:30:1212+00:00",
        "_lastModifiedAt": "2023-01-19T22:30:1212+00:00",
        "id": "63c9c46f7eb0a0dff6186872",
        "requestedBy": {
          "firstName": "API",
          "lastName": "User",
          "middleName": "",
          "id": "6222fac719fab4c11a3f0d40"
        }
      },
      "validated": true,
      "__type": "company-search",
      "_id": "63c9c46b25efdd34851bf82b",
      "label": "Business Search",
      "fieldTemplateId": "63c9b83feb600f5ea88072ab",
      "type": "registrationNumber",
      "value": "RC1733970",
      "id": "63c9c46b25efdd34851bf82b"
    },
     ...
    ]
  ...
}
    

Explanation

Attribute	Type	Description
__type	String	A vform-defined tag for this section of the form. It has a constant value of company-search. This tag appears on all sections that accepts business/company information from the formfiller.
id	String	Business-search's object unique identifier.
countryCode	String(countryCode)	The company country code,which specifies where the business search is to be performed by vForm.
companyName	String	The company's name This can be optional or required as set by the form owner.
companyAddress	String	The company's address This can be optional or required as set by the form owner.
registeredName	String	The business's registered name. This is required in order to perform a company search with vform.
label	String	A short descriptive title for the business search section of the form usually set by the form owner
supportEmail	String(email)	The business support email. This can be optional or required as set by the form owner.
supportPhoneNumber	String(email)	The business support phone number This can be optional or required as set by the form owner.
value	String	The company registration number. This is required in order to perform a company search with vform.
type	String	This is always registrationNumber
report	Object	This contains reports generated by vform when the form owner requests that vform perform a business verification on the business registered name. This will be null if no business search is to be conducted or if the verification is already in progress.
status	String	This is the status of the business search conducted on the business by vForm. which can be anyone of the following. "not_applicable": When no verification is performed. "pending": When the verification is in process. "found": When the business registration number is found in the official database. "not_found": When the business registration number is not found in the official database.

File Upload field object

The Sample and Explanation tabs below show a sample object as well as explanations for the attributes in the file-upload field object.

Sample

{
 ...
 "field":[
    ...   
      {
        "name": "1674127188116",
        "size": 7028,
        "status": "completed",
        "validated": true,
        "__type": "file-upload",
        "_id": "63c9c46b25efdd8ca01bf82d",
        "label": "File Upload Field Label",
        "fieldTemplateId": "63c9bb3aeb600f3a9b8072d4",
        "url": "https://cdn.youverify.co/1674167402808-PgGVBkErMmR9ihSmIFTcR.jpg",
        "fileType": "jpg",
        "id": "63c9c46b25efdd8ca01bf82d"
      },
       ...
    ]
  ...
}  

Explanation

Attribute	Type	Description
__type	String	A vform-defined tag for this section of the form. It has a constant value of file-upload.This tag appears on all sections that accepts file uploads from the formfiller.
id	Strnig	File upload's object unique identifier.
name	String	Uploaded file name
size	Integer	Uploaded file size
label	String	A short descriptive title for the file upload section of the form usually set by the form owner
fileType	String	Uploaded file type. This can be one of the following png, jpg, jpeg, pdf, ppt, pptx, doc, docx, xls, xlsx
url	String(url)	Uploaded file url
status	String	This shows the status of the file upload. which is always "completed"

Supplementary field object

The Sample and Explanation tabs below show a sample object as well as explanations for the attributes in the supplementary-field field object.

Sample

 {
 ...
 "field":[
    ...
    {
      "value": ["Omah Lay"],
      "options": [],
      "status": "completed",
      "validated": true,
      "__type": "supplementary-field",
      "_id": "63c9c46b25efdd41b21bf82e",
      "label": "What's your name",
      "fieldTemplateId": "63c9bcb1e05ace51e6f8cbba",
      "type": "text",
      "format": "short",
      "id": "63c9c46b25efdd41b21bf82e"
    }, 
    {
      "value": ["Option 2"],
      "options": ["Option 1", "Option 2", "Option 3"],
      "status": "completed",
      "validated": true,
      "__type": "supplementary-field",
      "_id": "63c9c46b25efdd92a91bf82f",
      "label": "pick one",
      "fieldTemplateId": "63c9bd3ce05ace819ff8cbd0",
      "type": "radio",
      "format": "short",
      "id": "63c9c46b25efdd92a91bf82f"
    },
    {
      "value": ["Option 1"],
      "options": ["Option 1", "Option 2", "Option 3"],
      "status": "completed",
      "validated": true,
      "__type": "supplementary-field",
      "_id": "63c9c46b25efdde77c1bf830",
      "label": "pick one",
      "fieldTemplateId": "63c9bd460b8e960d56652d85",
      "type": "dropdown",
      "format": "short",
      "id": "63c9c46b25efdde77c1bf830"
    },
    {
      "value": ["Option 3"],
      "options": ["Option 1", "Option 2", "Option 3"],
      "status": "completed",
      "validated": true,
      "__type": "supplementary-field",
      "_id": "63c9c46b25efdd67821bf831",
      "label": "pick one or more",
      "fieldTemplateId": "63c9bd4f25efdd5ce11bf7ca",
      "type": "dropdown",
      "format": "short",
      "id": "63c9c46b25efdd67821bf831"
    },
    {
      "value": ["2023-01-23"],
      "options": ["Option 1", "Option 2", "Option 3"],
      "status": "completed",
      "validated": true,
      "__type": "supplementary-field",
      "_id": "63c9c46b25efdd1f261bf832",
      "label": "Date of Birth",
      "fieldTemplateId": "63c9bd59e05ace78fdf8cbd7",
      "type": "date",
      "format": "short",
      "id": "63c9c46b25efdd1f261bf832"
    },
    {
      "value": [
        "It’s difficult to say without more information about what the code is supposed to do and what’s happening when it’s executed. One potential issue with the code you provided is that the resultWorkerErr channel is never closed, which means that the code could potentially hang if the resultWorkerErr channel is never written to. This could happen if b.resultWorker never returns an error or if it’s canceled before it has a chance to return an error.\n\nTo fix this issue, you could close the resultWorkerErr channel after writing to it. For example, you could add the following line of code after the line that sends the error on the channel:"
      ],
      "options": ["Option 1", "Option 2", "Option 3"],
      "status": "completed",
      "validated": true,
      "__type": "supplementary-field",
      "_id": "63c9c46b25efdd82021bf833",
      "label": "Explain yourself",
      "fieldTemplateId": "63c9bd650b8e9643b2652d8c",
      "type": "text",
      "format": "long",
      "id": "63c9c46b25efdd82021bf833"
    },
    ...
    ]
  ...
}  

Explanation

Attribute	Type	Description
__type	String	A vform-defined tag for this section of the form. It has a constant value of supplementary-field. This tag appears on all sections that accepts other neccessary information from the formfiller.
id	String	Supplement field's object unique identifier.
options	Arrays	This contains the available options if the question needs the formfiller to select one.
label	String	A question that the form owner wants the formfiller to respond to
value	Array	The formfiller's response(s) to the form owner's question.
type	String	The expected type of the supplied response(s). which can be anyone of the following . "text", "date", "checkbox", "dropdown","radio"
format	String	The format of the supplied response. This can be "long" or "short" for text response , "daymonth" or "monthday" for date response and null for other response
status	String	This shows the status of the supplementary field which is always "completed"

Reference field object

The Sample and Explanation tabs below show a sample object as well as explanations for the attributes in the reference field object.

Sample

{
 ...
 "field":[
    ...    
    {
      "firstName": "John",
      "lastName": "Doe",
      "status": "cleared",
      "fields": [{...},{...},...],
      "validated": true,
      "__type": "reference",
      "_id": "63c9c46b25efdd1b621bf835",
      "label": "Reference Field Label",
      "fieldTemplateId": "63c9c2d30b8e962a52652de1",
      "referenceTemplateId": "63c9bfdb0b8e96183b652da5",
      "email": "[e-mail]",
      "id": "63c9c46b25efdd1b621bf835"
    }
    ...
    ]
  ...
}  

Explanation

Attribute	Type	Description
__type	String	A vform-defined tag for this section of the form. It has a constant value of reference. This tag appears on all sections that accept and contains responses from a referenced form .
id	String	Reference field's object unique identifier.
firstName	String	Referenced form filler's firstname
lastName	String	Referenced form filler's lastname
label	String	A short descriptive title for the reference section of the form usually set by the form owner
fields	Array of Objects	List of objects for each section of the form that contains responses from the person filling out the referenced form and can contain a report on the responses after vform performs verifications and validations on them as specified by the form owner. Each section can be one of the following specified by __type in each objects. personal-information, identity, company-search, address, file-upload ,supplementary-field, consent-verification .
email	String(email)	Referenced form filler's email
status	String	This is the overall status of this referenced form response which can be anyone of the following. "pending": This is the overall status of a response when there is/are still a/some verification(s) to be done on the response. "cleared": This is the overall status of the response when a form with no verification has been submitted or when all the verifications and validations have been performed by vform on a response and are all passed. "not_cleared": This is the overall status of the response when one or more of the verifications and validations performed by vform on a response failed. "pending_payment":

Address field object

The Sample and Explanation tabs below show a sample object as well as explanations for the attributes in the address field object.

Sample

{
 ...
 "field":[
    ... 
     {
        "candidate": {
          "middleName": null,
          "dateOfBirth": null,
          "email": null,
          "firstName": "John",
          "lastName": "Doe",
          "mobile": "34556666654",
          "image": "https://cdn.youverify.co/1659017656259-I87Q6mTD0qJ1pTJyCoz5j.png"
        },
        "guarantor": {
          "firstName": null,
          "lastName": null,
          "email": null,
          "mobile": null,
          "image": null
        },
        "business": {
          "name": null,
          "registrationNumber": null,
          "email": null,
          "mobile": null
        },
        "address": {
          "flatNumber": "",
          "buildingName": "Sum House",
          "subStreet": "",
          "lga": "Yaba-Alagomeji",
          "country": "NG",
          "buildingNumber": "350",
          "landmark": "  Bukka House",
          "street": "Bornu Way",
          "city": "Lagos-Mainland",
          "state": "Lagos"
        },
        "status": "not_applicable",
        "taskStatus": "NOT_APPLICABLE",
        "description": "To enter the estate, a security pin is required.",
        "report": null,
        "validated": true,
        "__type": "address",
        "_id": "62e299b98fbe590c099b43c2",
        "label": "Address",
        "fieldTemplateId": "62e282388fbe5975b39b423a",
        "type": "individual",
        "id": "62e299b98fbe590c099b43c2"
      }
      ...
    ]
  ...
}  

Explanation

Attribute	Type	Description
__type	String	A vform-defined tag for this section of the form. It has a constant value of address.This tag appears on all sections that accept address information from the formfiller.
id	String	Address field's object unique identifier.
label	String	A short descriptive title for the address section of the form usually set by the form owner
candidate	Object	This object contains personal information about the person who resides/works at the house/business address.
-- middleName	String	This is the middle name from the personal information field linked/set to this address field by the form owner to serve as the address subject. The first personal information field is the default if none was linked by the form owner .
-- dateOfBirth	String	This is the date of the birth from the personal information field linked/set to this address field by the form owner to serve as the address subject. The first personal information field is the default if none was linked by the form owner .
-- email	String(email)	This is the email address from the personal information field linked/set to this address field by the form owner to serve as the address subject. The first personal information field is the default if none was linked by the form owner .
-- firstName	String	This is the first name from the personal information field linked/set to this address field by the form owner to serve as the address subject. The first personal information field is the default if none was linked by the form owner .
-- lastName	String	This is the last name from the personal information field linked/set to this address field by the form owner to serve as the address subject. The first personal information field is the default if none was linked by the form owner .
-- mobile	String(phone)	This is the phone number from the personal information field linked/set to this address field by the form owner to serve as the address subject. The first personal information field is the default if none was linked by the form owner .
-- image	String(url)	This is the name from the personal information field linked/set to this address field by the form owner to serve as the address subject. The first personal information field is the default if none was linked by the form owner .
guarantor	Object	This object contains information about the guarantor. If the address type is not "guarantor" the attributes will be null.
-- firstName	String	Guarantor's first name
-- lastName	String	Guarantors last name
-- email	String(email)	Guarantor's email
-- mobile	String(phone)	Guarantor's phone number
-- image	String(url)	Guarantor's image
business	Object	This object contains the information about the business If the address type is not "business" the attributes will be null.
-- name	String	Business name
-- registrationNumber	String	Business registration number
-- email	String(email)	Business email address
-- mobile	String(phone)	Business phone number
address	Object	This object contains the address details
-- flatNumber	String	Flat number
-- buildingName	String	Building name
-- subStreet	String	Address sub street
-- lga	String	Address local government area
-- country	String(countryCode)	Address country
-- buildingNumber	String	Building number
-- landmark	String	Address closest landmark
-- street	String	Address street
-- city	String	Address city
-- state	String	Address state
type	String	The type of address set by the form owner which can be one of the following : "individual","business","guarantor"
description	String	Any other information about the address the formfiller wants vForm to know
taskStatus	String
status	String	This is the status of the address verification conducted on the address details by vForm which can be anyone of the following. "not_applicable": when no verification is performed. "pending": When the verification is in process. "completed": When the verification is completed. "payment_pending": When address verification payment is still pending, no verification will be done . "awaiting_reschedule": When the address verification process has been reschedule. "canceled": When the address verifcation process has been canceled.
report	Object	This contains reports from vform when the form owner requests that vform perform an address verification on the addres This will be null if no address verification is to be conducted or if the verification is already in progress.