Skip to main content
POST
Pre-check whether a copy registration would be allowed

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:

"e9dc6948-8697-447b-8494-e47930c5e9d1"

Body

application/json
parentCID
integer<int32>
required

The investor account id to copy.

amount
number<decimal>
required

Amount that would be allocated to the copy, in the account currency. Value must be non-zero.

Response

Eligibility verdict

Eligibility verdict. Fields with no value are omitted from the response rather than sent as null.

CID
integer<int32>
required

The authenticated account id the verdict applies to.

parentCID
integer<int32>
required

The investor account id the verdict applies to.

isSuccess
boolean
required

Whether a copy registration with these parameters would be allowed.

errorCode
integer<int32> | null

Machine-readable reason when not eligible. Values are not currently enumerated — treat as opaque diagnostic data. May be absent even when isSuccess is false.

errorMessage
string | null

Human-readable reason when not eligible. May be absent even when isSuccess is false.