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

# Get KYC Metadata Mappings

> **Rate limit:** 60 requests per 60 seconds. This is the **default shared quota** — it is shared with every other endpoint that has no dedicated limit, so requests across those endpoints all draw from the same budget.

---

Retrieves all KYC metadata ID-to-name lookup mappings. Response cached 60s. Supports ETag caching via If-None-Match; returns 304 if unchanged.



## OpenAPI

````yaml /api-reference/partners-openapi.json get /api/v2/kyc/mappers
openapi: 3.0.1
info:
  title: eToro Api
  version: v1.342.0
  description: >-
    eToro’s public API provides access to real-time financial data, trading
    insights, and account management features, allowing developers to integrate
    eToro’s services into their applications. With access to market prices,
    historical data, and social trading information, the API empowers users to
    enhance their trading strategies. Designed for security and scalability, the
    eToro API ensures smooth and reliable integration for a variety of financial
    applications.


    For more details on integrating with eToro's public WebSocket service,
    please refer to the dedicated [WebSocket
    documentation](./websocket/websocket-doc.html).


    ## Authentication


    Every request must be authenticated with exactly one of two options: an
    OAuth 2.0 access token (`Authorization: Bearer <token>`), or the
    non-interactive credential pair (`x-api-key` + `x-user-key` headers). The
    two options are mutually exclusive — a request carrying both is rejected.
    Each operation lists the OAuth scopes that grant access as alternative
    security requirements: a bearer token needs only ONE of them, and the same
    permissions govern the credential pair.
servers:
  - url: https://public-api.etoro.com
    description: eToro Public API - Partners
security:
  - apiKeyAuth: []
    userKeyAuth: []
  - oauth2: []
tags:
  - name: OPS
  - name: KYC
  - name: Cash Accounts
  - name: FTD
  - name: Crypto Deposit
  - name: Crypto Withdrawals
  - name: Registration
  - name: Sub-Accounts
  - name: Email Verification
  - name: Trusted Partner
  - name: Phone Verification
  - name: Verification
paths:
  /api/v2/kyc/mappers:
    get:
      tags:
        - KYC
      summary: Get KYC Metadata Mappings
      description: >-
        **Rate limit:** 60 requests per 60 seconds. This is the **default shared
        quota** — it is shared with every other endpoint that has no dedicated
        limit, so requests across those endpoints all draw from the same budget.


        ---


        Retrieves all KYC metadata ID-to-name lookup mappings. Response cached
        60s. Supports ETag caching via If-None-Match; returns 304 if unchanged.
      operationId: getKycMappers
      parameters:
        - name: x-request-id
          in: header
          required: true
          schema:
            type: string
            format: uuid
            example: b825035e-cbab-4617-bb5d-5412039d7d62
          description: A unique request identifier.
        - description: >-
            ETag value from a previous 200 response. If it matches current data,
            304 is returned.
          name: If-None-Match
          in: header
          schema:
            type: string
          required: false
      responses:
        '200':
          description: KYC metadata mappings retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKycMappersResponse'
              example:
                questionIdToName:
                  '1': ReadAndUnderstoodCfdRisksAndAbove18
                  '2': TradingExperienceLevel
                  '10': NetAnnualIncome
                  '18': Occupation
                  '33': TradingExperienceEquities
                  '34': TradingExperienceCryptoAssets
                  '35': TradingExperienceLeveragedCFDs
                customerAnswerIdToName:
                  '1': Checked
                  '16': 'Yes'
                  '17': 'No'
                  '43': Employed
                  '49': NeverTraded
                  '55': Daily
                  '88': Crypto
                extendedUserFieldIdToName:
                  '0': province
                  '6': TaxId
                  '7': NationalPin
                  '8': EmployerName
                  '9': DepositQuestion
                extendedUserValueTypeIdToName:
                  '40': PassportNumber
                  '41': TaxNumber
                  '46': taxID
                  '51': taxUTR
                  '59': SocialSecurityNumber
          headers:
            RateLimit-Limit:
              description: >-
                Maximum number of requests allowed per window. This is the
                default shared pool used by every endpoint without a dedicated
                limit, so it is NOT per-endpoint — requests across those
                endpoints all draw from this one budget.
              schema:
                type: integer
              example: 60
            RateLimit-Remaining:
              description: Requests remaining in the current window for this quota.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the current window resets.
              schema:
                type: integer
            RateLimit-Policy:
              description: Quota policy in the form `<limit>;w=<window-seconds>`.
              schema:
                type: string
              example: 60;w=60
        '304':
          description: >-
            Data has not changed since the last request (ETag match). No body
            returned.
        '429':
          description: >-
            Too Many Requests — the shared rate limit (60 requests / 60s) was
            exceeded.
          headers:
            RateLimit-Limit:
              description: >-
                Maximum number of requests allowed per window. This is the
                default shared pool used by every endpoint without a dedicated
                limit, so it is NOT per-endpoint — requests across those
                endpoints all draw from this one budget.
              schema:
                type: integer
              example: 60
            RateLimit-Remaining:
              description: Requests remaining in the current window for this quota.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the current window resets.
              schema:
                type: integer
            RateLimit-Policy:
              description: Quota policy in the form `<limit>;w=<window-seconds>`.
              schema:
                type: string
              example: 60;w=60
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
              example: 60
      security:
        - apiKeyAuth: []
          userKeyAuth: []
        - oauth2:
            - etoro-public:real:read
        - oauth2:
            - etoro-public:demo:read
        - oauth2:
            - etoro-public:kyc:read
        - oauth2:
            - etoro-public:kyc:write
