Skip to main content
POST
Register OAuth application

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

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-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

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_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"38945b86-ad94-41e5-96d8-54b5e2f98abc"

Body

application/json
applicationName
string
required

Display name shown to end users in the OAuth consent screen.

Maximum string length: 100
Example:

"My Trading App"

applicationIconUrl
string<uri>
required

Publicly reachable URL of the application icon. Format-validated only - the URL is not fetched by the service.

Maximum string length: 500
Example:

"https://cdn.etoro.com/icons/my-app.png"

scopes
object[]
required

Scopes that the application will request from end users. Each scopeId must be positive and present in the cached scope catalog. Duplicates are rejected.

Minimum array length: 1
redirectUris
string<uri>[]
required

OAuth redirect URIs registered for the application. Must be unique. Each URI is capped at 500 characters.

Minimum array length: 1
Maximum string length: 500
Example:
allowedGcids
integer<int64>[]

GCIDs permitted to use this application. Pass an empty array to clear.

Response

Application created successfully. The clientSecret is included once and only once.

application
object

Full application record. The clientSecret is intentionally excluded.

clientSecret
string<uuid>

OAuth client secret. Returned exactly once at creation time and never again - store it securely.