Sync
A synchronisation is a connection of a user verification data with a merchant
Synchronisation State
Sync has a different status that determines the state of the verifications, I will be listing everything below and their descriptions
A sample webhook payload
{
"event": "sync.success",
"data": {
"metadata": {
"userId": "a021bf83"
},
"id": "a021bf83-519f-4df1-87bc-a867382417df",
"reason": null,
"flow": {
"id": "3ea0117e-e04c-4d22-aec9-08fd5b2ab2da",
"reference": "flw_Xgjh4q7vpQ",
"name": "Document and Biometric verification"
},
"verifications": [...],
"status": "approved",
"createdAt": "2024-02-04T20:49:50.875Z",
"updatedAt": "2024-02-04T20:49:50.875Z"
}
}{
"id": "6dff9f53-c7b0-4dec-a44c-0e651148cd60",
"metadata": {
"userId": "0e651148cd60"
},
"reason": null,
"status": "approved",
"deviceFingerprint": {
"device": {
"os": {
"name": "Mac OS",
"version": "10.15.7"
},
"ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36",
"cpu": {},
"agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36",
"device": {
"model": "Macintosh",
"vendor": "Apple"
},
"engine": {
"name": "Blink",
"version": "121.0.0.0"
},
"browser": {
"name": "Chrome",
"major": "121",
"version": "121.0.0.0"
}
},
"location": {
"eu": "0",
"ip": "2001:8f8:1927:34dc:8593:716d:9fbc:26ae",
"ll": [
24,
54
],
"area": 100,
"city": "",
"metro": 0,
"range": "",
"region": "",
"country": "AE",
"timezone": "Asia/Dubai"
}
},
"createdAt": "2024-02-07T14:38:45.799Z",
"updatedAt": "2024-02-07T14:38:45.799Z",
"verifications": [
{
"id": "c9dc4500-f573-49c9-b485-813f6524ef17",
"reference": "vrf_Dg5J19Kmw6",
"idNumber": "11XXXXXXX",
"firstName": "John",
"lastName": "Doe",
"middleName": "Mark",
"phone": null,
"email": null,
"dateOfBirth": "1999-03-31",
"age": null,
"sex": "M",
"country": "AE",
"nationality": "NGA",
"issuedDate": null,
"expiryDate": "2024-11-28",
"aml": {
...
},
"amlRisk": "",
"address": null,
"assets": [
{
"iso": "AE",
"url": "https://verisync-production.s3.eu-west-2.amazonaws.com/247cede1-60f2-4ad8-8f70-d30b42f3e0c6-ID%20Front.jpeg",
"type": "national-id",
"filename": "ID Front.jpeg",
"stateCode": ""
},
{
"iso": "AE",
"url": "https://verisync-production.s3.eu-west-2.amazonaws.com/4dc16cc4-32be-4b81-838b-b2cd3a7e9883-ID%20Back.jpeg",
"type": "national-id",
"filename": "ID Back.jpeg",
"stateCode": ""
}
],
"channel": "web",
"active": true,
"message": null,
"reverifyReason": null,
"reverifiedAt": null,
"verifiedAt": "2024-02-07T14:41:39.634Z",
"deviceFingerprint": {
"ip": "13.42.70.11",
"ua": "axios/1.4.0",
"origin": "",
"vpnDetectionEnabled": false
},
"status": "approved",
"createdAt": "2024-02-07T14:38:09.316Z",
"updatedAt": "2024-02-07T14:41:38.395Z"
}
],
"user": {
"id": "65344a57-385d-485a-b486-d9ff67fb8559",
"firstName": "John",
"lastName": "Doe",
"middleName": "Mark",
"email": "mail@gmail.com",
"phone": "+234904182XXXX",
"status": "active",
"emailVerifiedAt": "2024-02-07T14:34:47.543Z",
"phoneVerifiedAt": "2024-02-07T14:35:37.964Z",
"createdAt": "2024-02-07T14:34:47.550Z",
"updatedAt": "2024-02-11T13:43:53.780Z"
},
"flow": {
"id": "3ea0117e-e04c-4d22-aec9-08fd5b2ab2da",
"name": "Document verification",
"reference": "flw_Xgjh4q7vpQ",
"status": "active",
"configurations": {},
"createdAt": "2024-02-01T17:25:22.410Z",
"updatedAt": "2024-02-01T17:25:22.410Z"
}
}{
"event": "sync.success",
"data": {
"metadata": {
"userId": "739e940b7ace"
},
"id": "4fabe9c7-c86a-4410-a7fe-739e940b7ace",
"reason": null,
"flow": {
"id": "59067480-4345-4dc5-b978-4e9b9ade5a2b",
"reference": "flw_XaT0WL8m8w",
"name": "BVN Verification"
},
"verifications": [
{
"id": "aac4cfc8-bc98-462f-82d9-8cf6cd74c95b",
"reference": "vrf_F0USuycwOy",
"idNumber": "224XXXXXXXX",
"firstName": "ABDULFATAI",
"lastName": "SULEIMAN",
"middleName": "",
"phone": "0816184XXXX",
"email": null,
"dateOfBirth": "16-01-2XXX",
"age": null,
"sex": "Male",
"country": "NG",
"nationality": null,
"issuedDate": null,
"expiryDate": null,
"aml": null,
"amlRisk": null,
"address": null,
"assets": [
{
"name": "Document_ID",
"value": "22476977855"
},
{
"name": "First_name",
"value": "Abdulfatai"
},
{
"name": "Last_name",
"value": "Suleiman"
}
],
"channel": "web",
"active": true,
"message": null,
"reverifyReason": null,
"reverifiedAt": null,
"verifiedAt": "2024-02-01T19:37:27.565Z",
"deviceFingerprint": {
"ip": "13.42.70.11",
"ua": "axios/1.4.0",
"origin": "",
"vpnDetectionEnabled": false
},
"status": "approved",
"createdAt": "2024-02-01T19:36:01.413Z",
"updatedAt": "2024-02-01T19:37:26.285Z",
"identity": {
"id": "1030a9d1-4db9-46e9-bbb0-b82d1abdc2f4",
"reference": "id_gZuJ86PSEe",
"name": "Bank Verification Number",
"slug": "bvn",
"description": "Verify your Bank Verification Number",
"recomended": false,
"type": "foundational",
"category": "document-verification",
"active": true,
"status": "approved",
"createdAt": "2024-01-30T20:25:02.912Z",
"updatedAt": "2024-01-30T20:25:02.912Z"
},
"bvn": "224XXXXXXXX",
"gender": "Male"
}
],
"status": "approved",
"createdAt": "2024-02-03T09:15:21.301Z",
"updatedAt": "2024-02-03T09:15:21.301Z"
}
}{
"id": "6dff9f53-c7b0-4dec-a44c-0e651148cd60",
"metadata": {
"userId": "0e651148cd60"
},
"reason": null,
"status": "approved",
"deviceFingerprint": {
"device": {
"os": {
"name": "Mac OS",
"version": "10.15.7"
},
"ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36",
"cpu": {},
"agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36",
"device": {
"model": "Macintosh",
"vendor": "Apple"
},
"engine": {
"name": "Blink",
"version": "121.0.0.0"
},
"browser": {
"name": "Chrome",
"major": "121",
"version": "121.0.0.0"
}
},
"location": {
"eu": "0",
"ip": "2001:8f8:1927:34dc:8593:716d:9fbc:26ae",
"ll": [
24,
54
],
"area": 100,
"city": "",
"metro": 0,
"range": "",
"region": "",
"country": "AE",
"timezone": "Asia/Dubai"
}
},
"createdAt": "2024-02-07T14:38:45.799Z",
"updatedAt": "2024-02-07T14:38:45.799Z",
"verifications": [
{
"id": "3eae4c02-2da7-4498-9c6c-4b9e7ab9142f",
"reference": "vrf_X0tm9QGg1",
"idNumber": "57749XXXXXX",
"firstName": "John",
"lastName": "Doe",
"middleName": "-",
"phone": "07035620046",
"email": "-",
"dateOfBirth": "16-01-2000",
"age": null,
"sex": "m",
"country": "NG",
"nationality": "-",
"issuedDate": null,
"expiryDate": null,
"aml": null,
"amlRisk": null,
"address": null,
"assets": [
{
"name": "Document_ID",
"value": "57749XXXXXX"
},
{
"name": "First_name",
"value": "John"
},
{
"name": "Last_name",
"value": "Doe"
}
],
"channel": "web",
"active": true,
"message": null,
"reverifyReason": null,
"reverifiedAt": null,
"verifiedAt": "2024-02-26T10:15:00.377Z",
"deviceFingerprint": {
"ip": "13.42.70.11",
"ua": "axios/1.4.0",
"origin": "",
"vpnDetectionEnabled": false
},
"status": "approved",
"createdAt": "2024-02-26T10:14:16.290Z",
"updatedAt": "2024-02-26T10:14:58.379Z",
"identity": {
"id": "95a225b4-f4be-4138-9feb-b9cc86c7115f",
"reference": "id_uTESIvbz9",
"name": "National Identification Number",
"slug": "nin",
"description": "Verify your National Identification Number",
"recomended": false,
"type": "foundational",
"category": "document-verification",
"active": true,
"status": "approved",
"createdAt": "2024-02-08T19:00:08.442Z",
"updatedAt": "2024-02-08T19:00:08.442Z"
},
"nin": "57749XXXXXX",
"vnin": "-",
"title": "mr",
"gender": "m",
"height": "-",
"heigth": "156",
"religion": "islam",
"centralID": "32620355",
"nextOfKin": {
"lga": "lga",
"town": "toqn",
"state": "state",
"address1": "address1",
"address2": "",
"lastName": "Doe",
"firstName": "John",
"middleName": "-"
},
"residence": {
"lga": "lga",
"state": "state",
"address1": "address1"
},
"profession": "STUDENT",
"trackingId": "S7Y0NYFHD0006RA",
"lgaOfOrigin": "-",
"nspokenlang": "language",
"birthCountry": "-",
"maritalStatus": "single",
"placeOfOrigin": "-",
"stateOfOrigin": "-",
"educationalLevel": "secondary",
"employmentStatus": "unemployed"
}
],
"user": {
"id": "65344a57-385d-485a-b486-d9ff67fb8559",
"firstName": "John",
"lastName": "Doe",
"middleName": "Mark",
"email": "mail@gmail.com",
"phone": "+2349041XXXXXX",
"status": "active",
"emailVerifiedAt": "2024-02-07T14:34:47.543Z",
"phoneVerifiedAt": "2024-02-07T14:35:37.964Z",
"createdAt": "2024-02-07T14:34:47.550Z",
"updatedAt": "2024-02-11T13:43:53.780Z"
},
"flow": {
"id": "3ea0117e-e04c-4d22-aec9-08fd5b2ab2da",
"name": "NIN verification",
"reference": "flw_Xgjh4q7vpQ",
"status": "active",
"configurations": {},
"createdAt": "2024-02-01T17:25:22.410Z",
"updatedAt": "2024-02-01T17:25:22.410Z"
}
}Last updated