---
title: "Get companion"
method: GET
path: "/api/persons/{personId}/companions/{companionId}"
tags: ["person-controller"]
---

# Get companion

`GET /api/persons/{personId}/companions/{companionId}`

## Request

- Base URL: `https://api.myverifly.com`
- URL: `https://api.myverifly.com/api/persons/{personId}/companions/{companionId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/myverifly/apis/api-documentation/docs/api/persons/:personId/companions/:companionId/get.ts> (a function with typed inputs; its response is checked against the schema)

Get companion from the repository.

## Path parameters

- `companionId` string, required
- `personId` string, required

## Response `200`

OK

- CompanionResponse
  - `createdDtm` TimestampRes
    - `date` integer
    - `day` integer
    - `hours` integer
    - `minutes` integer
    - `month` integer
    - `nanos` integer
    - `seconds` integer
    - `time` integer
    - `timezoneOffset` integer
    - `year` integer
  - `expiringDtm` TimestampRes
    - `date` integer
    - `day` integer
    - `hours` integer
    - `minutes` integer
    - `month` integer
    - `nanos` integer
    - `seconds` integer
    - `time` integer
    - `timezoneOffset` integer
    - `year` integer
  - `firstName` string: First name
  - `href` string: href
  - `id` string: ID
  - `lastName` string: lastName
  - `lastUpdatedDtm` TimestampRes
    - `date` integer
    - `day` integer
    - `hours` integer
    - `minutes` integer
    - `month` integer
    - `nanos` integer
    - `seconds` integer
    - `time` integer
    - `timezoneOffset` integer
    - `year` integer
  - `personId` string: personId
  - `privateInfo` PrivateInfo
    - `attributes` Attribute[]
      - `credentialAttributeName` string
      - `credentialAttributeValue` string
      - `credentialType` string

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Unexpected error in processing the request.

---

[API](https://skmtc.dev/myverifly/apis/api-documentation.md) - [All operations](https://skmtc.dev/myverifly/apis/api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/myverifly/apis/api-documentation/revisions/03f300608c33?raw)