Skip to main content

Generate Profile Name

Endpoint

GET /v1/profiles/{profileId}/profile-name

Description

Generates a human-readable name for the specified profile using its available data (such as extracted name fields or other identifiers).
This is useful for automatically assigning display names to anonymous or system-generated profiles.

Although this is a GET endpoint externally, it internally forwards the request to a POST method.


Request

Path Parameters

ParameterTypeRequiredDescription
profileIdstringThe ID of the profile to name.

Headers

HeaderRequiredDescription
AuthorizationBearer YOUR_API_KEY

Success Response — 200 OK

{
"id": "up_2caed28f18c34d83982e3bcd9cffbb96",
"created": "2025-07-03T10:20:52.0773442Z",
"object": "update_profile",
"status": "completed"
}