Vertueal Docs
Authentic Profile

Profiles API

REST endpoints for querying, searching, and validating public and business profiles.

Profiles API

The Profiles API allows relying parties to inspect verified identities, work experience, education, and digital credentials.


1. Retrieve a Profile by Username

Retrieves complete verified profile data for an individual or business.

GET /api/profiles/{username}

Request Headers

Accept: application/json
x-api-key: YOUR_API_KEY

Path Parameters

ParameterTypeRequiredDescription
usernamestringYesThe unique handle of the profile (e.g. alex-mercer, acme-corp).

Response Example (200 OK)

{
  "success": true,
  "data": {
    "id": "64f1a2b3c4d5e6f7a8b9c0d1",
    "username": "alex-mercer",
    "profileType": "individual",
    "personalInfo": {
      "firstName": "Alex",
      "lastName": "Mercer",
      "title": "Principal Architect",
      "email": "alex@authenticprofile.com",
      "bio": "Building high-scale verified identity infrastructure.",
      "avatar": "https://kfysrcdqszgkmusaiigh.supabase.co/storage/v1/object/public/files/avatars/alex.webp",
      "bannerImage": "https://kfysrcdqszgkmusaiigh.supabase.co/storage/v1/object/public/files/banners/alex-banner.webp"
    },
    "workExperience": [
      {
        "id": "exp_01",
        "company": "Enterprise Tech",
        "position": "Staff Engineer",
        "startDate": "2021-01-01",
        "current": true,
        "verified": true,
        "verificationStatus": "verified"
      }
    ],
    "education": [
      {
        "id": "edu_01",
        "institution": "Stanford University",
        "degree": "Master of Science",
        "fieldOfStudy": "Computer Science",
        "startDate": "2018-09-01",
        "endDate": "2020-06-01",
        "verified": true,
        "verificationStatus": "verified"
      }
    ],
    "isPublished": true,
    "viewsCount": 1420
  },
  "error": null,
  "meta": {
    "requestId": "req_1082c9",
    "timestamp": "2026-09-19T01:31:00Z"
  }
}

2. Search Verified Profiles Directory

Search public profiles across categories and keywords.

GET /api/featured-profiles?category=technology&limit=10

Query Parameters

ParameterTypeRequiredDefaultDescription
categorystringNo—Filter by profile category (e.g., technology, healthcare, finance).
limitnumberNo20Number of profiles to return (max 100).
cursorstringNo—Cursor for paginated results.

On this page