curl --request POST \
--url https://public-api.etoro.com/api/v1/kyc-fields \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-request-id: <x-request-id>' \
--header 'x-user-key: <api-key>' \
--data '
{
"fieldNames": [
"email",
"phone",
"address",
"city",
"zip",
"firstName",
"middleName",
"lastName",
"dateOfBirth",
"gender",
"buildingNumber",
"countryOfCitizenship",
"countryOfBirth",
"countryOfResidence",
"state",
"registeredAt",
"designatedRegulation",
"playerStatus",
"verificationLevel",
"extendedUserField_TaxId",
"extendedUserField_NationalPin"
]
}
'import requests
url = "https://public-api.etoro.com/api/v1/kyc-fields"
payload = { "fieldNames": ["email", "phone", "address", "city", "zip", "firstName", "middleName", "lastName", "dateOfBirth", "gender", "buildingNumber", "countryOfCitizenship", "countryOfBirth", "countryOfResidence", "state", "registeredAt", "designatedRegulation", "playerStatus", "verificationLevel", "extendedUserField_TaxId", "extendedUserField_NationalPin"] }
headers = {
"x-request-id": "<x-request-id>",
"x-api-key": "<api-key>",
"x-user-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-request-id': '<x-request-id>',
'x-api-key': '<api-key>',
'x-user-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
fieldNames: [
'email',
'phone',
'address',
'city',
'zip',
'firstName',
'middleName',
'lastName',
'dateOfBirth',
'gender',
'buildingNumber',
'countryOfCitizenship',
'countryOfBirth',
'countryOfResidence',
'state',
'registeredAt',
'designatedRegulation',
'playerStatus',
'verificationLevel',
'extendedUserField_TaxId',
'extendedUserField_NationalPin'
]
})
};
fetch('https://public-api.etoro.com/api/v1/kyc-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api.etoro.com/api/v1/kyc-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fieldNames' => [
'email',
'phone',
'address',
'city',
'zip',
'firstName',
'middleName',
'lastName',
'dateOfBirth',
'gender',
'buildingNumber',
'countryOfCitizenship',
'countryOfBirth',
'countryOfResidence',
'state',
'registeredAt',
'designatedRegulation',
'playerStatus',
'verificationLevel',
'extendedUserField_TaxId',
'extendedUserField_NationalPin'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-request-id: <x-request-id>",
"x-user-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public-api.etoro.com/api/v1/kyc-fields"
payload := strings.NewReader("{\n \"fieldNames\": [\n \"email\",\n \"phone\",\n \"address\",\n \"city\",\n \"zip\",\n \"firstName\",\n \"middleName\",\n \"lastName\",\n \"dateOfBirth\",\n \"gender\",\n \"buildingNumber\",\n \"countryOfCitizenship\",\n \"countryOfBirth\",\n \"countryOfResidence\",\n \"state\",\n \"registeredAt\",\n \"designatedRegulation\",\n \"playerStatus\",\n \"verificationLevel\",\n \"extendedUserField_TaxId\",\n \"extendedUserField_NationalPin\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-request-id", "<x-request-id>")
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-user-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public-api.etoro.com/api/v1/kyc-fields")
.header("x-request-id", "<x-request-id>")
.header("x-api-key", "<api-key>")
.header("x-user-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fieldNames\": [\n \"email\",\n \"phone\",\n \"address\",\n \"city\",\n \"zip\",\n \"firstName\",\n \"middleName\",\n \"lastName\",\n \"dateOfBirth\",\n \"gender\",\n \"buildingNumber\",\n \"countryOfCitizenship\",\n \"countryOfBirth\",\n \"countryOfResidence\",\n \"state\",\n \"registeredAt\",\n \"designatedRegulation\",\n \"playerStatus\",\n \"verificationLevel\",\n \"extendedUserField_TaxId\",\n \"extendedUserField_NationalPin\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.etoro.com/api/v1/kyc-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-request-id"] = '<x-request-id>'
request["x-api-key"] = '<api-key>'
request["x-user-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fieldNames\": [\n \"email\",\n \"phone\",\n \"address\",\n \"city\",\n \"zip\",\n \"firstName\",\n \"middleName\",\n \"lastName\",\n \"dateOfBirth\",\n \"gender\",\n \"buildingNumber\",\n \"countryOfCitizenship\",\n \"countryOfBirth\",\n \"countryOfResidence\",\n \"state\",\n \"registeredAt\",\n \"designatedRegulation\",\n \"playerStatus\",\n \"verificationLevel\",\n \"extendedUserField_TaxId\",\n \"extendedUserField_NationalPin\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"kycFields": {
"email": "user@example.com",
"phone": "972526647743",
"address": "123 Main St",
"city": "New York",
"zip": "10001",
"firstName": "John",
"middleName": "A.",
"lastName": "Doe",
"dateOfBirth": "2001-01-01T12:00:00Z",
"gender": 1,
"designatedRegulation": 11,
"playerStatus": 1,
"verificationLevel": "1",
"buildingNumber": "10A",
"countryOfCitizenship": {
"name": "United States",
"alpha2IsoCode": "US",
"alpha3IsoCode": "USA"
},
"countryOfBirth": {
"name": "United States",
"alpha2IsoCode": "US",
"alpha3IsoCode": "USA"
},
"countryOfResidence": {
"name": "United States",
"alpha2IsoCode": "US",
"alpha3IsoCode": "USA"
},
"state": {
"isoCode": "NY",
"name": "New York"
},
"registeredAt": "2023-01-01T12:00:00Z",
"extendedUserField_NationalPin": [
{
"country": {
"alpha2IsoCode": "US",
"alpha3IsoCode": "USA"
},
"value": "123456789",
"type": "NationalInsuranceNumber"
}
],
"extendedUserField_TaxId": [
{
"country": {
"alpha2IsoCode": "US",
"alpha3IsoCode": "USA"
},
"value": "987654321",
"type": "taxUTR"
}
]
}
}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.
curl --request POST \
--url https://public-api.etoro.com/api/v1/kyc-fields \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-request-id: <x-request-id>' \
--header 'x-user-key: <api-key>' \
--data '
{
"fieldNames": [
"email",
"phone",
"address",
"city",
"zip",
"firstName",
"middleName",
"lastName",
"dateOfBirth",
"gender",
"buildingNumber",
"countryOfCitizenship",
"countryOfBirth",
"countryOfResidence",
"state",
"registeredAt",
"designatedRegulation",
"playerStatus",
"verificationLevel",
"extendedUserField_TaxId",
"extendedUserField_NationalPin"
]
}
'import requests
url = "https://public-api.etoro.com/api/v1/kyc-fields"
payload = { "fieldNames": ["email", "phone", "address", "city", "zip", "firstName", "middleName", "lastName", "dateOfBirth", "gender", "buildingNumber", "countryOfCitizenship", "countryOfBirth", "countryOfResidence", "state", "registeredAt", "designatedRegulation", "playerStatus", "verificationLevel", "extendedUserField_TaxId", "extendedUserField_NationalPin"] }
headers = {
"x-request-id": "<x-request-id>",
"x-api-key": "<api-key>",
"x-user-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-request-id': '<x-request-id>',
'x-api-key': '<api-key>',
'x-user-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
fieldNames: [
'email',
'phone',
'address',
'city',
'zip',
'firstName',
'middleName',
'lastName',
'dateOfBirth',
'gender',
'buildingNumber',
'countryOfCitizenship',
'countryOfBirth',
'countryOfResidence',
'state',
'registeredAt',
'designatedRegulation',
'playerStatus',
'verificationLevel',
'extendedUserField_TaxId',
'extendedUserField_NationalPin'
]
})
};
fetch('https://public-api.etoro.com/api/v1/kyc-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api.etoro.com/api/v1/kyc-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fieldNames' => [
'email',
'phone',
'address',
'city',
'zip',
'firstName',
'middleName',
'lastName',
'dateOfBirth',
'gender',
'buildingNumber',
'countryOfCitizenship',
'countryOfBirth',
'countryOfResidence',
'state',
'registeredAt',
'designatedRegulation',
'playerStatus',
'verificationLevel',
'extendedUserField_TaxId',
'extendedUserField_NationalPin'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-request-id: <x-request-id>",
"x-user-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public-api.etoro.com/api/v1/kyc-fields"
payload := strings.NewReader("{\n \"fieldNames\": [\n \"email\",\n \"phone\",\n \"address\",\n \"city\",\n \"zip\",\n \"firstName\",\n \"middleName\",\n \"lastName\",\n \"dateOfBirth\",\n \"gender\",\n \"buildingNumber\",\n \"countryOfCitizenship\",\n \"countryOfBirth\",\n \"countryOfResidence\",\n \"state\",\n \"registeredAt\",\n \"designatedRegulation\",\n \"playerStatus\",\n \"verificationLevel\",\n \"extendedUserField_TaxId\",\n \"extendedUserField_NationalPin\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-request-id", "<x-request-id>")
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-user-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public-api.etoro.com/api/v1/kyc-fields")
.header("x-request-id", "<x-request-id>")
.header("x-api-key", "<api-key>")
.header("x-user-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fieldNames\": [\n \"email\",\n \"phone\",\n \"address\",\n \"city\",\n \"zip\",\n \"firstName\",\n \"middleName\",\n \"lastName\",\n \"dateOfBirth\",\n \"gender\",\n \"buildingNumber\",\n \"countryOfCitizenship\",\n \"countryOfBirth\",\n \"countryOfResidence\",\n \"state\",\n \"registeredAt\",\n \"designatedRegulation\",\n \"playerStatus\",\n \"verificationLevel\",\n \"extendedUserField_TaxId\",\n \"extendedUserField_NationalPin\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.etoro.com/api/v1/kyc-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-request-id"] = '<x-request-id>'
request["x-api-key"] = '<api-key>'
request["x-user-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fieldNames\": [\n \"email\",\n \"phone\",\n \"address\",\n \"city\",\n \"zip\",\n \"firstName\",\n \"middleName\",\n \"lastName\",\n \"dateOfBirth\",\n \"gender\",\n \"buildingNumber\",\n \"countryOfCitizenship\",\n \"countryOfBirth\",\n \"countryOfResidence\",\n \"state\",\n \"registeredAt\",\n \"designatedRegulation\",\n \"playerStatus\",\n \"verificationLevel\",\n \"extendedUserField_TaxId\",\n \"extendedUserField_NationalPin\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"kycFields": {
"email": "user@example.com",
"phone": "972526647743",
"address": "123 Main St",
"city": "New York",
"zip": "10001",
"firstName": "John",
"middleName": "A.",
"lastName": "Doe",
"dateOfBirth": "2001-01-01T12:00:00Z",
"gender": 1,
"designatedRegulation": 11,
"playerStatus": 1,
"verificationLevel": "1",
"buildingNumber": "10A",
"countryOfCitizenship": {
"name": "United States",
"alpha2IsoCode": "US",
"alpha3IsoCode": "USA"
},
"countryOfBirth": {
"name": "United States",
"alpha2IsoCode": "US",
"alpha3IsoCode": "USA"
},
"countryOfResidence": {
"name": "United States",
"alpha2IsoCode": "US",
"alpha3IsoCode": "USA"
},
"state": {
"isoCode": "NY",
"name": "New York"
},
"registeredAt": "2023-01-01T12:00:00Z",
"extendedUserField_NationalPin": [
{
"country": {
"alpha2IsoCode": "US",
"alpha3IsoCode": "USA"
},
"value": "123456789",
"type": "NationalInsuranceNumber"
}
],
"extendedUserField_TaxId": [
{
"country": {
"alpha2IsoCode": "US",
"alpha3IsoCode": "USA"
},
"value": "987654321",
"type": "taxUTR"
}
]
}
}Authorizations
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
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_