> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.vlenseg.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.vlenseg.com/_mcp/server.

# 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.

#### [PII inquiry without OTP](/fra-services/pii-inquiry)

One call. Use it when you do not need to prove the user controls the phone number.

#### [PII inquiry with OTP](/fra-services/pii-inquiry-otp)

Send a code to the phone number first, so ownership is proven before the inquiry runs.

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:

```http
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

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

```json
{
  "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](#check-user-status).

#### cURL

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

| Parameter     | In    | Required | Description                |
| ------------- | ----- | -------- | -------------------------- |
| `phoneNumber` | query | No       | The phone number to check. |