---
title: "Get a list of external references"
method: GET
path: "/v2/individuals/{entityId}/externalreferences"
tags: ["Individual Entity Elements"]
---

# Get a list of external references

`GET /v2/individuals/{entityId}/externalreferences`

Get a list of an individual's external references.

## Headers

- `api_key` string, required
- `X-Frankie-CustomerID` string, required
- `X-Frankie-CustomerChildID` string
- `X-Frankie-Channel` string
- `X-Frankie-Username` string

## Response `200`

OK

- object
  - `requestId` string — The unique request identifier for the API call made.
  - `externalReferences` ExternalReference[]
    - `referenceId` string — As external references are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify an external reference, include the referenceId in an update request for the individual.
    - `type` 'SYSTEM' | 'CUSTOMER' | 'OTHER'
    - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map.
    - `name` string, required — The name of the external reference.
    - `value` string, required — The value of the external reference.
    - `description` string — A summary of what this external reference is and what it is used for.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error
- `502` — Bad Gateway
- `503` — Service Unavailable

---

[API](https://skmtc.net/frankieone/apis/kyc-v2-api.md) · [All operations](https://skmtc.net/frankieone/apis/kyc-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/frankieone/kyc-v2-api/revisions/880b27506cbb/schema)