GuidesAPI ReferenceChangelogHelp
API Reference

Compose Full Name

post
https://apibeta.familysearch.org/platform/names/segments

Compose a full name from its parts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The locale to be used for the composition.

Body Params
persons
array of objects
required
length ≥ 1

Array containing the person with the name to be composed. At least one person is required.

persons*
names
array of objects
required
length ≥ 1

Array of names for the person. At least one name is required.

names*
nameForms
array of objects
required
length ≥ 1

Array of name forms. At least one name form is required.

nameForms*
string

The language and script code for the name form (e.g., ru-Latn for Russian in Latin script, ru-Cyrl for Russian in Cyrillic script).

string

The full text of the name.

parts
array of objects

Array of name parts (e.g., given name, surname).

parts
Responses
200

If the name was successfully composed from the provided name parts.

400

If there is a problem with the provided data about the name.

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated about 1 month ago

Did this page help you?