> ## 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 Fields > **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. --- Retrieve KYC fields for a user based on their userId. ## OpenAPI ````yaml /api-reference/partners-openapi.json post /api/v1/kyc-fields 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 `), 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/v1/kyc-fields: post: tags: - KYC summary: Get KYC Fields 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. --- Retrieve KYC fields for a user based on their userId. operationId: getKycFields parameters: - name: x-request-id in: header required: true schema: type: string format: uuid example: d35482f1-d223-4a3a-ac20-53aa6481609a description: A unique request identifier. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetKycFieldsRequest' example: fieldNames: - email - phone - address - city - zip - firstName - middleName - lastName - dateOfBirth - gender - buildingNumber - countryOfCitizenship - countryOfBirth - countryOfResidence - state - registeredAt - designatedRegulation - playerStatus - verificationLevel - extendedUserField_TaxId - extendedUserField_NationalPin responses: '200': description: KYC fields retrieved successfully. content: application/json: schema: type: object properties: kycFields: type: object properties: email: type: string description: The email address of the user. example: user@example.com phone: type: string description: The phone number of the user. example: '972526647743' address: type: string description: The address of the user. example: 123 Main St city: type: string description: The city of the user's address. example: New York zip: type: string description: The ZIP code of the user's address. example: '10001' firstName: type: string description: The first name of the user. example: John middleName: type: string description: The middle name of the user. example: A. lastName: type: string description: The last name of the user. example: Doe dateOfBirth: type: string format: date-time description: The date of birth of the user. example: '2001-01-01T12:00:00Z' gender: type: integer description: The gender of the user (1 - male, 2 - female). example: 1 designatedRegulation: type: integer description: >- The designated regulation applicable to the user. (0 - None, 1 - Cyprus Securities Exchange Commission (CySEC), 2 - Financial Conduct Authority(FCA), 3 - National Futures Association (NFA), 4 - Australian Securities and Investments Commission (ASIC), 5 - BVI, 6 - eToro US, 7 - applicable US laws and regulations, 8 - Financial Industry Regulatory Authority (FINRA) and applicable US laws and regulations, 9 - Financial Services Authority Seychelles, 10 - Australian Securities and Investments Commission (ASIC), 11 - Financial Services Regulatory Authority (“FSRA”), 12 - ETOROFINRAONLY, 13 - Monetary Authority of Singapore) example: 11 playerStatus: type: integer description: >- The status of the player (1 - Normal, 2 - Blocked, 3 - Chat Blocked, 4 - Blocked Upon Request, 5 - Warning, 6 - Blocked - Under Investigation, 7 - Scalpers Block, 8 - Blocked - PayPal Investigation, 9 - Trade & MIMO Blocked, 10 - Deposit Blocked, 11 - Social Index, 12 - Copy Block, 13 - Pending Verification, 14 - Blocked – Failed Verification, 15 - Block Deposit & Trading) example: 1 verificationLevel: type: integer description: 'The verification level of the user (values: 0,1,2,3)' example: '1' buildingNumber: type: string description: The building number of the user's address. example: 10A countryOfCitizenship: type: object description: The country of citizenship of the user. properties: name: type: string description: The name of the country. example: United States alpha2IsoCode: type: string description: The ISO Alpha-2 code of the country. example: US alpha3IsoCode: type: string description: The ISO Alpha-3 code of the country. example: USA countryOfBirth: type: object description: The country of birth of the user. properties: name: type: string description: The name of the country. example: United States alpha2IsoCode: type: string description: The ISO Alpha-2 code of the country. example: US alpha3IsoCode: type: string description: The ISO Alpha-3 code of the country. example: USA countryOfResidence: type: object description: >- The Country of the user's primary residence, corresponding to the country portion of the full address specified in the Address field. properties: name: type: string description: The name of the country. example: United States alpha2IsoCode: type: string description: The ISO Alpha-2 code of the country. example: US alpha3IsoCode: type: string description: The ISO Alpha-3 code of the country. example: USA state: type: object description: The state of the user's address. properties: isoCode: type: string description: The ISO code of the state. example: NY name: type: string description: The name of the state. example: New York registeredAt: type: string format: date-time description: The registration date and time of the user. example: '2023-01-01T12:00:00Z' extendedUserField_NationalPin: type: array description: The national PINs of the user. items: type: object properties: country: type: object description: The country associated with the national PIN. properties: alpha2IsoCode: type: string description: The ISO Alpha-2 code of the country. example: US alpha3IsoCode: type: string description: The ISO Alpha-3 code of the country. example: USA value: type: string description: The value of the national PIN. example: '123456789' type: type: string description: The type of the national PIN. example: NationalInsuranceNumber extendedUserField_TaxId: type: array description: The tax IDs of the user. items: type: object properties: country: type: object description: The country associated with the tax ID. properties: alpha2IsoCode: type: string description: The ISO Alpha-2 code of the country. example: US alpha3IsoCode: type: string description: The ISO Alpha-3 code of the country. example: USA value: type: string description: The value of the tax ID. example: '987654321' type: type: string description: The type of the tax ID. example: taxUTR 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 `;w=`. schema: type: string example: 60;w=60 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/KycFacadeApi_ErrorResponse' example: errorCode: Unauthorized errorMessage: Unauthorized '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/KycFacadeApi_ErrorResponse' examples: RequestBodyRequired: summary: Request body is required value: errorCode: RequestBodyRequired errorMessage: Request body is required GcidLessThanMinimum: summary: GCID is less than minimum value: errorCode: GcidLessThanMinimum errorMessage: GCID is less than minimum FieldNamesMustNotBeEmpty: summary: FieldNames must not be empty value: errorCode: FieldNamesMustNotBeEmpty errorMessage: FieldNames must not be empty FieldNameNotSupported: summary: Field name not supported value: errorCode: FieldNameNotSupported errorMessage: Field name {fieldName} is not supported. '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 `;w=`. schema: type: string example: 60;w=60 Retry-After: description: Seconds to wait before retrying. schema: type: integer example: 60 '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/KycFacadeApi_ErrorResponse' example: errorCode: UnhandledException errorMessage: Global Error security: - apiKeyAuth: [] userKeyAuth: [] - oauth2: - etoro-public:kyc:read - oauth2: - etoro-public:kyc:write components: schemas: GetKycFieldsRequest: type: object properties: fieldNames: type: array items: type: string description: List of field names to retrieve KYC data for. example: - email - phone - address KycFacadeApi_ErrorResponse: type: object properties: errorCode: type: string errorMessage: 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 `. 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. ````