---
title: "Identify user"
method: POST
path: "/topper/kyc-sharing/identify-user"
tags: ["KYC sharing"]
---

# Identify user

`POST /topper/kyc-sharing/identify-user`

## Request

- Base URL: `https://api.enterprise.sandbox.uphold.com`
- URL: `https://api.enterprise.sandbox.uphold.com/topper/kyc-sharing/identify-user`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/core/oauth2/token` scopes: `topper.kyc-sharing:identify-user`
- TypeScript: <https://skmtc.dev/uphold/apis/topper-api/docs/topper/kyc-sharing/identify-user/post.ts> (a function with typed inputs; its response is checked against the schema)

Identify a user for KYC sharing.

## Headers

- `X-Uphold-User-Ip` union
  - string, ipv4
  - string, ipv6
- `X-Uphold-User-Agent` string
- `X-Uphold-User-Origin` string
- `X-Uphold-User-Country` string
- `X-Uphold-User-Subdivision` string
- `X-Uphold-User-City` string

## Request body

- object
  - `email` string, email, required: The email address.
  - `country` string, required: The country of residency.

## Response `200`

User identified.

- KycSharingUser
  - `user` object, required
    - `id` string, uuid, required: The id of the user.
    - `email` string, email, required: The email address of the user.

## Other responses

- `201`: User created.
- `400`: Bad Request.
- `401`: Unauthorized.
- `403`: Forbidden.
- `409`: Business logic error.
- `429`: Too Many Requests.

---

[API](https://skmtc.dev/uphold/apis/topper-api.md) - [All operations](https://skmtc.dev/uphold/apis/topper-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uphold/apis/topper-api/revisions/78127cd773a3?raw)