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": "OMA@TEST.COM",
"dateOfBirth": "2023-01-01T00:00:00.000Z",
"gender": "MALE",
"mobile": "+38781237458549",
"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": "nkiru.emina@thinkhatfirm.com",
"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": ["sokari.boma@yahoo.com"],
"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": "sokari.boma@yahoo.com",
"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": "sokari.boma@yahoo.com",
"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": "nkiru.emina@thinkhatfirm.com",
"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": "nkiru.emina@thinkhatfirm.com",
"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": "marie.emina@thinkhatfirm.com",
"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": "marie.emina@thinkhatfirm.com",
"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": "marie.emina@thinkhatfirm.com",
"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": "sokari.boma@yahoo.com",
"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": "yideci9913@fom8.com",
"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": {