FRA Services

The FRA Services API (/api/FRAServices/) validates personally identifiable information and reports verification status by checking against national records via the Financial Regulatory Authority (FRA).

Start here

A PII inquiry is the main thing this API does: you send a national ID plus a phone number, and Vlens tells you whether they match the national records. There are two ways to run it — pick one.

Both variants hit the same two endpoints and return the same response. The OTP variant simply adds one preceding call and two request fields.

Whichever you pick, you can supply the ID either as base64 images or as an existing transactionId from an earlier OCR or Digital Identity capture.

Base URL and authentication

https://api.vlenseg.com/api/FRAServices/

Every request requires:

ApiKey: YOUR_TENANT_API_KEY
Authorization: Bearer YOUR_ACCESS_TOKEN

Check user status

Returns the authenticated user’s digital identity verification status, email confirmation, and phone-owner match result.

curl "https://api.vlenseg.com/api/FRAServices/CheckUserStatus" \
  -H "ApiKey: YOUR_API_KEY" \
  -H "Authorization: Bearer TOKEN"

{
  "data": {
    "isDigitalIdentityVerified": true,
    "isEmailConfirmed": true,
    "csoOutput": {
      "isValid": true,
      "errorCode": 0,
      "errorMessage": null
    },
    "phoneNumberOwnerOutput": {
      "isMatched": true,
      "errorCode": 0,
      "errorKey": null,
      "errorMessage": null
    },
    "isVerified": true,
    "status": 1
  },
  "error_code": 0,
  "error_message": null
}

Check PII for user

Looks up verification status for a given phone number. Returns the same response shape as Check user status.

curl "https://api.vlenseg.com/api/FRAServices/CheckPiiForUser?phoneNumber=PHONE_NUMBER" \
  -H "ApiKey: YOUR_API_KEY" \
  -H "Authorization: Bearer TOKEN"