Overview
Random Identity works by generating random names, addresses, and other personal information. It returns the generated identity in a structured format.
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl "https://api.apiverve.com/v1/randomidentitygenerator?count=5&includeAvatar=true" \
-H "x-api-key: your_api_key_here"const res = await fetch('https://api.apiverve.com/v1/randomidentitygenerator?count=5&includeAvatar=true', {
headers: { 'x-api-key': 'your_api_key_here' },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.get(
"https://api.apiverve.com/v1/randomidentitygenerator?count=5&includeAvatar=true",
headers={"x-api-key": "your_api_key_here"},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/randomidentitygenerator?count=5&includeAvatar=true", nil)
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent in the query string. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
countOptionalPremium | integer | The number of identities to create default 1 · range 1–100 |
includeAvatarOptionalPremium | boolean | Include an AI-generated face avatar for each identity |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"count": 1,
"identities": [
{
"name": "Dr. Brent Carter",
"username": "Fannie_Treutel28",
"email": "Greyson.DAmore99@hotmail.com",
"phone": "862-207-2982 x6455",
"website": "mervin.net",
"company": {
"name": "Runolfsson, Gaylord and Christiansen",
"catchPhrase": "Profit-focused didactic algorithm",
"bs": "brand ubiquitous paradigms"
},
"gender": "Male",
"birthdate": "1978-11-23",
"cell": "1-514-413-1724",
"avatar": "https://storage.googleapis.com/apiverve/APIResources/faces/Male/40-50/87654321.jpg?X-Goog-Signature=..."
}
]
}
}Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
count | number | 1 | Total number of identities generated in response |
identities | array[1] | Array containing all generated random identity objects | |
name | string | "Dr. Brent Carter" | Full name of the generated random identity |
username | string | "Fannie_Treutel28" | Username associated with generated identity |
email | string | "Greyson.DAmore99@hotmail.com" | Email address for the generated random identity |
phone | string | "862-207-2982 x6455" | Landline phone number of generated identity |
website | string | "mervin.net" | Website URL associated with generated identity |
company | object | {...} | Company information object for generated identity |
namePremium | string | "Runolfsson, Gaylord and Christiansen" | Name of the company associated with identity |
catchPhrasePremium | string | "Profit-focused didactic algorithm" | Marketing catchphrase for company |
bsPremium | string | "brand ubiquitous paradigms" | Business statement or tagline for company |
gender | string | "Male" | Gender of the generated random identity |
birthdatePremium | string | "1978-11-23" | Birth date in YYYY-MM-DD format for identity |
cell | string | "1-514-413-1724" | Mobile cell phone number of generated identity |
avatarPremium | string | "https://storage.googleapis.com/apiverve/APIResources/faces/Male/40-50/87654321.jpg?X-Goog-Signature=..." | URL to an AI-generated face avatar matching the identity's gender and age |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- Data Generation
- Use the Random Identity Generator API to generate random identities for data generation. Use the data to create test data, populate databases, and develop applications
- Privacy Protection
- Generate random identities by using the Random Identity Generator API for privacy protection. Use the data to mask personal information, safeguard user data, and enhance security
- Content Creation
- Create content by using the Random Identity Generator API to generate random identities. Use the data to develop characters, write stories, and produce media content
Other ways to use Random Identity Generator
Set up Random Identity Generator on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in Data Generation: