For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retrieve an Identity

This endpoint allows the user to retrieve an already verified identity.

Identity Verification

GET {{baseurl}}/v2/api/identity/:identityId

Headers

Name
Type
Description

token*

String

API secret token

HTTP/1.1 200 OK
{
        "success": true,
        "statusCode": 200,
        "message": "Identity retrieved successfully!",
        "data": {
            "validations": {
                "data": {
                    "lastName": {
                        "validated": true,
                        "value": "Ehichioya"
                    },
                    "dateOfBirth": {
                        "validated": true,
                        "value": "2000-01-01"
                    },
                    "firstName": {
                        "validated": true,
                        "value": "Famous"
                    }
                },
                "selfie": {
                    "selfieVerification": {
                        "confidenceLevel": 94,
                        "match": true,
                        "image": "https://cdn.youverify.co/262731241627-dvahka4o4vDxfvQUJgZFo.jpg"
                    }
                },
                "validationMessages": ""
            },
            "parentId": "612ce40ab8919f39faf7ae49",
            "status": "found",
            "dataValidation": true,
            "selfieValidation": true,
            "firstName": "FAMOUS",
            "middleName": null,
            "lastName": "EHICHIOYA",
            "expiredDate": "2026-04-04T00:00:00.000Z",
            "issuedDate": "2021-05-26T00:00:00.000Z",
            "stateOfIssuance": "LAGOS",
            "notifyWhenIdExpire": false,
            "image": "data:image/jpg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKD",
            "mobile": null,
            "email": null,
            "dateOfBirth": "2000-01-01",
            "isConsent": true,
            "idNumber": "SMK86220xxxx",
            "businessId": "619b683ecb55a2a588f4b83c",
            "type": "ndl",
            "gender": "male",
            "requestedAt": "2021-12-13T13:57:38.542Z",
            "country": "NG",
            "createdAt": "2021-12-13T13:57:38.722Z",
            "lastModifiedAt": "2021-12-13T13:57:38.722Z",
            "id": "61b7514b193d2e7807f42152",
            "requestedBy": {
                "firstName": "Famous",
                "lastName": "Ehichioya",
                "middleName": "",
                "id": "619b683ecb55a2a588f4b83d"
            }
        },
        "links": []
    }

Last updated

Was this helpful?