Vertueal Docs
Authentic Profile

API Overview & Envelopes

Conventions, base URLs, uniform response envelopes, and error taxonomy for the Authentic Profile API.

API Overview & Conventions

The Authentic Profile REST API is served over HTTPS and communicates exclusively via JSON formatted payloads.

1. Environments & Base URLs

EnvironmentBase URL
Productionhttps://authenticprofile.com/api
Sandbox / Staginghttps://staging.authenticprofile.com/api
Local Developmenthttp://localhost:3000/api

2. Standard Response Envelope

Every endpoint wraps its payload in a consistent top-level JSON structure.

2.1. Success Envelope (2xx)

{
  "success": true,
  "data": { ... },
  "error": null,
  "meta": {
    "requestId": "req_881a2f4c",
    "timestamp": "2026-09-19T01:30:00Z"
  }
}

2.2. Error Envelope (4xx, 5xx)

{
  "success": false,
  "data": null,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Please slow down.",
    "details": [
      {
        "field": "client_ip",
        "issue": "window quota exceeded"
      }
    ]
  },
  "meta": {
    "requestId": "req_881a2f4c",
    "timestamp": "2026-09-19T01:30:00Z"
  }
}

3. HTTP Status Codes & Error Catalogue

Status CodeCode StringDescription
200 OK—Successful request.
201 Created—Resource created successfully.
400 Bad RequestVALIDATION_FAILEDMalformed JSON or invalid schema parameters.
401 UnauthorizedUNAUTHORIZEDMissing or invalid API key or Bearer token.
403 ForbiddenFORBIDDENInsufficient scope or permissions.
404 Not FoundRESOURCE_NOT_FOUNDProfile or ticket ID does not exist.
429 Too Many RequestsRATE_LIMIT_EXCEEDEDRequest limit hit. Follow Retry-After header.
500 Internal ErrorINTERNAL_ERRORServer exception.

4. Rate Limiting Headers

All API responses include rate limit status headers:

X-RateLimit-Limit: 120
X-RateLimit-Remaining: 114
X-RateLimit-Reset: 1726703400

Third-Party Ecosystem Integrations

Integration blueprints for recruitment networks, e-commerce marketplaces, and social platforms, including legal protocols.

TrustLinks API Reference

Submit, manage, and batch-verify links and social accounts on behalf of users through AuthenticProfile's trusted verification engine.

On this page

API Overview & Conventions1. Environments & Base URLs2. Standard Response Envelope2.1. Success Envelope (2xx)2.2. Error Envelope (4xx, 5xx)3. HTTP Status Codes & Error Catalogue4. Rate Limiting Headers