components:
  schemas:
    GetKycMappersResponse:
      type: object
      properties:
        questionIdToName:
          type: object
          description: >-
            KYC question IDs mapped to their short description names. Keys are
            integer IDs as strings, values are name strings.
          additionalProperties:
            type: string
        customerAnswerIdToName:
          type: object
          description: >-
            Customer answer IDs mapped to their short description names. Keys
            are integer IDs as strings, values are name strings.
          additionalProperties:
            type: string
        extendedUserFieldIdToName:
          type: object
          description: >-
            Extended user field IDs mapped to their short field names. Keys are
            integer IDs as strings, values are name strings.
          additionalProperties:
            type: string
        extendedUserValueTypeIdToName:
          type: object
          description: >-
            Extended user value type IDs mapped to their short type names. Keys
            are integer IDs as strings, values are name strings.
          additionalProperties:
            type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key of the application. Only valid together with the x-user-key
        header — the pair is an alternative to OAuth bearer authentication,
        never sent alongside it. The pair is granted the same permissions the
        operation's OAuth scopes describe.


        Demo credential for trying the API from these docs:
        `lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663`
      x-default: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
    userKeyAuth:
      type: apiKey
      in: header
      name: x-user-key
      description: >-
        User-specific authentication key. Only valid together with the x-api-key
        header — the pair is an alternative to OAuth bearer authentication,
        never sent alongside it.


        Demo credential for trying the API from these docs:
        `eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_`
      x-default: >-
        eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
    oauth2:
      type: oauth2
      description: >-
        eToro OAuth2 — send the access token as `Authorization: Bearer <token>`.
        Each operation lists the scopes that grant access as separate `security`
        requirements (OpenAPI OR semantics): the caller's token only needs ONE
        of them — you do NOT need all of them. Mutually exclusive with the
        x-api-key/x-user-key credential pair: never send both.
      flows:
        authorizationCode:
          authorizationUrl: ''
          tokenUrl: ''
          scopes:
            etoro-public:demo:read: Grants access to the 'etoro-public:demo:read' scope.
            etoro-public:kyc:answers:read: Grants access to the 'etoro-public:kyc:answers:read' scope.
            etoro-public:kyc:answers:write: Grants access to the 'etoro-public:kyc:answers:write' scope.
            etoro-public:kyc:questions:read: Grants access to the 'etoro-public:kyc:questions:read' scope.
            etoro-public:kyc:read: Grants access to the 'etoro-public:kyc:read' scope.
            etoro-public:kyc:regulations:read: Grants access to the 'etoro-public:kyc:regulations:read' scope.
            etoro-public:kyc:write: Grants access to the 'etoro-public:kyc:write' scope.
            etoro-public:money.accounts:read: Grants access to the 'etoro-public:money.accounts:read' scope.
            etoro-public:money.accounts:write: Grants access to the 'etoro-public:money.accounts:write' scope.
            etoro-public:money.deposit.crypto:read: >-
              Grants access to the 'etoro-public:money.deposit.crypto:read'
              scope.
            etoro-public:money.deposit.crypto:write: >-
              Grants access to the 'etoro-public:money.deposit.crypto:write'
              scope.
            etoro-public:money.ftd:read: Grants access to the 'etoro-public:money.ftd:read' scope.
            etoro-public:money.ftd:write: Grants access to the 'etoro-public:money.ftd:write' scope.
            etoro-public:money.withdraw.crypto:read: >-
              Grants access to the 'etoro-public:money.withdraw.crypto:read'
              scope.
            etoro-public:money.withdraw.crypto:write: >-
              Grants access to the 'etoro-public:money.withdraw.crypto:write'
              scope.
            etoro-public:partner-default: Grants access to the 'etoro-public:partner-default' scope.
            etoro-public:partner:registration:read: >-
              Grants access to the 'etoro-public:partner:registration:read'
              scope.
            etoro-public:partner:registration:write: >-
              Grants access to the 'etoro-public:partner:registration:write'
              scope.
            etoro-public:real:read: Grants access to the 'etoro-public:real:read' scope.
            etoro-public:sub-accounts:delete: Grants access to the 'etoro-public:sub-accounts:delete' scope.
            etoro-public:verification.address:read: >-
              Grants access to the 'etoro-public:verification.address:read'
              scope.
            etoro-public:verification.address:write: >-
              Grants access to the 'etoro-public:verification.address:write'
              scope.
            etoro-public:verification.email:write: >-
              Grants access to the 'etoro-public:verification.email:write'
              scope.
            etoro-public:verification.personaldetails:read: >-
              Grants access to the
              'etoro-public:verification.personaldetails:read' scope.
            etoro-public:verification.personaldetails:write: >-
              Grants access to the
              'etoro-public:verification.personaldetails:write' scope.
            etoro-public:verification.phone:write: >-
              Grants access to the 'etoro-public:verification.phone:write'
              scope.
            etoro-public:verification.trusted.email:write: >-
              Grants access to the
              'etoro-public:verification.trusted.email:write' scope.
            etoro-public:verification.trusted.phone:write: >-
              Grants access to the
              'etoro-public:verification.trusted.phone:write' scope.
            etoro-public:verification:trusted:user:write: >-
              Grants access to the
              'etoro-public:verification:trusted:user:write' scope.

````