Download OpenAPI specification:Download
Pre authenticates an account by username and password. Checks if the user should perform secondary authentication and if so, returns the available authentication factor for this user, the campaign contact details, status and session details. If the 2FA is disabled for this user then the credentials are checked against the database and the details are returned along with the session. Possible reasons of rejection with HTTP 200: PasscodeInvalid, ContactLocked or AccessDenied. Possible scenarios of pair (Status, Factor):
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The pre authentication request which contains the user name, password, trusted device token and a flag to force expiring an existing session on the contact.
| UserName | string The contact name based on which authentication will be done. |
| Password | string The password of the contact to authenticate. |
| TrustedDeviceToken | string If the supplied token is valid, return an “allow” response, meaning that the user does not have to perform secondary authentication as the attempt originates from a trusted device. |
| ForceExpiringPreviousSession required | boolean A flag which indicates if the current existing session of the contact will be expired or not. It is useful when a contact is logged on multiple devices. |
Pre-authentication returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Authenticates an account by username and password. This API is deprecated. Use the following endpoint to pre-authenticate: /v1.1/authentication/pre-authenticate. The GlobalSettings table must support the following settings: 2FAFactor = Passcode and 2FAProvider = MTan.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The authentication request which contains the user name, password and a flag to force expiring an existing session on the contact.
| UserName | string The contact name based on which authentication will be done. |
| Password | string The password of the contact to authenticate. |
| ForceExpiringPreviousSession required | boolean A flag which indicates if the current existing session of the contact will be expired or not. It is useful when a contact is logged on multiple devices. |
Contact identifier returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Performs secondary authentication using one of the available factors. The response of this endpoint depends on the chosen factor. If the two-factor authentication is disabled then the session details will be returned and the contact will be automatically authenticated. Possible reasons of rejection with HTTP 200: PasscodeInvalid, ContactLocked or AccessDenied. Possible scenarios of pair (Status, Factor):
| contactId required | integer <int32> The contact identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The authentication request which contains the passcode and a flag which establishes a trusted relationship.
| Passcode | string The passcode received on the phone or generated by installed application or on the different channels, such as slack. |
| SetTrusted required | boolean If the authentication is successful (i.e., result is allow), also return a trusted device token which can be used in the future to mark the device from which the authentication attempt took place as trusted. |
Authentication details returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Checks the authentication status of an account by username and temporary session when async 2FA is enabled. This endpoint can return a response in two different ways:
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The authenticate status request which contains the user name and authentication session.
| UserName | string The contact name based on which two factor authentication status is checked. |
| AuthStatusSessionId | string The identifier to associate the status request with a specific authentication process. It is generated and returned by the endpoint starting the authentication. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Authenticates a contact to access onboarding. The authentication is done by mobile number. Use for mobile devices only (from native apps). Pre authenticates an existing contact to gain access to the onboarding using a mobile number as identifier. Triggers sending of second factor (mtan) to the contact to validate the contact. The follow up call with the mtan should be to /contacts/{contactId}/authentication/onboarding/activate.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The authentication onboarding request
| MobileNumber | string The mobile number used to identify the contact. It must be provided without country code separator (|), but including the country code prefix (00 or + as exit code). If the system is not in production mode (test mode) and there are multiple active contacts with the same mobile number then the first contact is returned. If the system is in production mode and there are multiple active contacts with the same mobile number then an HTTP 200 response with result 'MobileMultipleContacts' is returned. |
| DeviceToken | string The unique identifier of the device. Does not change through the existence of the application. |
| PushToken | string The push token used to send push notifications. |
| Platform required | string Enum: "iOS" "Android" Device platform / Operating System. iOS,Android |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Sends an activation link to the given contactId provided that the contact exists and the given mtan is valid. If the contact is already marked as active, it will be reset to be not active until the link is clicked by the contact. If the system is in testing mode, due to testing reasons, the new generated activation key is returned. It can be used later in the reset password flow.
| contactId required | integer <int32> The contact identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The activate onboarding request
| MTan | string The mTan code received on the phone or on the different channels, such as slack. |
| RedirectUrl | string optional - The front office redirect url that will be sent to the contact email once the mTan is validated in order to verify the email. If not specified in the request then it will be taken from the application setting. If both are defined, the request value take precedence. Only provide the url in the request if different clients (e.g. different mobile OS Apps) require different urls. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Authenticates a contact on a mobile app by user name and password.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The authentication mobile request
| UserName | string The mobile number used to identify the contact. |
| Password | string The password of the contact. |
| ForceExpiringPreviousSession required | boolean A flag which indicates if the current existing session of the contact will be expired or not. It is useful when a contact is logged on multiple devices. |
| DeviceToken | string The unique identifier of the device. Does not change through the existence of the application. |
| PushToken | string The push token used to send push notifications. |
| Platform required | string Enum: "iOS" "Android" Device platform / Operating System. iOS,Android |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Performs single-sign-on authentication based on a JWT token. The provided JWT access token is validated before authentication.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The SSO authentication request.
| AccessToken | string The SSO jwt access token. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Authenticates an account by username and mTan. If the authentication is successful, a session id along with a JWT access token is returned. This API is deprecated. Use the following endpoint to authenticate via MTan: /v1.1/contacts/{contactId}/authentication/authenticate. The GlobalSettings table must support the following settings: 2FAFactor = Passcode and 2FAProvider = MTan.
| contactId required | integer <int32> The contact identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The authentication request
| MTan | string The mTan code received on the phone or on the different channels, such as slack. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Renews an expired or existing session/JWT token. Returns the renewed JWT token along with session id.
| contactId required | integer <int32> The contact identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The renew token request
| XTokenJwt | string The XTokenJwt represented as Base64 including SessionId and JwtAccessToken which will be renewed. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Renews an expired or an existing SSO session/JWT token. Returns the renewed JWT token along with session id.
| contactId required | integer <int32> The contact identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The renew token request
| XTokenJwt | string The XTokenJwt represented as Base64 including SessionId and JwtAccessToken which will be renewed. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Validates a provided JWT access token (expiration, contactId, memberId, subject, auditContextId). Returns the result type of the validation (Success or one of the invalid result types).
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The validate token request
| AccessToken | string The JWT access token that will be validated. |
The validation result returned successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets a JWT token for a given sessionId.
| contactId required | integer <int32> The ID of the contact that the token belongs to. |
| sessionId required | string The session identifier. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Triggers a forgotten password process based on username or email. The username takes the priority over email to identify the campaign contact if both are provided. If the contact is registered, then the details of the campaign contact are returned and an mTan is generated and sent to the contact.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The forgotten password request
string The email for which the password was forgotten. | |
| UserName | string The user name for which the password was forgotten. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Sends a forgotten password activation link by email to the given contactId provided that the contact exists, is active and that the given mtan is valid. After this call, the previous password, if existing, can no longer be used and the contact can log-in again only after setting a new password. If the system is in testing mode, due to testing reasons, the new generated activation key is returned. It can be used later in the reset password flow.
| contactId required | integer <int32> The contact identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The forgotten password mtan request
| MTan | string The mTan code received on the phone or on the different channels, such as slack. |
| RedirectUrl | string optional - The front office redirect url that will be sent to the contact email once the mTan is validated in order to set a new password. If not specified in the request then it will be taken from the application setting. If both are defined, the request value take precedence. Only provide the url in the request if different clients (e.g. different mobile OS Apps) require different urls. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Sets a password for an existing, active contact which is not authenticated based on the provided activation key. Can be used for first password creation or for password reset as long as the contact is active already. If the activation key is valid, the new password is set for the contact. Once the password is set the contact should be redirected to a login page and use the new password.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The reset password request
| ActivationKey | string The activation key used to validate the contact. |
| Password | string The new password. |
| ConfirmPassword | string The new password confirmed. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Sets a new password for an existing, active contact with password set which is authenticated based on the contact id provided.
| contactId required | integer <int32> The contact identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The reset password request
| Password | string The new password. |
| ConfirmPassword | string The new password confirmed. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Logs off an authenticated account.
| contactId required | integer <int32> The contact identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Checks whether a contact is locked due to multiple failed authentication attempts (passcode or mTan) and retrieves his status.
| contactId required | integer <int32> The contact identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Unlocks a contact that was locked due to multiple failed authentication attempts (passcode or mTan). If the contact is not locked an HTTP 200 with Result = ContactAlreadyUnlocked will be returned.
| contactId required | integer <int32> The contact identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Returns the list of all banks in the system.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Create a new bank
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
Properties of the bank to create
| Name | string |
| Bic | string |
| Code | string |
OK
Return a bank by id
| id required | integer <int32> Bank id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Update existing bank
| id required | integer <int32> Id of the existing bank |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
Properties of the bank to update
| Name | string |
| Bic | string |
| Code | string |
OK
Provides an API a Futurae server can call in order to deliver status updates as well as the result of a particular authentication attempt (also called authentication session). The URL will be called as a POST request with "Content-Type" header being "application/json". The body of the request will be a JSON object containing the following keys and corresponding values: user_id, username, session_id, result, status, status_msg and trusted_device_token. The session ID identifies the particular authentication session and is conditionally returned by /v1.1/authentication/authenticate endpoint.
| authorization required | string The tenant hash identifier |
The authentication request which contains information about authentication session status.
| username | string The contact name based on which authentication will be done. |
| user_id | string The user identifier linked to the UserName used by 2FA provider. |
| session_id | string A session ID that identifies the newly created authentication session. It can be used to receive real-time updates regarding the status of the authentication session. |
| trusted_device_token | string A token that can be used to mark the device from which the authentication attempt took place as trusted. This can later be passed to the /authentication/preauthenticate endpoint, in order to immediately grant access (without performing secondary authentication), in case the authentication attempt originates from this device. |
| result | string Enum: "Allow" "Auth" "Deny" "Waiting" "Unknown" "Success" "Expired" "Pending" "Disabled" "Locked" "InvalidPasscode" "Success2FaDisabled" The result of the authentication: allow - Authentication was successful. Application should grant access to the user; deny - authentication failed; waiting - authentication is still in-progress. |
| status | string The authentication status: bypass, disabled, locked_out. |
| status_msg | string The authentication status message. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Provides an API a Futurae server can call in order to inform the application when the enrollment was successfully completed. The body of the request will be a JSON object containing the following keys and corresponding values: user_id, username, activation_code and result. The value of the latter will always be "success", since the callback will only be called when the enrollment is completed successfully.
| authorization required | string The tenant hash identifier |
The enrollment request which contains the result of the enrollment process.
| username | string The contact name based on which enrollment will be done. |
| user_id | string The user identifier linked to the UserName used by 2FA provider. |
| activation_code | string The activation code used to complete the enrollment of the device. |
| result | string The result status. The value of the latter will always be “success”, since the callback will only be called when the enrollment is completed successfully. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Performs a health check of the system. Will return "OK" as "text/plain" if everything is working properly.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Returns system settings. If the optional group parameter is passed only settings for this group will be returned, otherwise all available settings.
| group | string |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Returns a specific system setting. The name of the group and the name of the key need to be supplied.
| group required | string |
| key required | string |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Returns campaign configuration data. Returns data about the active campaign of the tenant, including a list of product offers and their products, the list of supported languages and the default language. The language DTOs also contain specifications that can be used for number formatting (NumberDecimalSeparator and NumberGroupSeparator).
| language required | string |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Returns the list of all countries in the system.
| language required | string The language of the localized resources |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Returns the list of all lanuages in the system.
| language required | string The language of the localized resources |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Returns the list of all bank branches in the system.
| language required | string The language of the localized resources |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Returns the list of all severity levels in the system.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Returns a list of all available data sources.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Returns a list of stored procedures available for the provided data source and schema
| dataSourceName required | string Name of the data source |
| schema required | string Name of the specific DB schema |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Publishes an integration event to the event bus
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The parameter DTO
| Name required | string The actual name of the integration event. Since an event is something that happened in the past, the name of the event should be represented as a past-tense verb, like “OrderCreated”. |
| Group | string An ID defining the group the integration event belongs to. This makes it easier to identify events that are all dealing with the same part of an application. An example would be “Ordering”. Not to be mistaken with the ContextId which identifies a unique context. |
| ContextId | string Should contain a unique ID to identify the current context. It will be used to identify events belonging to the same context. |
| Data | string The payload of the integration event serialized as JSON |
| EntityName | string The optional entity name of the event bus. If not passed the default name 'DfsEventBus' will be used |
OK
Unauthorized
UnprocessableEntity
InternalServerError
Gets all asset delivery forms for private clients
| language required | string Language |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets all asset delivery forms for corporate clients
| language required | string Language |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets all asset delivery forms regardless of the customer type
| language required | string Language |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets all transferred assets sources available for private clients
| language required | string Language |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets all transferred assets sources available for corporate clients
| language required | string Language |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets all transferred assets sources available regardless of the customer type
| language required | string Language |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets all incomes available for private clients
| language required | string Language |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets all incomes available for corporate clients
| language required | string Language |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets all incomes available regardless of the customer type
| language required | string Language |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets all marital statuses
| language required | string Language |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets all risk categories for a specific product
| productId required | integer <int32> |
| language required | string |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets a collection of content artifacts (assets) by asset type
| language required | string |
| assetType required | integer <int32> |
| startRowIndex | integer <int32> |
| pageSize | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets all employment types
| language required | string Language |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets all business sectors
| language required | string Language |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Receives an HTML template, a JSON object, renders the HTML, then generates the PDF from it
| downloadFileName required | string |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Generates the document schema template using the specified parameters in the request.
Includes the schema, language, contentType, parameters, model and whether to include plain properties.| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| SchemaId | integer <int32> |
| SchemaKey | string |
| LanguageId required | integer <int32> |
| ContentType | string |
| Parameters | object (Dictionary`2) These are the input parameters that will be used by the Stored Procedure |
| Model | string Model used by the template, bypassing Stored Procedure |
| IncludePlainProperties required | boolean |
OK
Generates a template using the specified parameters in the request.
Includes the metadata, language, contentType, parameters, model and whether to include plain properties.| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| TemplateMetadataId | integer <int32> |
| TemplateMetadataKey | string |
| LanguageId required | integer <int32> |
| ContentType | string |
| Parameters | object (Dictionary`2) These are the input parameters that will be used by the Stored Procedure |
| Model | string Model used by the template, bypassing Stored Procedure |
| IncludePlainProperties required | boolean |
OK
Returns a preview of a generated template.
Includes the header, body, footer, contentType, pageOrientation, dataSet and parameters.| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Header | string |
| Body | string |
| Footer | string |
| ContentType | string |
| PageOrientation required | string Enum: "Portrait" "Landscape" |
| DataSetId | integer <int32> |
| DataSourceParameters | object (Dictionary`2) |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Id required | integer <int32> |
| Name | string |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Id required | integer <int32> |
| Name | string |
OK
| id required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| id required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Id required | integer <int32> |
| Name | string |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Id required | integer <int32> |
| Name | string |
OK
| id required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| id required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Id required | integer <int32> |
| StoredProcedure | string |
| Alias | string |
| ConnectionString | string |
| InputParams | string |
| IsCustom required | boolean |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Id required | integer <int32> |
| StoredProcedure | string |
| Alias | string |
| ConnectionString | string |
| InputParams | string |
| IsCustom required | boolean |
OK
| id required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| id required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Id required | integer <int32> |
| CategoryId required | integer <int32> |
| DataSetId | integer <int32> |
| ShowCustomer required | boolean |
| Icon | string |
| Key | string |
| Name | string |
| ShowHeaderPerEachPage required | boolean |
| ShowFooterPerEachPage required | boolean |
| MemberId required | integer <int32> |
| Types | Array of integers <int32> |
| SelectionParameters | Array of integers <int32> |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Id required | integer <int32> |
| CategoryId required | integer <int32> |
| DataSetId | integer <int32> |
| ShowCustomer required | boolean |
| Icon | string |
| Key | string |
| Name | string |
| ShowHeaderPerEachPage required | boolean |
| ShowFooterPerEachPage required | boolean |
| MemberId required | integer <int32> |
| Types | Array of integers <int32> |
| SelectionParameters | Array of integers <int32> |
OK
| id required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| id required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Id required | integer <int32> |
| LanguageId required | integer <int32> |
| MetadataId required | integer <int32> |
| Title | string |
| Header | string |
| Body | string |
| Footer | string |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Id required | integer <int32> |
| LanguageId required | integer <int32> |
| MetadataId required | integer <int32> |
| Title | string |
| Header | string |
| Body | string |
| Footer | string |
OK
| id required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| id required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Id required | integer <int32> |
| Name | string |
| Key | string |
| ShowToCustomer required | boolean |
| IsMerged required | boolean |
| TypeId required | integer <int32> |
| RenderTemplateMetadatas | Array of objects (OrderedRenderTemplateMetadataRequest) |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Id required | integer <int32> |
| Name | string |
| Key | string |
| ShowToCustomer required | boolean |
| IsMerged required | boolean |
| TypeId required | integer <int32> |
| RenderTemplateMetadatas | Array of objects (OrderedRenderTemplateMetadataRequest) |
OK
| id required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| id required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| key required | string |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| metadataId required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Retrieves a message by message id and person id. If the person is a contact then he must be either the sender or a recipient of the message and the list of the recipients is filtered by personId (if person is recipient). If the person is a member then all the recipients are retrieved and the message can be accessed by any member who has hierarchy access to the sender or to one of the recipients. The subject and the text of the message retrieved from the database are sanitized for better formatting.
| personId required | integer <int32> The sender or the recipient identifier of the message or a member who has hierarchy access. |
| messageId required | integer <int64> Message identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The message returned successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Retrieves a message attachment by person id, message id and document id. The attachment can be accessed by the sender, by one of the recipients or by a member who has hierarchy access.
| personId required | integer <int32> The person identifier who is the owner of the document (sender or recipient or a member with hierarchy access). |
| messageId required | integer <int64> The message identifier who contains the attachment. |
| attachmentId required | integer <int32> The attachment identifier - externalId. This id identifies the document stored in DMS system. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The message attachment returned successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Retrieves the message attachments by person id and message id. The attachments can be accessed by the sender, by one of the recipients or by a member who has hierarchy access.
| personId required | integer <int32> The person identifier which is the owner of the document (sender or recipient or a member with hierarchy access). |
| messageId required | integer <int64> The message identifier that contains the attachment. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The message attachments returned successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Retrieves the messages (sent and/or received) of a contact. The endpoint can be accessed by the RM of the contact, so by the B/O application. The impersonation of the contact should be allowed. The advanced filters are not allowed (MemberBranchIds, MemberCountryIds, ContactCountryIds etc). If the SenderIds filter is provided then it will be applied for the contactId as recipient. If the RecipientIds filter is provided then it will be applied for the contactId as sender.
| contactId required | integer <int32> Contact id who sent or received the messages. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
A list of filters applied to messages like: text for search, createDate, isRead, isDeleted etc
| Sender | string |
| Recipient | string |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| ThreadId | integer <int32> |
| SubtypeIds | Array of integers <int32> |
| IsRead | boolean |
| IsDeleted | boolean |
| Text | string |
| TextLength | integer <int32> |
| SortColumn | string |
| SortOrder | string |
| SenderIds | Array of integers <int32> |
| RecipientIds | Array of integers <int32> |
| PageNumber required | integer <int32> |
| PageSize required | integer <int32> |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Retrieves all messages of a contact grouped by threads. The endpoint can be accessed by the RM of the contact. The impersonation of the member should be allowed. Only the following filters are supported: PageNumber, PageSize, Text, TextLength, ThreadId, IsRead, IsDeleted, SenderIds, RecipientIds, PageNumber and PageSize. Sorting can be performed by the following columns: Id of thread, Id, CreateDate, Subject and CategoryName of person message. If the SenderIds filter is provided then it will be applied for the contactId as recipient. If the RecipientIds filter is provided then it will be applied for the contactId as sender. The messages from each thread are ordered descending.
| contactId required | integer <int32> Contact id who sent or received the messages. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
A list of filters applied to messages like: text, isRead, isDeleted etc
| Sender | string |
| Recipient | string |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| ThreadId | integer <int32> |
| SubtypeIds | Array of integers <int32> |
| IsRead | boolean |
| IsDeleted | boolean |
| Text | string |
| TextLength | integer <int32> |
| SortColumn | string |
| SortOrder | string |
| SenderIds | Array of integers <int32> |
| RecipientIds | Array of integers <int32> |
| PageNumber required | integer <int32> |
| PageSize required | integer <int32> |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Retrieves the received messages of a contact, without revealing all other recipients. The impersonation of the contact should be allowed. The advanced filters should be allowed (MemberBranchIds, MemberCountryIds, ContactCountryIds etc). The RecipientIds filter is not allowed because the contactId is the single recipient involved.
| contactId required | integer <int32> Contact id who received messages. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
A list of filters applied to messages like: text for search, createDate, isRead, isDelete etc
| SenderType | integer <int32> |
| ContactType | integer <int32> |
| ContactNationalityIds | Array of integers <int32> |
| ContactLanguageIds | Array of integers <int32> |
| ContactCountryIds | Array of integers <int32> |
| MemberBranchIds | Array of integers <int32> |
| MemberCountryIds | Array of integers <int32> |
| Sender | string |
| Recipient | string |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| ThreadId | integer <int32> |
| SubtypeIds | Array of integers <int32> |
| IsRead | boolean |
| IsDeleted | boolean |
| Text | string |
| TextLength | integer <int32> |
| SortColumn | string |
| SortOrder | string |
| SenderIds | Array of integers <int32> |
| RecipientIds | Array of integers <int32> |
| PageNumber required | integer <int32> |
| PageSize required | integer <int32> |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Retrieves the sent messages of a contact including all recipients. The impersonation of the contact should be allowed. The advanced filters should be allowed (MemberBranchIds, MemberCountryIds, ContactCountryIds etc). The SenderIds filter is not allowed because the contactId is the single sender involved.
| contactId required | integer <int32> Contact id who sent the messages. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
A list of filters applied to messages like: text for search, createDate, isRead, isDelete etc
| SenderType | integer <int32> |
| ContactType | integer <int32> |
| ContactNationalityIds | Array of integers <int32> |
| ContactLanguageIds | Array of integers <int32> |
| ContactCountryIds | Array of integers <int32> |
| MemberBranchIds | Array of integers <int32> |
| MemberCountryIds | Array of integers <int32> |
| Sender | string |
| Recipient | string |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| ThreadId | integer <int32> |
| SubtypeIds | Array of integers <int32> |
| IsRead | boolean |
| IsDeleted | boolean |
| Text | string |
| TextLength | integer <int32> |
| SortColumn | string |
| SortOrder | string |
| SenderIds | Array of integers <int32> |
| RecipientIds | Array of integers <int32> |
| PageNumber required | integer <int32> |
| PageSize required | integer <int32> |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Sends a new message to all RMs of a specific contact.
| contactId required | integer <int32> Contact id who sends the message. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Send message parameter
| SubtypeId required | integer <int32> The subtype identifier of the message. |
| CustomAttributes | string The custom attributes of the message represented as json. |
| Subject | string The subject of the message. It will be sanitized in order to avoid XSS attacks. |
| Text | string The content/text body of the message. It will be sanitized in order to avoid XSS attacks. |
| Attachments | Array of objects (MessageAttachment) The list of the message attachments (file name and content of the file). |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Sends a new message to a specific member.
| contactId required | integer <int32> Contact id who sends the message. |
| memberId required | integer <int32> Member id who receives the message. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Send message parameter
| SubtypeId required | integer <int32> The subtype identifier of the message. |
| CustomAttributes | string The custom attributes of the message represented as json. |
| Subject | string The subject of the message. It will be sanitized in order to avoid XSS attacks. |
| Text | string The content/text body of the message. It will be sanitized in order to avoid XSS attacks. |
| Attachments | Array of objects (MessageAttachment) The list of the message attachments (file name and content of the file). |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Replies with a new message to a sender of a given message.
| personId required | integer <int32> The person recipient of the original message or the sender of the new message. |
| messageId required | integer <int64> The original message identifier. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Reply message parameter.
| Subject | string The subject of the message. It will be sanitized in order to avoid XSS attacks. |
| Text | string The content/text body of the message. It will be sanitized in order to avoid XSS attacks. |
| Attachments | Array of objects (MessageAttachment) The list of the message attachments (file name and content of the file). |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Retrieves the messages (sent and/or received) of a member. The endpoint can be accessed by the RM of the member. The impersonation of the member should be allowed. The advanced filters should allowed (MemberBranchIds, MemberCountryIds, ContactCountryIds etc). If the SenderIds filter is provided then it will be applied for the memberId as recipient. If the RecipientIds filter is provided then it will be applied for the memberId as sender.
| memberId required | integer <int32> Contact id who sent or received the messages. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
A list of filters applied to messages like: text for search, createDate, isRead, isDeleted etc
| SenderType | integer <int32> |
| ContactType | integer <int32> |
| ContactNationalityIds | Array of integers <int32> |
| ContactLanguageIds | Array of integers <int32> |
| ContactCountryIds | Array of integers <int32> |
| MemberBranchIds | Array of integers <int32> |
| MemberCountryIds | Array of integers <int32> |
| Sender | string |
| Recipient | string |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| ThreadId | integer <int32> |
| SubtypeIds | Array of integers <int32> |
| IsRead | boolean |
| IsDeleted | boolean |
| Text | string |
| TextLength | integer <int32> |
| SortColumn | string |
| SortOrder | string |
| SenderIds | Array of integers <int32> |
| RecipientIds | Array of integers <int32> |
| PageNumber required | integer <int32> |
| PageSize required | integer <int32> |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Retrieves the received messages of a member, including all other recipients. The impersonation of the member should be allowed. The advanced filters should be allowed (MemberBranchIds, MemberCountryIds, ContactCountryIds etc). The RecipientIds filter is not allowed because the memberId is the single recipient involved.
| memberId required | integer <int32> Member id who received messages. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
A list of filters applied to messages like: text for search, createDate, isRead, isDelete etc
| SenderType | integer <int32> |
| ContactType | integer <int32> |
| ContactNationalityIds | Array of integers <int32> |
| ContactLanguageIds | Array of integers <int32> |
| ContactCountryIds | Array of integers <int32> |
| MemberBranchIds | Array of integers <int32> |
| MemberCountryIds | Array of integers <int32> |
| Sender | string |
| Recipient | string |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| ThreadId | integer <int32> |
| SubtypeIds | Array of integers <int32> |
| IsRead | boolean |
| IsDeleted | boolean |
| Text | string |
| TextLength | integer <int32> |
| SortColumn | string |
| SortOrder | string |
| SenderIds | Array of integers <int32> |
| RecipientIds | Array of integers <int32> |
| PageNumber required | integer <int32> |
| PageSize required | integer <int32> |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Retrieves the sent messages of a member including all other recipients. The impersonation of the member should be allowed. The advanced filters should be allowed (MemberBranchIds, MemberCountryIds, ContactCountryIds etc). The SenderIds filter is not allowed because the memberId is the single sender involved.
| memberId required | integer <int32> Member id who sent the messages. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
A list of filters applied to messages like: text for search, createDate, isRead, isDelete etc
| SenderType | integer <int32> |
| ContactType | integer <int32> |
| ContactNationalityIds | Array of integers <int32> |
| ContactLanguageIds | Array of integers <int32> |
| ContactCountryIds | Array of integers <int32> |
| MemberBranchIds | Array of integers <int32> |
| MemberCountryIds | Array of integers <int32> |
| Sender | string |
| Recipient | string |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| ThreadId | integer <int32> |
| SubtypeIds | Array of integers <int32> |
| IsRead | boolean |
| IsDeleted | boolean |
| Text | string |
| TextLength | integer <int32> |
| SortColumn | string |
| SortOrder | string |
| SenderIds | Array of integers <int32> |
| RecipientIds | Array of integers <int32> |
| PageNumber required | integer <int32> |
| PageSize required | integer <int32> |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Retrieves the messages that a member has access to through Hierachy Access.
| memberId required | integer <int32> The member who has access to through Hierachy Access. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
A list of filters applied to messages like: text for search, CreateDate,IsActive, IsRead,IsDelete
| SenderType | integer <int32> |
| ContactType | integer <int32> |
| ContactNationalityIds | Array of integers <int32> |
| ContactLanguageIds | Array of integers <int32> |
| ContactCountryIds | Array of integers <int32> |
| MemberBranchIds | Array of integers <int32> |
| MemberCountryIds | Array of integers <int32> |
| Sender | string |
| Recipient | string |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| ThreadId | integer <int32> |
| SubtypeIds | Array of integers <int32> |
| IsRead | boolean |
| IsDeleted | boolean |
| Text | string |
| TextLength | integer <int32> |
| SortColumn | string |
| SortOrder | string |
| SenderIds | Array of integers <int32> |
| RecipientIds | Array of integers <int32> |
| PageNumber required | integer <int32> |
| PageSize required | integer <int32> |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Retrieves all messages of a member that he has access to directly (sender or recipient) or through hierarchy access from other members. The messages are grouped by threads. The endpoint can be accessed by the RM of the contact. The impersonation of the member should be allowed. The following filters are supported: PageNumber, PageSize, Text, TextLength, ThreadId, IsRead, IsDeleted, SenderIds, RecipientIds, PageNumber and PageSize. Sorting can be performed by the following columns: Id of thread, Id, CreateDate, Subject and CategoryName of person message. If the SenderIds filter is provided then it should contain only the member ids from the hierarchy of the member. The final filter will contain the memberIds + direct their contacts + sendersIds which are not of type member. If the RecipientIds filter is provided then it should contain only the member ids from the hierarchy of the member. The final filter will contain the memberIds + direct their contacts + recipientIds which are not of type member. The messages from each thread are ordered descending.
| memberId required | integer <int32> Member id who sent or received the messages or has access to other members. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
A list of filters applied to messages like: text, senderIds, recipientIds etc
| Sender | string |
| Recipient | string |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| ThreadId | integer <int32> |
| SubtypeIds | Array of integers <int32> |
| IsRead | boolean |
| IsDeleted | boolean |
| Text | string |
| TextLength | integer <int32> |
| SortColumn | string |
| SortOrder | string |
| SenderIds | Array of integers <int32> |
| RecipientIds | Array of integers <int32> |
| PageNumber required | integer <int32> |
| PageSize required | integer <int32> |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Sends a new message to a subset of recipients. The list of the recipients is mandatory.
| memberId required | integer <int32> Member identifier who sends the message. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Send message parameter including the list of the recipients.
| RecipientIds | Array of integers <int32> The person identifiers who receive the message. The recipients can be both contacts and members. The message will be sent to all recipients. |
| SubtypeId required | integer <int32> The subtype identifier of the message. |
| CustomAttributes | string The custom attributes of the message represented as json. |
| Subject | string The subject of the message. It will be sanitized in order to avoid XSS attacks. |
| Text | string The content/text body of the message. It will be sanitized in order to avoid XSS attacks. |
| Attachments | Array of objects (MessageAttachment) The list of the message attachments (file name and content of the file). |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Retrieves the number of unread messages. If count is greater than 99 then return 99+
| personId required | integer <int32> Person id who received the messages |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Marks a message as read or unread.
| personId required | integer <int32> Person id who sent or received the message. |
| messageId required | integer <int64> Message identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The payload containing the flag which marks the message as read or unread.
| IsRead required | boolean A flag to specify whether the message is read or not. |
OK
No Content
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Marks a message as deleted.
| personId required | integer <int32> Person id who sent or received the message |
| messageId required | integer <int64> Message identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Retrieves all types of messages that belong to a campaign.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Gets notifications available for a given relationship manager At this moment we get only contact birth date as notification
| personId required | integer <int32> |
| startDate | string <date-time> All notifications with date greater than or equal to startDate. If this is not provided then startDate will be DateTime.UtcNow. The format is: YYYY-MM-dd |
| endDate | string <date-time> All notifications with date less than or equal to endDate. If this is not provided then endDate will be DateTime.UtcNow.AddYears(1). The format is: YYYY-MM-dd |
| notificationType | integer <int32> Type of notification. Ex: 1 for birthdate. If this is not provided then notificationType will be 1 (birthdate) |
| withHierarchy | boolean By default is false. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Returns a list of notes (for the day) for a given relationship manager's contacts. Items will be ordered by the notes' EndDate, ascending.
| personId required | integer <int32> |
| startDate | string <date-time> All notes with date greater than or equal to startDate. If this is not provided then startDate will be DateTime.UtcNow.The format is: YYYY-MM-dd |
| endDate | string <date-time> All notes with date less than or equal to endDate.If this is not provided then endDate will be DateTime.UtcNow.AddYears(1) The format is: YYYY-MM-dd |
| withHierarchy | boolean By default is false. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Returns a list of calendar entries based on the Tasks and Notifications corresponding to the currently logged in RM. This information will be used to populate an RMs calendar with relevant information, color coded based on the Calendar Entry Type.
| personId required | integer <int32> |
| startDueDate | string <date-time> All tickets with DueDate greater than or equal to startDueDate. This parameter is optional. The format is: YYYY-MM-dd |
| endDueDate | string <date-time> All tickets with DueDate less than or equal to endDueDate. This parameter is optional. The format is: YYYY-MM-dd |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Returns the clients of a relationship manager.
| personId required | integer <int32> |
| language | string The language of the localized resources |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Retrieves a message by message id and person id. The subject and the text of the message retrieved from database are sanitized for better formatting.
| personId required | integer <int32> Person id who sent or received the message |
| id required | integer <int64> Message id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The message was returned successfully.
[DEPRECATED Please use GET /v2.0/persons/{personId}/messages/{messageId} instead. The new endpoint can be accessed by any member who has hierarchy access to sender or one of the recipients.] Retrieves a message by message id and person id. The subject and the text of the message retrieved from database are sanitized for better formatting.
| personId required | integer <int32> Person id who sent or received the message |
| id required | integer <int64> Message id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The message was returned successfully.
Retrieves the message with attachments by person id and message id. The subject and the text of the message retrieved from database are sanitized for better formatting.
| personId required | integer <int32> The person identifier who is the owner of the document. |
| messageId required | integer <int64> The message identifier who contains the attachment. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The message details with attachments returned successfully.
[DEPRECATED Use GET /v2.0/persons/{personId}/messages/{messageId}/attachments instead. The new endpoint can be accessed by any member who has hierarchy access to sender or one of the recipients.] Retrieves the message with attachments by person id and message id. The subject and the text of the message retrieved from database are sanitized for better formatting.
| personId required | integer <int32> The person identifier who is the owner of the document. |
| messageId required | integer <int64> The message identifier who contains the attachment. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The message details with attachments returned successfully.
[DEPRECATED Use GET /v2.0/persons/{personId}/messages/{messageId}/attachments/{attachmentId} instead. The new endpoint can be accessed by any member who has hierarchy access to sender or one of the recipients.] Retrieves a message attachment by person id, message id and document id. The content of the message attachment retrieved from database is sanitized for better formatting.
| personId required | integer <int32> The person identifier who is the owner of the document. |
| messageId required | integer <int64> The message identifier who contains the attachment. |
| attachmentId required | integer <int32> The attachment identifier - externalId. This id identifies the document stored in DMS system. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The message attachment returned successfully.
[DEPRECATED Use PATCH v1.1/persons/{personId}/messages/{id} instead] Marks a message as read.
| personId required | integer <int32> Person id who sent or received the message. |
| id required | integer <int64> Message id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
No Content
[DEPRECATED Use PATCH v1.1/persons/{personId}/messages/{id} instead] Marks a message as unread.
| personId required | integer <int32> Person id who sent or received the message |
| id required | integer <int64> Message id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
No Content
[DEPRECATED Use POST /v2.0/contacts/{contactId}/messages/send - to send a message from a contact to all
or POST /v2.0/contacts/{contactId}/members/{memberId}/messages/send - to send a message from a contact to a member
or POST /v2.0/members/{memberId}/messages/send - to send a message from a member to multiple recipients (contacts and/or members).]
Create/save message coming from a sender.
The subject and text of the message are sanitized before saving in the database in order to avoid XSS attacks.
| personId required | integer <int32> Person id who sent the message |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The message which will be sent
| ContactMessageSubtypeId required | integer <int32> Used only in v1.1. The subtype identifier of the message. |
| ContactMessageSourceId required | integer <int32> Used only in v1.1. The source identifier of the message. |
| Subject | string The subject of the message. It will be sanitized in order to avoid XSS attacks. |
| Text | string The content/text body of the message. It will be sanitized in order to avoid XSS attacks. |
| Properties | string The properties of the message. |
| RecipientId required | integer <int32> Used only in v1.1. The person identifier who receives the message. The recipient can be either a contact, either a member. |
| Attachments | Array of objects (MessageAttachment) The list of the message attachments (file name and content of the file). |
OK
[DEPRECATED Use POST /v2.0/members/{memberId}/messages/send to send a message from a member to multiple recipients (contacts and/or members) instead.] Create/save message coming from a sender to multiple recipients. The subject and text of the message are sanitized before saving in the database in order to avoid XSS attacks.
| memberId required | integer <int32> The member identifier who sends the message. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The message that will be sent to multiple recipients (contacts or members) in bulk.
| SubtypeId required | integer <int32> The subtype identifier of the message. |
| SourceId required | integer <int32> The source identifier of the message. |
| Subject | string The subject of the message. It will be sanitized in order to avoid XSS attacks. |
| Text | string The content/text body of the message. It will be sanitized in order to avoid XSS attacks. |
| Properties | string The properties of the message. |
| RecipientIds | Array of integers <int32> The person identifiers who receives the message. The recipients can be both contacts and members. The message will be sent to all recipients. |
| Attachments | Array of objects (MessageAttachment) The list of the message attachments (file name and content of the file). |
OK
[DEPRECATED Use POST /v2.0/persons/{personId}/messages/{messageId}/reply instead to reply a new message from the recipient to sender.] Reply to the original message. The subject and text of the reply message are sanitized before saving in the database in order to avoid XSS attacks.
| personId required | integer <int32> Person id who will reply the message |
| id required | integer <int64> Message id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The reply message with attachments
| Subject | string The subject of the message. It will be sanitized in order to avoid the XSS attacks. |
| Text | string The content/text of the message. It will be sanitized in order to avoid the XSS attacks. |
| Attachments | Array of objects (MessageAttachment) The list of the attached files. |
OK
[DEPRECATED Use POST /v2.0/persons/{personId}/messages/{messageId}/reply instead to reply a new message from the recipient to sender. The relationship will be everytime one to one, from recipient to sender, so the replying to multiple recipients won't be available.] Reply the original message to multiple recipients. The subject and text of the reply message are sanitized before saving in the database in order to avoid XSS attacks.
| memberId required | integer <int32> The member identifier reply the message. |
| id required | integer <int64> Message id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The reply message with attachments
| Subject | string The subject of the message. It will be sanitized in order to avoid the XSS attacks. |
| Text | string The content/text of the message. It will be sanitized in order to avoid the XSS attacks. |
| Attachments | Array of objects (MessageAttachment) The list of the message attachments (file name and content of the file). |
| RecipientIds | Array of integers <int32> The person identifiers who receives the message. The recipients can be both contacts and members. The message will be sent to all recipients. |
OK
[DEPRECATED Use POST /v2.0/contacts/{contactId}/messages/send - to send a message from a contact to all
or POST /v2.0/contacts/{contactId}/members/{memberId}/messages/send - to send a message from a contact to a member
or POST /v2.0/members/{memberId}/messages/send - to send a message from a member to multiple recipients (contacts and/or members).]
Forward the original message identified by id to another recipient.
The subject and text of the reply message are sanitized before saving in the database in order to avoid XSS attacks.
| personId required | integer <int32> Person id who will forward the message |
| id required | integer <int64> Message id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The forward message with attachments
| RecipientId required | integer <int32> The person who receives the message. |
| Subject | string The subject of the message. It will be sanitized in order to avoid the XSS attacks. |
| Text | string The content/text of the message. It will be sanitized in order to avoid the XSS attacks. |
| Attachments | Array of objects (MessageAttachment) The list of the attached files. |
OK
[DEPRECATED Use POST /v2.0/contacts/{contactId}/messages/send - to send a message from a contact to all
or POST /v2.0/contacts/{contactId}/members/{memberId}/messages/send - to send a message from a contact to a member
or POST /v2.0/members/{memberId}/messages/send - to send a message from a member to multiple recipients (contacts and/or members).]
Forward the original message identified by id to multiple recipients.
The subject and text of the reply message are sanitized before saving in the database in order to avoid XSS attacks.
| memberId required | integer <int32> The member identifier forwards the message. |
| id required | integer <int64> Message id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The forward message with attachments
| RecipientIds | Array of integers <int32> The person identifiers who receives the message. The recipients can be both contacts and members. The message will be sent to all recipients. |
| Subject | string The subject of the message. It will be sanitized in order to avoid the XSS attacks. |
| Text | string The content/text of the message. It will be sanitized in order to avoid the XSS attacks. |
| Attachments | Array of objects (MessageAttachment) The list of the attached files. |
OK
Retrieves the list of the received messages. The subject and the text of the messages retrieved from database are sanitized for better formatting.
| personId required | integer <int32> Person id who received the messages |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
A list of filters applied to messages like: text for search, CreateDate,IsActive, IsRead,IsDelete
| Sender | string |
| Recipient | string |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| PersonMessageThreadId | integer <int32> |
| PersonMessageSubtypeIds | Array of integers <int32> |
| PersonMessageSourceId | integer <int32> |
| IsActive | boolean |
| IsRead | boolean |
| IsDeleted | boolean |
| Text | string |
| TextLength | integer <int32> |
| SortColumn | string |
| SortOrder | string |
| SenderIds | Array of integers <int32> |
| RecipientIds | Array of integers <int32> |
| AdvancedMessageFilter | object (AdvancedMessageFilter) |
| PageNumber required | integer <int32> |
| PageSize required | integer <int32> |
OK
[DEPRECATED Use POST /v2.0/contacts/{contactId}/messages/inbox or POST /v2.0/members/{memberId}/messages/inbox instead.] Retrieves the list of the received messages. The subject and the text of the messages retrieved from database are sanitized for better formatting.
| personId required | integer <int32> Person id who received the messages |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
A list of filters applied to messages like: text for search, CreateDate,IsActive, IsRead,IsDelete
| Sender | string |
| Recipient | string |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| PersonMessageThreadId | integer <int32> |
| PersonMessageSubtypeIds | Array of integers <int32> |
| PersonMessageSourceId | integer <int32> |
| IsActive | boolean |
| IsRead | boolean |
| IsDeleted | boolean |
| Text | string |
| TextLength | integer <int32> |
| SortColumn | string |
| SortOrder | string |
| SenderIds | Array of integers <int32> |
| RecipientIds | Array of integers <int32> |
| AdvancedMessageFilter | object (AdvancedMessageFilter) |
| PageNumber required | integer <int32> |
| PageSize required | integer <int32> |
OK
Retrieves the list of the sent messages. The subject and the text of the messages retrieved from database are sanitized for better formatting.
| personId required | integer <int32> Person id who sent the messages |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
A list of filters applied to messages like: text for search, CreateDate,IsActive, IsRead,IsDelete
| Sender | string |
| Recipient | string |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| PersonMessageThreadId | integer <int32> |
| PersonMessageSubtypeIds | Array of integers <int32> |
| PersonMessageSourceId | integer <int32> |
| IsActive | boolean |
| IsRead | boolean |
| IsDeleted | boolean |
| Text | string |
| TextLength | integer <int32> |
| SortColumn | string |
| SortOrder | string |
| SenderIds | Array of integers <int32> |
| RecipientIds | Array of integers <int32> |
| AdvancedMessageFilter | object (AdvancedMessageFilter) |
| PageNumber required | integer <int32> |
| PageSize required | integer <int32> |
OK
[DEPRECATED Use POST /v2.0/contacts/{contactId}/messages/sent or POST /v2.0/members/{memberId}/messages/sent instead.] Retrieves the list of the sent messages. The subject and the text of the messages retrieved from database are sanitized for better formatting.
| personId required | integer <int32> Person id who sent the messages |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
A list of filters applied to messages like: text for search, CreateDate,IsActive, IsRead,IsDelete
| Sender | string |
| Recipient | string |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| PersonMessageThreadId | integer <int32> |
| PersonMessageSubtypeIds | Array of integers <int32> |
| PersonMessageSourceId | integer <int32> |
| IsActive | boolean |
| IsRead | boolean |
| IsDeleted | boolean |
| Text | string |
| TextLength | integer <int32> |
| SortColumn | string |
| SortOrder | string |
| SenderIds | Array of integers <int32> |
| RecipientIds | Array of integers <int32> |
| AdvancedMessageFilter | object (AdvancedMessageFilter) |
| PageNumber required | integer <int32> |
| PageSize required | integer <int32> |
OK
[DEPRECATED Use POST /v2.0/contacts/{contactId}/message/threads or POST /v2.0/contacts/{contactId}/messages or POST /v2.0/members/{memberId}/messages or POST /v2.0/members/{memberId}/hierarchy/messages filtered by ThreadId instead.] Retrieves the list of the messages in thread. The subject and the text of the messages retrieved from database are sanitized for better formatting.
| personId required | integer <int32> Person id who received the messages |
| personMessageThreadId required | integer <int32> personMessageThreadId |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
[DEPRECATED Use GET /v2.0/message-types instead.] Retrieves all types of messages that belong to a campaign.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
[DEPRECATED Use GET /v2.0/message-types instead. To obtain all the subtypes of messages all MessageSubtypes must be unified.] Retrieves all subtypes of messages that belong to a campaign.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
[DEPRECATED Use GET /v2.0/message-types instead. To obtain the subtypes of a specific type of message the types of messages must be filtered by Id or Name.] Retrieves all subtypes of messages that belong to a campaign and a type of message.
| contactMessageTypeId required | integer <int32> The ContactMessageType Id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Returns a list of all available questionnaires for the given productOffer and product combination. Some answers might have follow-up steps which should translate into the client having to present an additional group of questions if that specific answer was picked by the contact.
| productId required | integer <int32> The product identifier. |
| language required | string The language of the localized resources. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The list of all available questionnaires returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Returns either the contact's last partial questionnaire or the complete one along with the risk profile details (if any). If there are no partial/complete questionnaires for the contact, a new questionnaire will be returned (based on the contact's type). However, in order for this new questionnaire to be returned, a valid productId must be provided and there should also be just one questionnaire set up for that productId and contactType combination.
| contactId required | integer <int32> The id of the contact |
| isComplete required | boolean The flag indicating that the questionnaire retrieved should be completed or not |
| productId required | integer <int32> The id of the product |
| language required | string The language of the questionnaire |
| empty required | boolean The flag indicating that the questionnaire retrieved should be a new one (if empty = true) or the last one previously saved (if exists) |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The contact's questionnaire returned successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Stores either a complete or an incomplete questionnaire. The questionnaire should be passed in full, regardless of it being complete or not in terms of answered questions. Each of the answered questions should have either a list of Ids (for single/multi-answer questions) or a Value (for free-text questions) as Value. The response will state whether or not the questionnaire was complete in terms of each question having an answer and, if not, include details as to which QuestionIds caused the questionnaire to be deemed as incomplete. The response can also be a validation exception (HTTP 422) but only if the answer type does not match the question type (e.g.: multiple answers for a single answer type question) or if the answerIds provided are not part the question's answers.
| contactId required | integer <int32> The contact identifier for which the questionnaire is passed. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The questionnaire passed in full, regardless of it being complete or not in terms of answered questions.
| Id required | integer <int32> |
| Name | string |
| Description | string |
| ContactTypeId required | integer <int32> |
| ContactTypeName | string |
| ProductId | integer <int32> |
| Groups | Array of objects (QuestionGroup) |
The contact questionnaire status returned successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Returns the risk profile associated with the user's last complete/incomplete questionnaire. If the contact has no questionnaire available, a validation exception will be returned. If a groupKey is specified, only the risk details for that group are returned. If riskAccepted is set to false, the risk will not be automatically assigned to the contact (the client would need to POST to contacts/acceptrisk separately in order to make this association)
| contactId required | integer <int32> The id of the contact |
| productId required | integer <int32> The id of the product |
| completeQuestionnaire required | boolean The flag which specifies whether the questionnaire is completed or not |
| riskAccepted required | boolean The flag which specifies whether the risk will be automatically assigned to the contact or not. |
| language required | string The language of the questionnaire |
| groupKey | string The key of the group for which risk details are returned |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The risk calculated successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Attaches the calculated risk to the contact's profile. In order for this action to be successful, the contact needs to have a risk associated with his questionnaire; otherwise, a validation exception is returned.
| contactId required | integer <int32> The id of the contact |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
No Content
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Stores the contact's chosen risk. A validation exception is thrown if the chosenRiskId is invalid.
| contactId required | integer <int32> The id of the contact |
| chosenRiskId required | integer <int32> The id of the risk category that whill be set to the contact |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
No Content
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Registers a new private or corporate contact.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
Registration payload
| ContactType | string |
| Gender required | boolean |
| FirstName | string |
| LastName | string |
| MobilePhoneNumber | string |
| UserName | string |
string | |
| Password | string |
| LanguageCultureCode | string |
| CompanyName | string |
| AgreeTermsAndPrivacy required | boolean |
| RedirectUrl | string optional - The front office redirect url that will be sent to the contact email which defines the next page after the activation link is clicked and verified. If not specified in the request then it will be taken from the application setting. If both are defined, the request value take precedence. Only provide the url in the request if different clients (e.g. different mobile OS Apps) require different urls. |
Contact details returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Registers a new anonymous private or corporate contact.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
Anonymous user registration payload
| ContactType required | string |
| LanguageCultureCode required | string |
| ContactExternalId required | string |
| ExternalSystem | string |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Checks if the activation key provided is valid and activates the contact associated with it. If both email and key are provided, then the pair must match the application records but also calling it with key only is a valid scenario. Based on the returned PasswordSetStatus info, the next call should be to authenticate the contact (if password is already set) or to the create password page (following with a call to the reset password end with the same key).
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
Activate payload
| ActivationKey | string |
Activate contact returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Gets details of a private user
| contactid required | integer <int32> Contact id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Private user returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Updates a private user
| contactid required | integer <int32> Contact id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Upload private user payload
| Gender | boolean |
| FirstName | string |
| LastName | string |
| Street | string |
| StreetNumber | string |
| PostalCode | string |
| City | string |
| State | string |
| Country | string |
| CountryId | integer <int32> |
| NationalityId required | integer <int32> |
| PreferredLanguageCultureCode | string |
| BirthDate | string <date-time> |
| MobileNumber | string |
| PhoneNumber | string |
string |
Private user returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Gets information regarding possible US citizenship for a given contact
| contactid required | integer <int32> Contact id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Us citizen info returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Saves information regarding US citizenship
| contactid required | integer <int32> Contact id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
US Citizen Info payload
| IsUsCitizen required | boolean |
| IsUsBorn required | boolean |
| HasUsGreenCard required | boolean |
| FulfillsSubstantialPhysiscalPresence required | boolean |
| IsUsLiving required | boolean |
OK
No Content
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Gets the beneficial ownership information of a contact
| contactid required | integer <int32> Contact id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Beneficial ownership returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Saves the beneficial ownership of a contact
| contactid required | integer <int32> Contact id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Beneficial ownership payload
| IsBeneficialOwnership | boolean |
OK
No Content
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Gets the asset delivery form of a contact
| contactid required | integer <int32> Contact id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Asset delivery form returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Saves the asset delivery form of a contact
| contactid required | integer <int32> Contact id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Asset delivery form payload
| AsssetDeliveryFormId | integer <int32> |
OK
No Content
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Gets the financial situation details of a contact
| contactid required | integer <int32> Contact id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Financial situation returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Saves the financial information details of a contact
| contactid required | integer <int32> Contact id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Financial situation payload
| EarlyIncomeId | integer <int32> |
| TotalWealthIncomeId | integer <int32> |
| TransferredAssetsSourceId | integer <int32> |
| FinancialLiabilities | boolean |
OK
No Content
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Gets family and occupation details of a contact
| contactid required | integer <int32> Contact id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Family and occupation returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Saves family and occupation details of a contact
| contactid required | integer <int32> Contact id |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Family and occupation payload
| MaritalStatusId | integer <int32> |
| HasChildren | boolean |
| HasPublicFunction | boolean |
| IsPoliticallyExposed | boolean |
| EmploymentTypeId | integer <int32> |
| Activity | string |
| Profession | string |
| BusinessSectorId | integer <int32> |
| Description | string |
| DateFrom | string <date-time> |
| DateTo | string <date-time> |
OK
No Content
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Gets the profile of a contact
| contactid required | integer <int32> Contact id |
| language required | string Language to have localized resources |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Profile returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Renders Template for a Profile - TEMP / TEST
| contactid required | integer <int32> Contact id |
| language required | string Language to have localized resources |
| Authorization required | string The BasicAuth token |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Renders Template for a Profile - TEMP / TEST
| contactid required | integer <int32> Contact id |
| language required | string The language of the localized resources |
| Authorization required | string The BasicAuth token |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Saves lead generation information for marketing purposes
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
A Base64 encoded info string that contains JSON information
| Content | string A Base64 string that containins information in JSON format |
OK
No Content
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Gets the public profile of a member
| memberId required | integer <int32> Member ID |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Member's Profile returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Gets the member profile by internal user identifier.
| internalUserId required | string <uuid> Internal user identifier |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Member's Profile returned successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Changes the two-factor flag of a campaign contact in order to allow/disallow the second factor in an authentication process.
| contactId required | integer <int32> The contact identifier. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Two factor payload containing the flag which enables/disables authentication via 2FA
| IsTwoFactorEnabled required | boolean |
Changed two-factor flag successfully.
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Gets all the contacts based on member role hierarchy
| memberId required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Jwt required | string The Jwt token |
Successfully found the list of contacts by member role hierarchy
BadRequest
Unauthorized
Couldn't find the list of contacts by specified member (member role hierarchy)
Couldn't process the request. The Member ID is invalid
InternalServerError
Gets all the filtered contacts based on member role hierarchy and filters
| memberId required | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Jwt required | string The Jwt token |
| SortColumn | string |
| SortOrder | string |
| Offset required | integer <int32> |
| Limit required | integer <int32> |
| Search | string |
| FirstName | string |
| LastName | string |
| BranchId | integer <int32> |
| CountryId | integer <int32> |
| LanguageId | integer <int32> |
| NationalityId | integer <int32> |
| TypeId | integer <int32> |
Successfully found the list of contacts by member role hierarchy and filters
BadRequest
Unauthorized
Couldn't find the list of contacts by specified member (member role hierarchy) and filters
Couldn't process the request. The Member ID is invalid
InternalServerError
Triggers the transformation of general entity data into JSON format and populates the corresponding flat tables
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
This API is used only in the context of an authenticated account (it requires a JWT token), when the account activates 2FA. If the enrollment is not required for the set factor, then the 2FA is enabled for that contact and it returns a Success response. If the enrollment is required for the set factor, then starts the enrollment of a user device using the specific two-factor which is set in the database. This is the first step of the enrollment process. If it is successful, then an ActivationQrCodeUrl is returned in the response. The end-user will scan the qr code using the mobile app (e.g. Futurae). If the enrollment is successful, then the 2FA provider will post the final result, the user identification and the activation code using the callback set in the database. The callback will post the request using api enrollment/complete.
| contactId required | integer <int32> The contact identifier for which the device will be enrolled. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
This API is used only in the context of an unauthenticated account, when the account has 2FA enabled, but needs to enroll the device. Starts the enrollment of a user device using the specific two-factor which is set in the database. If the contact does not support two-factor authentication then the process is rejected (ErrorMessage: The two factor must be enabled.). This is the first step of the enrollment process. If it is successful, then an ActivationQrCodeUrl is returned in the response. The end-user will scan the qr code using the mobile app (e.g. Futurae). If the enrollment is successful, then the 2FA provider will post the final result, the user identification and the activation code using the callback set in the database. The callback will post the request using api enrollment/complete.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The enrollment request which contains the user name and password in order to authenticate the contact.
| UserName | string The contact name based on which enrollment will be done. |
| Password | string The password of the contact to enroll. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Checks whether a user has a completed enrollment. The endpoint returns immediately with the current enrollment status, thus you would need to use this endpoint on a poll-based fashion, in order to get informed about a status update. If polling is necessary, we strongly recommend polling no faster than every 1-3 seconds.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The complete enrollment request.
| UserName | string The contact name based on which enrollment will be done. |
| EnrollmentSessionId | string The identifier to associate the status request with a specific enrollment process. It is generated and returned by the endpoint starting the enrollment. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Unenrolls (deactivate) a device of a user. If the specified device is the only enrolled device for the user, then two-factor authentication will automatically be disabled for this user. The user will have to enroll a device again in order to be able to authenticate using secondary authentication.
| contactId required | integer <int32> The contact identifier for which the enrolled device will be unenrolled. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The unenrollment request which contain the flag which indicates whether the two factor flag of the contact will be disabled or not.
| DisableTwoFactor | boolean The flag which indicates whether the two factor flag of the contact will be disabled or not. |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Gets all goal templates of a product.
| language required | string The language of the localized resources. |
| productId | integer <int32> The id of the product. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The list of the goal templates returned successfully
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Creates a goal template.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
New goal template.
| Name | Array of objects (JsonLanguage) The name of the goal template. |
| ImageCssClass | Array of objects (JsonLanguage) The image CssClass of the goal template. |
| Description | Array of objects (JsonLanguage) The description of the goal template. |
| CustomAttributes | string The customAttributes of the goal template. |
| ProductId required | integer <int32> The id of the product of the goal template. |
| IsDefault required | boolean Define if the goaltemplate is default. |
The goal template created successfully
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets a goal template.
| id required | integer <int32> The id of the goal template. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The goal template returned successfully
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Updates a goal template.
| id required | integer <int32> The id of the goal template. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
Existing goal template.
| Name | Array of objects (JsonLanguage) The name of the goal template. |
| ImageCssClass | Array of objects (JsonLanguage) The image CssClass of the goal template. |
| Description | Array of objects (JsonLanguage) The description of the goal template. |
| CustomAttributes | string The customAttributes of the goal template. |
| ProductId required | integer <int32> The id of the product of the goal template. |
| IsDefault required | boolean Define if the goaltemplate is default. |
The goal template updated successfully
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Deletes a goal template.
| id required | integer <int32> The id of the goal template. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
No Content
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets all goals of a given contact.
| contactId required | integer <int32> The id of the contact. |
| language required | string The language of the localized resources. |
| currencyId | integer <int32> The optional currencyId needed for the goals KPI calculation. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The list of goals returned successfully
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Creates a new goal for a given contact.
| contactId required | integer <int32> The id of the contact. |
| language required | string The language of the localized resources. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Properties of the goal to create
| Name | string The name of the goal. |
| TargetAmount | number <double> The amount to be reached by the investment in the goal. |
| DueDate | string <date-time> The date to reach the goal. |
| FirstInvestmentDate | string <date-time> The first invesment date of the goal. |
| Status required | integer <int32> The status of the goal (e.g. 1-InProgress, 2-InExecution, 3-Completed, 4-Closed). |
| GoalType required | integer <int32> The type of the goal (e.g. GeneralInvestment). |
| GoalTemplateId required | integer <int32> The goal template identifier based on which the goal is created. |
| CurrencyId | integer <int32> The id of the currency on which the goal is created. |
| Attributes | string The custom attributes of the new goal |
The goal created successfully
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets a specific goal by id and a contact id.
| contactId required | integer <int32> The id of the contact. |
| goalId required | integer <int32> The id of the goal. |
| language required | string The language of the localized resources. |
| currencyId | integer <int32> The optional currencyId which will be used for the goals KPI calculation. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The goal returned successfully
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Updates a specific goal of a given contact.
| contactId required | integer <int32> The id of the contact. |
| goalId required | integer <int32> The id of the goal. |
| language required | string The language of the localized resources. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Properties of the goal to update.
| Name | string The name of the goal. |
| TargetAmount | number <double> The amount to be reached by the investment in the goal. |
| DueDate | string <date-time> The date to reach the goal. |
| FirstInvestmentDate | string <date-time> The first invesment date of the goal. |
| Status required | integer <int32> The status of the goal (e.g. 1-InProgress, 2-InExecution, 3-Completed, 4-Closed). |
| GoalType required | integer <int32> The type of the goal (e.g. GeneralInvestment). |
| GoalTemplateId required | integer <int32> The goal template identifier based on which the goal is created. |
| CurrencyId | integer <int32> The id of the currency on which the goal is created. |
| Attributes | string The custom attributes of the new goal |
The goal updated successfully
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Deletes a specific goal of a given contact.
| contactId required | integer <int32> The id of the contact. |
| goalId required | integer <int32> The id of the goal. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
No Content
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Uploads a file to the server and imports it into the database using BulkCopy mechanism.
The content of the request must be MIME Multipart. The name of the file must contain the name of the table (e.g. Import_Specification_CbsCashTransactions_20180626T083050.csv). Tables used for importing: CbsCashPositions, CbsCashTransactions, CbsSecurityPositions, CbsSecurityPriceHistory, CbsSecurityTransactions.
| hasHeader | boolean By default is true. If it exists and is set to true, the first row of the file will map the columns of the table, otherwise the configuration from the database will be used. |
| separator | string By default is null. If it exists and is set, it will be used for import otherwise the parameter in the GlobalSettings table will be used. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
File upload details returned successfully.
BadRequest
Unauthorized request.
UnprocessableEntity
InternalServerError
Triggers the import and transformation mechanism that will copy the data from the staging tables to the main internal ones
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Daily required | boolean Specifies the type of Import: can be a daily import or an initial import |
| HasJoinedAccounts | boolean Specifies if the bank has joined accounts: multiple clients share the same account or portfolio |
| IncludeDetails | boolean Only used in the initial import, it specifies if the initial import should also include details like: Geofocus, Anr, Sectors, AssetClass |
| CustodianCountryId | integer <int32> Only used in the initial import, it adds cash securities in the requested country for simulating cash portfolio positions |
OK
BadRequest
Unauthorized
UnprocessableEntity
InternalServerError
Gets security summaries by security IDs Returns only basic security data, no KPIs or historical performance
| securityIds required | Array of integers <int32> |
| language required | string |
| currency | integer <int32> |
| from | string <date-time> |
| to | string <date-time> |
| withAggregatePerformance | boolean |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Gets security summaries by security IDs Returns only basic security data, no KPIs or historical performance
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| SecurityIds | Array of integers <int32> |
| Language | string |
| BaseCurrency | integer <int32> |
| StartDate | string <date-time> |
| EndDate | string <date-time> |
| WithAggregatePerformance | boolean |
OK
Gets a security by ID. Returns all details about a security including KPIs and historical performance.
| securityId required | integer <int32> |
| language required | string |
| currencyId | integer <int32> |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
Searches securities by given criteria. Returns only basic security data, no KPIs or historical performance. If multiple search parameters are passed all of them must match
| productId required | integer <int32> |
| language required | string |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| Page required | integer <int32> |
| PageSize required | integer <int32> |
| SearchTerm | string |
| SecurityTypeIds | Array of integers <int32> |
| SecuritySectorIds | Array of integers <int32> |
| CurrencyIds | Array of integers <int32> |
OK
Calculates the following Key Performance Indicators: ExpectedReturn, CumulativeReturn, Volatility and SharpeRatio
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
An object containing: a set of instruments + allocations, number of years used for calculation and the calculation interval
| InstrumentSet required | object (InstrumentSet) |
| Years | integer <int32> The number of historical years to use for the calculation. If not passed the system default value 'HistoricalPerformanceYears' in group 'Performance' of the Global Settings will be used. |
| Days | integer <int32> The number of historical days to use for the calculation of the Historical Performance. If not passed the 'Years' value will be used. If 'Years' is not passed either the system default value 'HistoricalPerformanceYears' in group 'Performance' of the Global Settings will be used. |
| CalculationInterval | string Enum: "Daily" "Weekly" "Monthly" "Yearly" The time interval to be used for the calculation. Defaults to 'Monthly' if not passed. |
OK
Gets the sum of all account balances from all the accounts that belong to contacts which have the requested relationship manager id
| member required | integer <int32> The id of the relationship manager |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Gets the daily history sum of all account balances of all the clients that have the requested relationship manager id
| MemberId required | string |
| aumRequest.memberId required | integer <int32> |
| aumRequest.startDate | string <date-time> |
| aumRequest.endDate | string <date-time> |
| aumRequest.level | integer <int32> |
| aumRequest.language | string |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Gets the asset class allocation of all portfolio content of all the clients that have the requested relationship manager id
| MemberId required | string |
| aumRequest.memberId required | integer <int32> The Id of the member |
| aumRequest.startDate | string <date-time> The First day of the balance history requested |
| aumRequest.endDate | string <date-time> The Last day of the balance history requested |
| aumRequest.level | integer <int32> The Level of the asset class requested. Level 1 means base asset classes |
| aumRequest.language | string The two letter iso code of the requested language |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Gets the performance of top and bottom securities, portfolios and contacts for an RM. Returns top and bottom performers for securities, portfolios and contacts for an RM.
| memberId required | integer <int32> The member ID of the RM |
| currency required | integer <int32> The currency ID to be used for the calculation |
| nrOfDays required | integer <int32> The number of days in the past to calculate the top performance for |
| language required | string The language in which to return all properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Calculates the performance projection for a given set of instrument allocations. Optionally an initial investment amount and a monthly contribution amount can be passed.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The parameter DTO
| InitialInvestmentAmount | number <double> The optional initial investment amount. |
| MonthlyContributionAmount | number <double> The optional monthly contribution amount. |
| Fee | number <double> The optional fee to use for the calculation. |
| ProjectionYears | integer <int32> The number of projection years (years in the future) to use for the calculation. |
| HistoricalYears | integer <int32> The number of historical years to use for the calculation. |
| CurrencyId required | integer <int32> The currency that should be used for the calculation. |
| InstrumentAllocations required | Array of objects (InstrumentAllocation) The instruments and their allocations the calculation should be done for. |
OK
Calculates and saves performances in every currency found in Securities and ProductOfferCurrency tables for a given interval
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The interval for which the calculation will trigger
| From | string <date-time> |
| To | string <date-time> |
OK
Calculates and save performances for a single security in the security currency and every currency found in the ProductOfferCurrency table for a given interval
| securityId required | integer <int32> The id of the security |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The interval for which the calculation will trigger
| From | string <date-time> |
| To | string <date-time> |
OK
Gets a portfolio by ID. Returns all details about a portfolio including KPIs, positions, historical performance and fees. It will also return all goals that are assigned to the portfolio.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to retrieve |
| language required | string The language in which to return all properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Portfolio details returned successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Modifies an existing portfolio. For portfolios that have not been implemented yet the portfolio positions can be modified based on a set of instrument allocation orders (passed in the AllocationsOrder property), on an existing model portfolio (passed in the ModelPortfolioId property) or based on an existing portfolio proposal (passed in the PortfolioProposalId property). For virtual portfolios the position changes will become effective immediately. If no data is provided in all properties no changes will be made to the portfolio positions. Changing the portfolio properties (Name, ...) is possible with any portfolio type and status
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to modify |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO
| ModelPortfolioId | integer <int32> The ID of a model portfolio that the modified portfolio should be based on (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
| PortfolioProposalId | integer <int32> The ID of a portfolio proposal that the modified portfolio should be based on (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
| AllocationsOrder | object (InstrumentSetOrder) |
| Name | string The optional new name of the portfolio. Will be ignored if not set. |
| InitialInvestmentAmount | number <double> The optional new initial investment amount for the portfolio in portfolio currency. If not specified then the sum of all payin account balances linked to the portfolio will be used as initial investment amount. Can only be set for portfolios that have not been ordered yet. |
| CurrencyId | integer <int32> The optional new currency ID of the portfolio. |
| RebalancingType | string Enum: "NoRebalancing" "Manual" "Automatic" The optional rebalancing type of the modified portfolio. If not passed, the rebalancing type associated with the portfolio product will be used if the request will result in changing the existing product association. |
| IsBreached | boolean The optional parameter which tells if a portfolio is breached. If not passed all portfolios will be returned |
| CustomAttributes | string Custom attributes specific to the tenant |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets the basic data and positions of a portfolio by ID. Should mainly be used to retrieve the positions of a portfolio. If additional data is needed 'contacts/{contactId}/portfolios/{portfolioId}' should be used.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to retrieve |
| language required | string The language in which to return all properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Portfolio overview returned successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets all portfolios for a specific contact. Returns a list of portfolio summaries (excluding positions and historical performance). The list of portfolios is determined by the contact groups the contact is a member of.
| contactId required | integer <int32> The ID of the contact that has access to the portfolios |
| language required | string The language in which to return all properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Creates a portfolio. The portfolio can be created based on a set of instrument allocation orders (passed in the AllocationsOrder property), on an existing model portfolio (passed in the ModelPortfolioId property) or based on an existing portfolio proposal (passed in the PortfolioProposalId property). If no data in all properties is provided an empty portfolio will be created. The newly created portfolio will always have the status "NotImplemented" (PortfolioStatusId = 1)
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| language required | string The language in which to return all properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO
| ModelPortfolioId | integer <int32> The ID of a model portfolio that the new portfolio should be based on (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
| PortfolioProposalId | integer <int32> The ID of a portfolio proposal that the new portfolio should be based on (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
| AllocationsOrder | object (InstrumentSetOrder) |
| Name | string The optional name of the new portfolio |
| ProductId | integer <int32> The ID of the product that the new portfolio belongs to. If not passed a configured default will be used. |
| Accounts | Array of objects (PortfolioAccount) A list of accounts the portfolio will be associated with. |
| PortfolioType | string Enum: "Real" "Virtual" "Slice" The type of the new portfolio. Can be 'Real' = 1 or 'Virtual' = 2. Defaults to 'Real'. |
| RebalancingType | string Enum: "NoRebalancing" "Manual" "Automatic" The rebalancing type of the new portfolio. If not passed, the rebalancing type associated with the portfolio product will be used. |
| InitialInvestmentAmount | number <double> The optional initial investment amount for the new portfolio in portfolio currency. If not specified then the sum of all payin account balances linked to the portfolio will be used as initial investment amount. |
| CurrencyId | integer <int32> The currency ID of the portfolio. If not passed the one associated with the contact or the system default will be used. |
| CustomAttributes | string Custom attributes specific to the tenant |
| ExternalId | string The optional ExternalId of the new portfolio |
OK
Created
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets all portfolios for a specific contact group. Returns a list of portfolio summaries (excluding positions and historical performance).
| contactGroupId required | integer <int32> The ID of the contact group that has access to the portfolios |
| language required | string The language in which to return all properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
[DEPRECATED Please use POST v1.1/contacts/{contactId}/portfolios/{portfolioId}/transactions instead]
Gets the transactions of a portfolio within an optional date range.
All currency values are returned in the base currency of the portfolio.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to retrieve the transactions for |
| page required | integer <int32> The result page number, starting by 1 |
| pageSize required | integer <int32> The number of items in a result page |
| securityId | integer <int32> An optional security ID for returning only transactions for this security |
| from | string <date-time> An optional start date for returning only transactions with this date or newer |
| to | string <date-time> An optional end date for returning only transactions with this date or older |
| securityType | string Enum: "Instruments" "Liquidity" "All" An optional filter to specify for which security types to return transactions for. Can be 'Instruments' = 1, 'Liquidity' = 2 or 'All' = 3. Defaults to 'Instruments'. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets the transactions of a portfolio within an optional date range. All currency values are returned in the base currency of the portfolio.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to retrieve the transactions for |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO
| SecurityType required | string Enum: "Instruments" "Liquidity" "All" An optional filter to specify for which security types to return transactions for. Can be 'Instruments' = 1, 'Liquidity' = 2 or 'All' = 3. Defaults to 'Instruments'. |
| Page required | integer <int32> The result page number, starting by 1 |
| PageSize required | integer <int32> The number of items in a result page |
| From | string <date-time> An optional start date for returning only transactions with this date or newer |
| To | string <date-time> An optional end date for returning only transactions with this date or older |
| SecurityId | integer <int32> An optional security ID for returning only transactions for this security |
| AccountId | integer <int32> An optional account ID for returning only transactions for this account |
| FundingId | integer <int32> An optional funding ID for returning only transactions for this funding |
| TransactionType | string Enum: "Credit" "Debit" An optional transaction type for returning only transactions of this type |
| TransactionStatus | string Enum: "ToBeExecuted" "Executed" "Cancelled" "Failed" An optional transaction status for returning only transactions with this status |
| IsPerformanceRelevant | boolean An optional performance relevance flag for returning only transactions that have this flag set as specified |
OK
Gets all model portfolios for a specific product filtered by criteria. Returns a list of model portfolio summaries (excluding positions). If the optional risk category ID is passed only model portfolios for this risk category will be returned.
| productId required | integer <int32> The ID of the product that the portfolios belong to |
| language required | string The language in which to return all properties |
| riskCategoryId | integer <int32> The optional risk category ID to return only model portfolios of this risk category |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets a model portfolio by ID. Returns all details about a model portfolio including KPIs, positions, historical performance and fees.
| modelPortfolioId required | integer <int32> The ID of the model portfolio to retrieve |
| language required | string The language in which to return all properties |
| currencyId | integer <int32> The ID of the currency to use for KPI and historical performance calculation |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets the investment overview for a specific contact. The investment overview contains a list of portfolio summaries of real portfolios and portfolio proposals as well as data aggregated from all real portfolios including a list of positions, the historical and current performance, current total amounts of securities and cash. It also contains the base currency that all aggregated values have been converted to.
| contactId required | integer <int32> The ID of the contact to get the investment overview for |
| language required | string The language in which to return all properties |
| currencyId | integer <int32> The ID of the currency to use as base currency and for KPI and historical performance calculation |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Adds a specific amount to a portfolio. Doesn't trigger a cash transaction from an external account to the portfolio's cash account. Instead cash is moved from the portfolio's cash account to the custody account by issuing buy orders. The new amount will be distributed amongst the portfolio securities based on their allocation values and a buy order will be created. The change will not become effective immediately, only after the order was executed successfully. The execution time of the order is determined by system configuration.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to top up |
| topUpAmount required | number <double> The amount to add to the portfolio in portfolio currency. Must be > 0. |
| forceOrderGeneration | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Sells a specific amount from a portfolio. Doesn't trigger a cash transaction from the portfolio's cash account to an external account. Instead cash is moved from the portfolio's custody account to the cash account by issuing sell orders. The reduction amount will be distributed amongst the portfolio securities based on their allocation values and a sell order will be created. Depending on the allocation values and actual prices it is possible that not the exact amount will be sold. The change will not become effective immediately, only after the order was executed successfully. The execution time of the order is determined by system configuration.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to sell from |
| amount required | number <double> The amount to sell from the portfolio in portfolio currency. Must be > 0. |
| forceOrderGeneration | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Sells a whole portfolio. Doesn't trigger a cash transaction from the portfolio's cash account to an external account. Instead cash is moved from the portfolio's custody account to the cash account by issuing sell orders. The change will not become effective immediately, only after the order was executed successfully. The execution time of the order is determined by system configuration.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to sell completely |
| forceOrderGeneration | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Orders a portfolio. Orders an existing portfolio that has not been implemented yet. The portfolio positions can be modified based on a set of instrument allocation orders (passed in the AllocationsOrder property), on an existing model portfolio (passed in the ModelPortfolioId property) or based on an existing portfolio proposal (passed in the PortfolioProposalId property). The change will not become effective immediately, only after the order was executed successfully. For virtual portfolios the position changes will become effective immediately.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to order |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO
| CurrencyId | integer <int32> The optional new currency ID of the portfolio. |
| ModelPortfolioId | integer <int32> The ID of a model portfolio that the ordered portfolio should be based on (having the same instruments and allocations). If set, the AllocationsOrder property is ignored. |
| PortfolioProposalId | integer <int32> The ID of a portfolio proposal that the ordered portfolio should be based on (having the same instruments and allocations). If set, the AllocationsOrder property is ignored. |
| AllocationsOrder | object (InstrumentSetOrder) |
| ForceOrderGeneration required | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets a portfolio proposal by ID. Returns all details about the proposal including KPIs, positions and historical performance.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio proposal |
| portfolioProposalId required | integer <int32> The ID of the portfolio proposal to retrieve |
| language required | string The language in which to return all properties |
| currencyId | integer <int32> The ID of the currency to use for KPI and historical performance calculation |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Portfolio proposal details returned successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Deletes a portfolio proposal by ID.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio proposal |
| portfolioProposalId required | integer <int32> The ID of the portfolio proposal to retrieve |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Portfolio proposal deleted successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
Modifies a portfolio proposal. The portfolio proposal can be modified based on a set of instrument allocations (passed in the InstrumentAllocations property) or based on an existing model portfolio (passed in the ModelPortfolioId property). If no data is provided in both properties no changes will be made to the portfolio proposal details, but only to the properties specified (Name, ...)
| contactId required | integer <int32> The ID of the contact that has access to the portfolio proposal |
| portfolioProposalId required | integer <int32> The ID of the portfolio proposal to modify |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO
| ModelPortfolioId | integer <int32> The ID of a model portfolio that the portfolio proposal should be changed to (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
| InstrumentAllocations | Array of objects (InstrumentAllocation) The instruments and their allocations of the portfolio proposal. Is only used if ModelPortfolioId is not set. |
| Name | string The optional name of the portfolio proposal |
| PortfolioProposalStatusId | integer <int32> The ID of proposal status |
| CurrencyId | integer <int32> The ID of proposal currency |
| BenchmarkId | integer <int32> The ID of the security used as a benchmark index |
| PortfolioId | integer <int32> The ID of the portfolio that the portfolio proposal is linked to |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets all portfolio proposals for a specific contact. Returns a list of portfolio proposal summaries (excluding positions and historical performance). The list of portfolio proposals is determined by the contact groups the contact is a member of.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio proposals |
| language required | string The language in which to return all properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Creates a portfolio proposal. The portfolio proposal can be created based on a set of instrument allocations (passed in the InstrumentAllocations property), on an existing portfolio proposal (passed in the PortfolioProposalId property) or based on an existing model portfolio (passed in the ModelPortfolioId property). If no data in all properties is provided a ValidationException will be thrown. The newly created portfolio proposal will always have the status "Created" (PortfolioProposalStatusId = 1). If the optional contactGroupId parameter is passed then the contact must be part of the contact group provided.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio proposal |
| language required | string The language in which to return all properties |
| contactGroupId | integer <int32> The ID of the contact group that has access to the portfolio proposal |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO
| ModelPortfolioId | integer <int32> The ID of a model portfolio that the new portfolio proposal should be based on (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
| PortfolioProposalId | integer <int32> The ID of a portfolio proposal that the new portfolio proposal should be based on (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
| InstrumentAllocations | Array of objects (InstrumentInformation) The instruments and their allocations for the portfolio proposal to create. Is only used if ModelPortfolioId and PortfolioProposalId are not set. |
| Name | string The optional name of the new portfolio proposal |
| ProductId | integer <int32> The ID of the product that the new portfolio proposal belongs to |
| PortfolioId | integer <int32> The ID of the portfolio that the new portfolio proposal is linked to |
OK
Created
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets the accounts related to a portfolio.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to retrieve the transactions for |
| language required | string The language in which to return all properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Creates a portfolio account.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to create the account for |
| language required | string The language in which to return all properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO
| AccountId required | integer <int32> |
| IsDefaultCustodyAccount required | boolean |
| IsPayoutAccount required | boolean |
| IsPayinAccount | boolean |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Deletes a portfolio account.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to delete the account from |
| accountId required | integer <int32> The ID of the account to delete |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
NotFound
InternalServerError
Rebalances an existing implemented portfolio. The portfolio is rebalanced to a target set of new instruments/allocations. The target can be specified as a set of instrument allocations (passed in the InstrumentAllocations property), as an existing model portfolio (passed in the ModelPortfolioId property) or as an existing portfolio proposal (passed in the PortfolioProposalId property). If no target is passed the last implemented change to the portfolio will be used as the target. For virtual portfolios the position changes will become effective immediately, for real portfolios a rebalancing order will be created.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to rebalance |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO
| ModelPortfolioId | integer <int32> The ID of a model portfolio that the portfolio should be rebalanced to (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
| PortfolioProposalId | integer <int32> The ID of a portfolio proposal that the portfolio should be rebalanced to (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
| InstrumentAllocations | Array of objects (InstrumentAllocation) The list of all instruments and their allocations that the portfolio should be rebalanced to. Is only used if ModelPortfolioId and PortfolioProposalId are not set. |
| ForceOrderGeneration required | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets the changes of a portfolio within an optional date range. All currency values are returned in the base currency of the portfolio
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to retrieve the changes for |
| page required | integer <int32> The result page number, starting by 1 |
| pageSize required | integer <int32> The number of items in a result page |
| language required | string The language in which to return all properties |
| from | string <date-time> An optional start date for returning only changes with this date or newer |
| to | string <date-time> An optional end date for returning only changes with this date or older |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets the order book entries of a portfolio within an optional date range.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to retrieve the changes for |
| page required | integer <int32> The result page number, starting by 1 |
| pageSize required | integer <int32> The number of items in a result page |
| language required | string The language in which to return all properties |
| from | string <date-time> An optional start date for returning only order book entries with this date or newer |
| to | string <date-time> An optional end date for returning only order book entries with this date or older |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Cancels an existing order from the order book
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio the order belongs to |
| orderBookId required | integer <int32> The ID of the order book entry to cancel |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Releases orders from the order book. The market orders belonging to a product with enabled block orders are pulled together as block orders, all other order types are published to the service bus.
| language required | string The language to use for all language dependent properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The parameter DTO containing a list of IDs of order book entries to be released
| OrderBookIds required | Array of integers <int32> |
OK
Releases orders from the block order book. All block orders with status "Generated" are published to the service bus.
| language required | string The language to use for all language dependent properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The parameter DTO containing a list of IDs of block order book entries to be released
| BlockOrderBookIds required | Array of integers <int32> |
OK
Releases orders of a portfolio from the order book. The market orders belonging to a product with enabled block orders are pulled together as block orders, all other order types are published to the service bus.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio the orders belong to |
| language required | string The language to use for all language dependent properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO containing an optional list of IDs of order book entries to be released. If not passed then all orders with status 'Generated' belonging to the portfolio are released.
| OrderBookIds | Array of integers <int32> |
OK
The type of order that will be simulated is determined by the combination of properties set in the parameter DTO.
The following combinations and the resulting types are supported. All amounts are given in the currency specified in the CurrencyId parameter.
Initial order
Top up
Sell/Sell all
Rebalancing
| contactId required | integer <int32> The ID of the contact |
| language required | string The language to use for all language dependent properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO.
| CurrencyId required | integer <int32> The base currency ID of the order. |
| SourceAmount | number <double> The source amount of the order. |
| Amount | number <double> The amount of the order. |
| SourceInstrumentAllocations | Array of objects (InstrumentAllocation) The source list of all instruments and their allocations. |
| TargetInstrumentAllocations | Array of objects (InstrumentAllocation) The target list of all instruments and their allocations. |
OK
Modifies specific properties of a portfolio changeset
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio the orders belong to |
| portfolioChangeId required | integer <int32> The ID of the portfolio changeset to be modified |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO.
| Availability | string Enum: "OnHold" "Ready" The new availability of the changeset |
| Status | string Enum: "ToBeProcessed" "Processed" "Canceled" "Failed" The new status of all details belonging to the changeset |
OK
Generates orders in the order book for pending changesets.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio the changesets belong to |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO.
| PortfolioChangeIds | Array of integers <int32> The list of portfolio change IDs to generate orders for |
| ForceOrderGeneration required | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled' |
OK
Returns the performance time series of a portfolio for a given date range and the currency information used for calculation. If no date is passed it returns the whole time series since inception.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio for which the performance will be calculated |
| from | string <date-time> An optional date which represents the start date of the interval for the calculated performance time series |
| to | string <date-time> An optional date which represents the end date of the interval for the calculated performance time series |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Portfolio performance returned successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Returns the performance time series of all portfolios that belongs to a contact for a given date range and the currency information used for calculation.
| contactId required | integer <int32> The ID of the contact |
| currencyId | integer <int32> The ID of the currency to use as base currency for performance calculation |
| from | string <date-time> An optional date which represents the start date of the interval for the calculated performance time series |
| to | string <date-time> An optional date which represents the end date of the interval for the calculated performance time series |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Contact's portfolios performance returned successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Returns the monetary performance time series of a portfolio for a given date range and the currency information used for calculation.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio for which the monetary performance will be retrieved |
| from | string <date-time> An optional date which represents the start date of the interval for the monetary performance time series |
| to | string <date-time> An optional date which represents the end date of the interval for the monetary performance time series |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Portfolio's monetary performance time series returned successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Returns the daily monetary performance time series of all portfolios for a given contact and a given date range and the currency information used for calculation.
| contactId required | integer <int32> The ID of the contact that has access to the portfolios |
| currencyId | integer <int32> The ID of the currency to use as base currency for performance calculation |
| from | string <date-time> An optional date which represents the start date of the interval for the monetary performance time series |
| to | string <date-time> An optional date which represents the end date of the interval for the monetary performance time series |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
Portfolio's monetary performance time series returned successfully.
BadRequest
Unauthorized
NotFound
UnprocessableEntity
InternalServerError
Gets the trading cart of a portfolio.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to get the trading cart for |
| language required | string The language in which to return all properties |
| scope | string Enum: "Buy" "Sell" "All" An optional parameter to specify the scope for which to return the trading cart for. Can be 'Sell', 'Buy' or 'All'. Defaults to 'All' if not specified. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Deletes the trading cart of a portfolio.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to delete the trading cart for |
| scope | string Enum: "Buy" "Sell" "All" An optional parameter to specify the scope for which to delete the trading cart for. Can be 'Sell', 'Buy' or 'All'. Defaults to 'All' if not specified. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Modifies the trading cart of a portfolio.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to modify the trading cart for |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO
| Trades required | Array of objects (InstrumentTrade) The list containing the trades to create/modify |
OK
Orders the trading cart items of a portfolio.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to delete the trading cart for |
| scope | string Enum: "Buy" "Sell" "All" An optional parameter to specify the scope for which to create orders for. Can be 'Sell', 'Buy' or 'All'. Defaults to 'All' if not specified. |
| forceOrderGeneration | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Simulates ordering the trading cart items of a portfolio.
| contactId required | integer <int32> The ID of the contact that has access to the portfolio |
| portfolioId required | integer <int32> The ID of the portfolio to simulate the trading cart order for |
| language required | string The language in which to return all properties |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
The parameter DTO
| Trades | Array of objects (InstrumentTrade) An optional list of trades to simulate. If not passed the current trades in the portfolio trading cart will be used. |
| Scope | string Enum: "Buy" "Sell" "All" An optional parameter to specify the scope for which to simulate the order for. Can be 'Sell', 'Buy' or 'All'. Defaults to 'All' if not specified. |
OK
Gets balance information for each product of a contact. Returns the current balance as well as the balance history and the allocation percentage. All balance information is returned in the base currency (returned in the Currency property) Only balance information from active accounts is returned.
| contactId required | integer <int32> |
| language required | string |
| calculationInterval required | string Enum: "Daily" "Weekly" "Monthly" "Yearly" |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Gets all accounts of a contact. Only active accounts are returned.
| contactId required | integer <int32> |
| language required | string |
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
| X-Token-Jwt required | string The Jwt token |
OK
Retrieves the latest currency exchange rates for the currency pairs specified in the parameters. Automatically tries to convert exchange rates that are not available for the requested currency pairs by using indirect quotes (if available).
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The parameter DTO
| CurrencyExchangeRateRequests required | Array of objects (CurrencyExchangeRateRequest) |
| PriceDate | string <date-time> |
OK
Loads and saves all the available currencies fx rates from a price feed provider given a list of currency pairs. FX Rates history queried for a currency pair varies depending on the currency pair latest valuation date.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
Contains the list of currency pairs to import FX rates history for. If an empty currency pair list is passed then this will trigger the import of fx rates history for all currency pairs from the database which have an IntegrationIdentifier and an IntegrationIdentifierType.
| CurrenciesPairs | Array of objects (CurrencyPair) The list of currencies pairs to import FX rates history for |
OK
No Content
BadRequest
Unauthorized
InternalServerError
Retrieves the latest security prices for the securities and currencies specified in the parameters. Automatically tries to convert prices to the desired currency if they are not available in the requested currency.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
The parameter DTO
| SecurityPriceRequests required | Array of objects (SecurityPriceRequest) |
| PriceDate | string <date-time> |
OK
Loads and saves all the available price history from a price feed provider by security IDs. Price history queried for a security varies depending on the security date range.
| Authorization required | string The BasicAuth token |
| X-Token-Hmac | string The Hmac token |
Contains the list of security IDs to import price history for. If security IDs list is passed as an empty list then this will trigger the import of price history for all securities from database which have a PriceFeedIntegrationIdentifier and a PriceFeedIntegrationIdentifierType.
| SecurityIds | Array of integers <int32> The list of security IDs to import price history for |
OK
No Content
BadRequest
Unauthorized
InternalServerError