PII inquiry with OTP: submit ID images | Vlens

curl -X POST https://api.vlenseg.com/api/FRAServices/PersonallyIdentifiableInformation \
     -H "ApiKey: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "idBackBase64Image": "<string>",
  "idFrontBase64Image": "<string>",
  "phoneNumber": "01000000000",
  "otpRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "otpCode": 123456
}'

{
  "data": {
    "phoneNumberOwnerOutput": {
      "isMatched": true,
      "errorCode": 0,
      "errorKey": null,
      "errorMessage": null
    },
    "idFrontOutput": {
      "services": {
        "Validations": {
          "validation_errors": []
        },
        "spoofing": {
          "fake": false
        },
        "classification": {
          "doc_type": "id_front"
        },
        "liveness": null,
        "AML": {
          "AML_matched": false,
          "data": []
        },
        "SRC": null
      },
      "data": {
        "name": "محمد على حسن ابراهيم",
        "first_name": "محمد",
        "last_names": "على حسن ابراهيم",
        "name_english": "Mohamed Ali Hassan Ibrahim",
        "first_name_english": "Mohamed",
        "last_names_english": "Ali Hassan Ibrahim",
        "idNumber": "29001011234567",
        "idKey": "AB1234567",
        "dateOfBirth": "1990-01-01T00:00:00",
        "gender": null,
        "govern": "القاهرة",
        "govern_english": "Cairo",
        "city": "القاهرة",
        "district": "المعادي",
        "address": "١٢ شارع النيل-المعادي القاهرة",
        "address_1": "١٢ شارع النيل",
        "address_2": "المعادي القاهرة",
        "address_english": "12 Nile Street-Maadi Cairo",
        "address_1_english": "12 Nile Street",
        "address_2_english": "Maadi Cairo",
        "client_transaction_id": null,
        "request_id": "00000000-0000-0000-0000-000000000000",
        "transaction_id": "9c1f0e2a-7b3d-4f5a-8c6e-1d2b3a4c5d6e"
      },
      "error_code": null,
      "error_message": null,
      "error_descriptions": null
    },
    "idBackOutput": {
      "services": {
        "Validations": {
          "validation_errors": []
        },
        "spoofing": {
          "fake": false
        },
        "classification": {
          "doc_type": "id_back"
        },
        "liveness": null,
        "AML": null,
        "SRC": null
      },
      "data": {
        "maritalStatus": "متزوج",
        "marital_status_english": "married",
        "job": "مهندس",
        "job_english": "Engineer",
        "jobTitle": "",
        "job_title_english": null,
        "religion": "مسلم",
        "religion_english": "muslim",
        "husbandName": "",
        "husbandName_english": null,
        "releaseDate": "2023-04-01T00:00:00",
        "idExpiry": "2030-04-29T00:00:00",
        "idNumber": "29001011234567",
        "gender": "ذكر",
        "gender_english": "male",
        "client_transaction_id": null,
        "request_id": "00000000-0000-0000-0000-000000000000",
        "transaction_id": "9c1f0e2a-7b3d-4f5a-8c6e-1d2b3a4c5d6e"
      },
      "error_code": null,
      "error_message": null,
      "error_descriptions": null
    },
    "csoOutput": {
      "isValid": true,
      "errorCode": 0,
      "errorMessage": null
    },
    "criminalRecordValidationOutput": null
  },
  "error_code": null,
  "error_message": null,
  "error_descriptions": null
}

Submits front/back ID images and a phone number for validation against national records, with phone-number ownership proven by a one-time password.

Call POST /api/FRAServices/RequestOtpForPii first to send the code and get an otpRequestId, then send it here together with the otpCode the user received.

Same URL as the no-OTP variant — the only difference is that otpRequestId and otpCode are present. They travel together: send both, or send neither and use the no-OTP variant.

Submits front/back ID images and a phone number for validation against national records, with phone-number ownership proven by a one-time password. Call `POST /api/FRAServices/RequestOtpForPii` first to send the code and get an `otpRequestId`, then send it here together with the `otpCode` the user received. Same URL as the no-OTP variant — the only difference is that `otpRequestId` and `otpCode` are present. They travel together: send both, or send neither and use the [no-OTP variant](/api-reference/vlens-api/fra-services/post-fraservices-personallyidentifiableinformation).

Authentication

ApiKeystring

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

AuthorizationBearer

End-user JWT from registration or login. Required for verification, signing, and user-scoped operations.

Request

This endpoint expects an object.

idBackBase64ImagestringRequired

idFrontBase64ImagestringRequired

phoneNumberstringRequired

otpRequestIdstringRequiredformat: "uuid"

The otpRequestId returned by POST /api/FRAServices/RequestOtpForPii.

otpCodeintegerRequired

The OTP the user received, sent as a JSON number (123456), not a string.

Response

PII inquiry result.

dataobjectOptional

error_codeinteger or nullOptional

error_messagestring or nullOptional

error_descriptionslist of strings or nullOptional