# Shared profile (/ui/candidate-shared-profile)

## What it shows [#what-it-shows]

A profile as the person it was shared with sees it.

## Props [#props]

| Prop | Type | What it does |
| --- | --- | --- |
| `person` (required) | `CandidateSharedProfilePerson` | Who the profile is about. |
| `anonymised` | `boolean` | Shows nobody. The name, the avatar, the cover and the profile link are never drawn, even when `person` carries them, the switcher names nobody, and the Yes or No and the note field say `labels.anonymousReference`. Everything else is drawn as passed, so the host redacts what an employer's name or a note gives away. |
| `eyebrow` | `ReactNode` | Above everything, such as the search or the role the person was shared for. |
| `people` | `readonly CandidateSharedProfilePersonOption[]` | The people the link shares, for a link that shares several. With fewer than two there is no switcher. |
| `personId` | `string` | Which of `people` this profile is. |
| `onPersonChange` | `(id: string) => unknown` | Called with the person picked in the switcher; the host shows their profile. While a promise it returns is pending the switcher says who is opening, and it, the Yes or No and the note field are held. |
| `openingPersonId` | `string \| null` | The person whose profile is on its way, for a host that knows it some other way than that promise. It holds the same controls. |
| `archived` | `boolean` | The link has been archived: a notice says so above the profile, which dims. For whoever can still see an archived profile, such as the person who shared it. |
| `voiceNote` | `CandidateSharedProfileRecording \| null` | A spoken note from whoever shared the profile. |
| `note` | `CandidateSharedProfileWrittenNote \| null` | A written note from them. |
| `fit` | `CandidateSharedProfileAssessment \| null` | How well the person fits the role they were shared for. |
| `summary` | `ReactNode` | A summary of the person. A string keeps its line breaks. |
| `experience` | `readonly CareerHistoryItem[]` | Their career, newest first, as `CandidateCareerHistoryTimeline` takes it. |
| `experienceOptions` | `Pick<CandidateCareerHistoryTimelineProps, "detailedCompanyGroups" \| "earlierLabel" \| "presentLabel" \| "locale">` | How the career is drawn, as `CandidateCareerHistoryTimeline` takes it. |
| `education` | `readonly CandidateSharedProfileEducationItem[]` | Their education. |
| `skills` | `readonly ReactNode[]` | Their skills, a tag each. |
| `certifications` | `readonly ReactNode[]` | Their certifications, a line each. |
| `languages` | `readonly ReactNode[]` | The languages they speak, a line each. |
| `children` | `ReactNode` | Further sections of the host's own, under the profile's, usually `CandidateSharedProfileSection`s. |
| `decision` | `CandidateDecisionChoice \| null` | The reader's Yes or No on the person, once they have given one. |
| `decisionReason` | `ReactNode` | The reader's own reason for it, shown under the answer. |
| `onDecide` | `(decision: CandidateDecisionChoice, reason: string) => Promise<void>` | Saves the reader's Yes or No with their reason, as `CandidateSharedProfileAnswer` takes it. Without it the profile has no Yes or No: it shows an answer already given, and nothing where there is none. |
| `reasonOptional` | `boolean` | Lets the answer be saved with no reason. A reason is required without it. |
| `reasonSuggestions` | `{ yes?: readonly string[]; no?: readonly string[]; }` | One-tap reasons for each answer, already worded. |
| `reasonPrompt` | `CandidateClientDecisionProps["reasonPrompt"]` | How the reason is asked for: typed in a dialog (the default), or voice first in a sheet. |
| `reasonSheet` | `CandidateClientDecisionProps["reasonSheet"]` | The sheet's own settings for `reasonPrompt="sheet"`, as `CandidateClientDecision` takes them. |
| `clientNotes` | `readonly CandidateSharedProfileClientNote[]` | The notes the reader has left on the person, in the order to show them. |
| `onAddNote` | `(text: string) => Promise<void>` | Saves a note from the reader, as `CandidateSharedProfileNotes` takes it. Without it the profile takes no notes: it shows the ones given, and nothing where there are none. |
| `noteVoice` | `boolean` | `false` leaves dictation out of the note field. |
| `noteMaxLength` | `number` | The longest note the field takes. |
| `readOnly` | `boolean` | The profile as its reader sees it, for someone who can't act for them: the answer and the notes show, and none can be given. |
| `credit` | `ReactNode` | A closing line inside the profile, such as who shared it. It isn't printed. |
| `titleLevel` | `CandidateProfileHeaderTitleLevel` | The name's heading level: 1 (the default) for a profile that is the page, or 2 to 4 under a page that has its own h1. The sections sit one level under it. |
| `renderAudio` | `(audio: CandidatePresentationRecorderAudio) => ReactNode` | Renders the spoken note's player. Defaults to the browser's own audio controls. |
| `labels` | `Partial<CandidateSharedProfileLabels>` |   |
| `decisionLabels` | `Partial<CandidateClientDecisionLabels>` | The Yes or No row's wording, as `CandidateClientDecision` takes it. |
| `id` | `string` |   |
| `className` | `string` |   |
| `style` | `CSSProperties` |   |

## Data it needs [#data-it-needs]

The component takes plain values and callbacks and keeps no records of its own. Pass it yours, from the Kith data layer or from a backend you already run.

## Copy to your agent [#copy-to-your-agent]

```text title="Copy to your agent"
Install RecruiterOS/recruit-ui and add a shared candidate profile page where my client says yes or no and leaves notes.
```