Skip to main content
GET
Poll a copy operation's outcome

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:

"43a51960-03be-424e-9f51-65446ae76d57"

Path Parameters

referenceId
string
required

The referenceID supplied on the copy request (max 35 characters, case-sensitive).

Response

Terminal operation outcome

Terminal outcome of a copy operation. Fields with no value are omitted from the response rather than sent as null.

referenceID
string
required

The caller-supplied operation reference this status answers.

isSuccess
boolean
required

Whether the copy operation completed successfully.

mirrorID
integer<int32> | null

The copy relationship the operation created or edited — the id used to close it. Present only when isSuccess is true.

parentCID
integer<int32> | null

The copied investor's account id. Either both parentCID and parentUsername are present, or both are absent.

parentUsername
string | null

The copied investor's username. Either both parentCID and parentUsername are present, or both are absent.

errorMessageCode
integer<int32> | null

Machine-readable error code when the operation failed. Values are not currently enumerated — treat as opaque diagnostic data.

failReason
string | null

Human-readable failure reason when the operation failed.