Get identity data by email or phone (admin)

GET

https://api.vlenseg.com/api/DigitalIdentity/GetUserDigitalIdentityData

GET

/api/DigitalIdentity/GetUserDigitalIdentityData

$ curl -G https://api.vlenseg.com/api/DigitalIdentity/GetUserDigitalIdentityData \
>      -H "ApiKey: <apiKey>" \
>      -H "Content-Type: application/json" \
>      --data-urlencode emailOrPhoneNumber=ahmed.mohamed@example.com

200Retrieved

1 {
2   "data": {
3     "idFront": {
4       "fullName": "Ahmed Mohamed Ali",
5       "nationalIdNumber": "28504123456789",
6       "dateOfBirth": "1985-04-12",
7       "gender": "Male",
8       "nationality": "Egyptian",
9       "expiryDate": "2030-04-11",
10       "photoUrl": "https://api.vlenseg.com/images/idfront/28504123456789.jpg"
11     },
12     "idBack": {
13       "address": "123 Nile Street, Cairo, Egypt",
14       "issueDate": "2020-04-12",
15       "placeOfIssue": "Cairo",
16       "fatherName": "Mohamed Ali",
17       "motherName": "Fatma Hassan",
18       "maritalStatus": "Married",
19       "signatureUrl": "https://api.vlenseg.com/images/idback/signature_28504123456789.png"
20     }
21   }
22 }

Returns OCR-extracted ID data for any user identified by email or phone number. Requires ApiKey and an admin bearer token.

Authentication

ApiKeystring

Static API key issued to your tenant. Required on every request.

AuthorizationBearer

Admin JWT from /api/credentials/Login. Required for admin operations.

Query parameters

emailOrPhoneNumberstringRequired

Response

ID front and back OCR fields.

dataobjectOptional