Turn email addresses into avatars and profiles
Your users already made a photo and a profile on Avatarak. With one image URL or one API call, turn plain signups into personalised welcomes.
Quick start
Show a user's photo in two lines: hash the email and put the URL in an img tag.
<img src="https://avatarak.ir/avatar/<sha256-of-email>?s=96"
width="96" height="96" alt="">
Topics
Get started
Getting started
What Avatarak.ir does, and the two ways to integrate it: an avatar URL and a REST API.
Get started
Creating the identifier (hash)
How to turn an email address into the SHA-256 hash used by every URL.
Avatars
Avatars
The avatar URL, its parameters, defaults, caching and CORS behaviour.
REST API
Authentication
Create an API key for your site and send it with each request.
REST API
API reference
Endpoints, request and response formats, data model and errors of the REST API.
REST API
Webhooks
Get a signed HTTP request whenever your profile changes, and how to verify it.
REST API
Libraries (PHP and JavaScript)
Official PHP and JavaScript clients, a Laravel integration and a drop-in web component.
Public data
Public profile data
JSON, Markdown, vCard, QR code, printable business card and an embeddable card for every public profile, with no API key.
Public data
Verified accounts
How users prove they own a website, a GitHub or a Telegram account, and how to run the Telegram bot yourself.
Policies
Plans and limits
What each plan includes, how payments work, and what changes when a plan ends.
Policies
Privacy and limits
What we never expose, the rate limits, and how to use the service responsibly.
Self-hosting
Deployment
Run Avatarak.ir on your own server with Docker: configuration, HTTPS, email, CDN, backups and updates.
Self-hosting
Administration
The admin area: creating administrators, moderating users and reports, managing API keys, and the audit log.