> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Identify user

> Identify a user for KYC sharing.

export const RestEndpointSubjects = ({subjects = []}) => {
  const subjectToIconMap = {
    'client': 'browser',
    'user:individual': 'user',
    'user:business': 'briefcase'
  };
  if (subjects.length === 0) {
    return null;
  }
  return <>
      {subjects.map(subject => <a key={subject} href="/rest-apis/authentication#subjects" className="border-0 opacity-85 hover:opacity-100 transition-opacity">
          <Badge stroke size="lg" icon={subjectToIconMap[subject]} color="gray" className="mr-1">
            {subject}
          </Badge>
        </a>)}
    </>;
};

<RestEndpointSubjects subjects={["client"]} />


## OpenAPI

````yaml _media/specs/topper-openapi.mintlify.json post /topper/kyc-sharing/identify-user
openapi: 3.1.0
info:
  version: 0.1.0
  title: Topper API
  description: >-
    The Topper API offers a set of endpoints to enable sharing of Know Your
    Customer (KYC) information.
  contact:
    name: Uphold API Team
    email: developer@uphold.com
    url: https://developer.uphold.com
servers:
  - url: https://api.enterprise.sandbox.uphold.com
    description: Sandbox
  - url: https://api.enterprise.uphold.com
    description: Production
security:
  - OAuth2: []
tags:
  - name: KYC sharing
    description: KYC sharing.
paths:
  /topper/kyc-sharing/identify-user:
    post:
      tags:
        - KYC sharing
      summary: Identify user
      description: Identify a user for KYC sharing.
      operationId: topper.identify-kyc-sharing-user
      requestBody:
        $ref: '#/components/requestBodies/identify-kyc-sharing-user-request-body'
      responses:
        '200':
          $ref: '#/components/responses/identify-kyc-sharing-existing-user-response'
        '201':
          $ref: '#/components/responses/identify-kyc-sharing-new-user-response'
        '409':
          $ref: '#/components/responses/identify-kyc-sharing-user-conflict-response'
      security:
        - OAuth2:
            - topper.kyc-sharing:identify-user
components:
  requestBodies:
    identify-kyc-sharing-user-request-body:
      content:
        application/json:
          schema:
            type: object
            properties:
              email:
                description: The email address.
                type: string
                format: email
                maxLength: 255
              country:
                allOf:
                  - $ref: '#/components/schemas/country-code-for-request'
                  - description: The country of residency.
            required:
              - email
              - country
          examples:
            Identify User:
              value:
                email: john.doe@uphold.com
                country: GB
  responses:
    identify-kyc-sharing-existing-user-response:
      description: User identified.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/kyc-sharing-user'
          examples:
            Existing User Retrieved:
              value:
                user:
                  id: cd21b26d-35d2-408a-9201-b8fdbef7a604
                  email: john.doe@uphold.com
      headers:
        x-uphold-request-id:
          description: >-
            A unique identifier for the request that can be shared with Uphold
            for troubleshooting purposes.
          required: true
          schema:
            type: string
            format: uuid
          examples:
            Request ID:
              value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
    identify-kyc-sharing-new-user-response:
      description: User created.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/kyc-sharing-user'
          examples:
            New User Retrieved:
              value:
                user:
                  id: cd21b26d-35d2-408a-9201-b8fdbef7a604
                  email: john.doe@uphold.com
      headers:
        x-uphold-request-id:
          description: >-
            A unique identifier for the request that can be shared with Uphold
            for troubleshooting purposes.
          required: true
          schema:
            type: string
            format: uuid
          examples:
            Request ID:
              value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
    identify-kyc-sharing-user-conflict-response:
      description: Business logic error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            Country Not Supported:
              value:
                code: country_not_supported
                message: The country is not supported
                details:
                  context: body
                  property: country
            Email Incorrect or Disallowed:
              value:
                code: email_incorrect_or_disallowed
                message: The email is incorrect or disallowed
            Organization Not Configured:
              value:
                code: operation_not_allowed
                message: KYC Sharing is not configured for your organization
                details:
                  reasons:
                    - permission-denied
            Missing User Context:
              value:
                code: operation_not_allowed
                message: Request not allowed due to missing user context
                details:
                  reasons:
                    - missing-user-ip-header
      headers:
        x-uphold-request-id:
          description: >-
            A unique identifier for the request that can be shared with Uphold
            for troubleshooting purposes.
          required: true
          schema:
            type: string
            format: uuid
          examples:
            Request ID:
              value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
  schemas:
    country-code-for-request:
      type: string
      pattern: ^[A-Z]{2}$
    kyc-sharing-user:
      type: object
      properties:
        user:
          type: object
          properties:
            id:
              description: The id of the user.
              type: string
              format: uuid
            email:
              description: The email address of the user.
              type: string
              format: email
          required:
            - id
            - email
      required:
        - user
    error:
      description: The error information.
      allOf:
        - $ref: '#/components/schemas/feedback'
    feedback:
      description: A feedback message with a code and human-readable description.
      type: object
      properties:
        code:
          description: A short string with a brief explanation about the code reported.
          type: string
        message:
          description: A human-readable message providing more details.
          type: string
        details:
          description: Additional information about the feedback reported.
          type: object
          additionalProperties: true
      required:
        - code
        - message
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth 2.0 authentication
      flows:
        clientCredentials:
          tokenUrl: /core/oauth2/token
          scopes:
            topper.kyc-sharing:identify-user: Grants access to identify a user for KYC sharing.
            topper.kyc-sharing:create-session: Grants access to create a KYC sharing session.

````