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"
    }
}

Status
Description

approved

All the verifications tied to sync has been processed and verified

processing

Some of the verifications tied to the sync is still in review

rejected

Some of the verifications tied to the sync was rejected after review

failed

Verifications tied to the sync failed

{
    "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"
    }
}
PreviousWebhooks

Last updated